Skip to content

Typed dictionaries#

Index > OpenSearchService > Typed dictionaries

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

AWSDomainInformationTypeDef#

# AWSDomainInformationTypeDef usage example

from mypy_boto3_opensearch.type_defs import AWSDomainInformationTypeDef

def get_value() -> AWSDomainInformationTypeDef:
    return {
        "DomainName": ...,
    }
# AWSDomainInformationTypeDef definition

class AWSDomainInformationTypeDef(TypedDict):
    DomainName: str,
    OwnerId: NotRequired[str],
    Region: NotRequired[str],

AcceptInboundConnectionRequestRequestTypeDef#

# AcceptInboundConnectionRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import AcceptInboundConnectionRequestRequestTypeDef

def get_value() -> AcceptInboundConnectionRequestRequestTypeDef:
    return {
        "ConnectionId": ...,
    }
# AcceptInboundConnectionRequestRequestTypeDef definition

class AcceptInboundConnectionRequestRequestTypeDef(TypedDict):
    ConnectionId: str,

OptionStatusTypeDef#

# OptionStatusTypeDef usage example

from mypy_boto3_opensearch.type_defs import OptionStatusTypeDef

def get_value() -> OptionStatusTypeDef:
    return {
        "CreationDate": ...,
        "UpdateDate": ...,
        "State": ...,
    }
# OptionStatusTypeDef definition

class OptionStatusTypeDef(TypedDict):
    CreationDate: datetime,
    UpdateDate: datetime,
    State: OptionStateType,  # (1)
    UpdateVersion: NotRequired[int],
    PendingDeletion: NotRequired[bool],
  1. See OptionStateType

TagTypeDef#

# TagTypeDef usage example

from mypy_boto3_opensearch.type_defs import TagTypeDef

def get_value() -> TagTypeDef:
    return {
        "Key": ...,
        "Value": ...,
    }
# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

AdditionalLimitTypeDef#

# AdditionalLimitTypeDef usage example

from mypy_boto3_opensearch.type_defs import AdditionalLimitTypeDef

def get_value() -> AdditionalLimitTypeDef:
    return {
        "LimitName": ...,
    }
# AdditionalLimitTypeDef definition

class AdditionalLimitTypeDef(TypedDict):
    LimitName: NotRequired[str],
    LimitValues: NotRequired[List[str]],

MasterUserOptionsTypeDef#

# MasterUserOptionsTypeDef usage example

from mypy_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],

AssociatePackageRequestRequestTypeDef#

# AssociatePackageRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import AssociatePackageRequestRequestTypeDef

def get_value() -> AssociatePackageRequestRequestTypeDef:
    return {
        "PackageID": ...,
        "DomainName": ...,
    }
# AssociatePackageRequestRequestTypeDef definition

class AssociatePackageRequestRequestTypeDef(TypedDict):
    PackageID: str,
    DomainName: str,

AuthorizeVpcEndpointAccessRequestRequestTypeDef#

# AuthorizeVpcEndpointAccessRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import AuthorizeVpcEndpointAccessRequestRequestTypeDef

def get_value() -> AuthorizeVpcEndpointAccessRequestRequestTypeDef:
    return {
        "DomainName": ...,
        "Account": ...,
    }
# AuthorizeVpcEndpointAccessRequestRequestTypeDef definition

class AuthorizeVpcEndpointAccessRequestRequestTypeDef(TypedDict):
    DomainName: str,
    Account: str,

AuthorizedPrincipalTypeDef#

# AuthorizedPrincipalTypeDef usage example

from mypy_boto3_opensearch.type_defs import AuthorizedPrincipalTypeDef

def get_value() -> AuthorizedPrincipalTypeDef:
    return {
        "PrincipalType": ...,
    }
# AuthorizedPrincipalTypeDef definition

class AuthorizedPrincipalTypeDef(TypedDict):
    PrincipalType: NotRequired[PrincipalTypeType],  # (1)
    Principal: NotRequired[str],
  1. See PrincipalTypeType

ScheduledAutoTuneDetailsTypeDef#

# ScheduledAutoTuneDetailsTypeDef usage example

from mypy_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)
  1. See ScheduledAutoTuneActionTypeType
  2. See ScheduledAutoTuneSeverityTypeType

DurationTypeDef#

# DurationTypeDef usage example

from mypy_boto3_opensearch.type_defs import DurationTypeDef

def get_value() -> DurationTypeDef:
    return {
        "Value": ...,
    }
# DurationTypeDef definition

class DurationTypeDef(TypedDict):
    Value: NotRequired[int],
    Unit: NotRequired[TimeUnitType],  # (1)
  1. See TimeUnitType

AutoTuneOptionsOutputTypeDef#

# AutoTuneOptionsOutputTypeDef usage example

from mypy_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],
  1. See AutoTuneStateType

AutoTuneStatusTypeDef#

# AutoTuneStatusTypeDef usage example

from mypy_boto3_opensearch.type_defs import AutoTuneStatusTypeDef

def get_value() -> AutoTuneStatusTypeDef:
    return {
        "CreationDate": ...,
        "UpdateDate": ...,
        "State": ...,
    }
# AutoTuneStatusTypeDef definition

class AutoTuneStatusTypeDef(TypedDict):
    CreationDate: datetime,
    UpdateDate: datetime,
    State: AutoTuneStateType,  # (1)
    UpdateVersion: NotRequired[int],
    ErrorMessage: NotRequired[str],
    PendingDeletion: NotRequired[bool],
  1. See AutoTuneStateType

AvailabilityZoneInfoTypeDef#

# AvailabilityZoneInfoTypeDef usage example

from mypy_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],
  1. See ZoneStatusType

CancelServiceSoftwareUpdateRequestRequestTypeDef#

# CancelServiceSoftwareUpdateRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import CancelServiceSoftwareUpdateRequestRequestTypeDef

def get_value() -> CancelServiceSoftwareUpdateRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
# CancelServiceSoftwareUpdateRequestRequestTypeDef definition

class CancelServiceSoftwareUpdateRequestRequestTypeDef(TypedDict):
    DomainName: str,

ServiceSoftwareOptionsTypeDef#

# ServiceSoftwareOptionsTypeDef usage example

from mypy_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],
  1. See DeploymentStatusType

ChangeProgressDetailsTypeDef#

# ChangeProgressDetailsTypeDef usage example

from mypy_boto3_opensearch.type_defs import ChangeProgressDetailsTypeDef

def get_value() -> ChangeProgressDetailsTypeDef:
    return {
        "ChangeId": ...,
    }
# ChangeProgressDetailsTypeDef definition

class ChangeProgressDetailsTypeDef(TypedDict):
    ChangeId: NotRequired[str],
    Message: NotRequired[str],

ChangeProgressStageTypeDef#

# ChangeProgressStageTypeDef usage example

from mypy_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],

ColdStorageOptionsTypeDef#

# ColdStorageOptionsTypeDef usage example

from mypy_boto3_opensearch.type_defs import ColdStorageOptionsTypeDef

def get_value() -> ColdStorageOptionsTypeDef:
    return {
        "Enabled": ...,
    }
# ColdStorageOptionsTypeDef definition

class ColdStorageOptionsTypeDef(TypedDict):
    Enabled: bool,

ZoneAwarenessConfigTypeDef#

# ZoneAwarenessConfigTypeDef usage example

from mypy_boto3_opensearch.type_defs import ZoneAwarenessConfigTypeDef

def get_value() -> ZoneAwarenessConfigTypeDef:
    return {
        "AvailabilityZoneCount": ...,
    }
# ZoneAwarenessConfigTypeDef definition

class ZoneAwarenessConfigTypeDef(TypedDict):
    AvailabilityZoneCount: NotRequired[int],

CognitoOptionsTypeDef#

# CognitoOptionsTypeDef usage example

from mypy_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 usage example

from mypy_boto3_opensearch.type_defs import CompatibleVersionsMapTypeDef

def get_value() -> CompatibleVersionsMapTypeDef:
    return {
        "SourceVersion": ...,
    }
# CompatibleVersionsMapTypeDef definition

class CompatibleVersionsMapTypeDef(TypedDict):
    SourceVersion: NotRequired[str],
    TargetVersions: NotRequired[List[str]],

ConnectionPropertiesTypeDef#

# ConnectionPropertiesTypeDef usage example

from mypy_boto3_opensearch.type_defs import ConnectionPropertiesTypeDef

def get_value() -> ConnectionPropertiesTypeDef:
    return {
        "Endpoint": ...,
    }
# ConnectionPropertiesTypeDef definition

class ConnectionPropertiesTypeDef(TypedDict):
    Endpoint: NotRequired[str],

DomainEndpointOptionsTypeDef#

# DomainEndpointOptionsTypeDef usage example

from mypy_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],
  1. See TLSSecurityPolicyType

EBSOptionsTypeDef#

# EBSOptionsTypeDef usage example

from mypy_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],
  1. See VolumeTypeType

EncryptionAtRestOptionsTypeDef#

# EncryptionAtRestOptionsTypeDef usage example

from mypy_boto3_opensearch.type_defs import EncryptionAtRestOptionsTypeDef

def get_value() -> EncryptionAtRestOptionsTypeDef:
    return {
        "Enabled": ...,
    }
# EncryptionAtRestOptionsTypeDef definition

class EncryptionAtRestOptionsTypeDef(TypedDict):
    Enabled: NotRequired[bool],
    KmsKeyId: NotRequired[str],

LogPublishingOptionTypeDef#

# LogPublishingOptionTypeDef usage example

from mypy_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 usage example

from mypy_boto3_opensearch.type_defs import NodeToNodeEncryptionOptionsTypeDef

def get_value() -> NodeToNodeEncryptionOptionsTypeDef:
    return {
        "Enabled": ...,
    }
# NodeToNodeEncryptionOptionsTypeDef definition

class NodeToNodeEncryptionOptionsTypeDef(TypedDict):
    Enabled: NotRequired[bool],

SnapshotOptionsTypeDef#

# SnapshotOptionsTypeDef usage example

from mypy_boto3_opensearch.type_defs import SnapshotOptionsTypeDef

def get_value() -> SnapshotOptionsTypeDef:
    return {
        "AutomatedSnapshotStartHour": ...,
    }
# SnapshotOptionsTypeDef definition

class SnapshotOptionsTypeDef(TypedDict):
    AutomatedSnapshotStartHour: NotRequired[int],

SoftwareUpdateOptionsTypeDef#

# SoftwareUpdateOptionsTypeDef usage example

from mypy_boto3_opensearch.type_defs import SoftwareUpdateOptionsTypeDef

def get_value() -> SoftwareUpdateOptionsTypeDef:
    return {
        "AutoSoftwareUpdateEnabled": ...,
    }
# SoftwareUpdateOptionsTypeDef definition

class SoftwareUpdateOptionsTypeDef(TypedDict):
    AutoSoftwareUpdateEnabled: NotRequired[bool],

VPCOptionsTypeDef#

# VPCOptionsTypeDef usage example

from mypy_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 usage example

from mypy_boto3_opensearch.type_defs import OutboundConnectionStatusTypeDef

def get_value() -> OutboundConnectionStatusTypeDef:
    return {
        "StatusCode": ...,
    }
# OutboundConnectionStatusTypeDef definition

class OutboundConnectionStatusTypeDef(TypedDict):
    StatusCode: NotRequired[OutboundConnectionStatusCodeType],  # (1)
    Message: NotRequired[str],
  1. See OutboundConnectionStatusCodeType

PackageSourceTypeDef#

# PackageSourceTypeDef usage example

from mypy_boto3_opensearch.type_defs import PackageSourceTypeDef

def get_value() -> PackageSourceTypeDef:
    return {
        "S3BucketName": ...,
    }
# PackageSourceTypeDef definition

class PackageSourceTypeDef(TypedDict):
    S3BucketName: NotRequired[str],
    S3Key: NotRequired[str],

DeleteDomainRequestRequestTypeDef#

# DeleteDomainRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import DeleteDomainRequestRequestTypeDef

def get_value() -> DeleteDomainRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
# DeleteDomainRequestRequestTypeDef definition

class DeleteDomainRequestRequestTypeDef(TypedDict):
    DomainName: str,

DeleteInboundConnectionRequestRequestTypeDef#

# DeleteInboundConnectionRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import DeleteInboundConnectionRequestRequestTypeDef

def get_value() -> DeleteInboundConnectionRequestRequestTypeDef:
    return {
        "ConnectionId": ...,
    }
# DeleteInboundConnectionRequestRequestTypeDef definition

class DeleteInboundConnectionRequestRequestTypeDef(TypedDict):
    ConnectionId: str,

DeleteOutboundConnectionRequestRequestTypeDef#

# DeleteOutboundConnectionRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import DeleteOutboundConnectionRequestRequestTypeDef

def get_value() -> DeleteOutboundConnectionRequestRequestTypeDef:
    return {
        "ConnectionId": ...,
    }
# DeleteOutboundConnectionRequestRequestTypeDef definition

class DeleteOutboundConnectionRequestRequestTypeDef(TypedDict):
    ConnectionId: str,

DeletePackageRequestRequestTypeDef#

# DeletePackageRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import DeletePackageRequestRequestTypeDef

def get_value() -> DeletePackageRequestRequestTypeDef:
    return {
        "PackageID": ...,
    }
# DeletePackageRequestRequestTypeDef definition

class DeletePackageRequestRequestTypeDef(TypedDict):
    PackageID: str,

DeleteVpcEndpointRequestRequestTypeDef#

# DeleteVpcEndpointRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import DeleteVpcEndpointRequestRequestTypeDef

def get_value() -> DeleteVpcEndpointRequestRequestTypeDef:
    return {
        "VpcEndpointId": ...,
    }
# DeleteVpcEndpointRequestRequestTypeDef definition

class DeleteVpcEndpointRequestRequestTypeDef(TypedDict):
    VpcEndpointId: str,

VpcEndpointSummaryTypeDef#

# VpcEndpointSummaryTypeDef usage example

from mypy_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)
  1. See VpcEndpointStatusType

DescribeDomainAutoTunesRequestRequestTypeDef#

# DescribeDomainAutoTunesRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import DescribeDomainAutoTunesRequestRequestTypeDef

def get_value() -> DescribeDomainAutoTunesRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
# DescribeDomainAutoTunesRequestRequestTypeDef definition

class DescribeDomainAutoTunesRequestRequestTypeDef(TypedDict):
    DomainName: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

DescribeDomainChangeProgressRequestRequestTypeDef#

# DescribeDomainChangeProgressRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import DescribeDomainChangeProgressRequestRequestTypeDef

def get_value() -> DescribeDomainChangeProgressRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
# DescribeDomainChangeProgressRequestRequestTypeDef definition

class DescribeDomainChangeProgressRequestRequestTypeDef(TypedDict):
    DomainName: str,
    ChangeId: NotRequired[str],

DescribeDomainConfigRequestRequestTypeDef#

# DescribeDomainConfigRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import DescribeDomainConfigRequestRequestTypeDef

def get_value() -> DescribeDomainConfigRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
# DescribeDomainConfigRequestRequestTypeDef definition

class DescribeDomainConfigRequestRequestTypeDef(TypedDict):
    DomainName: str,

DescribeDomainHealthRequestRequestTypeDef#

# DescribeDomainHealthRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import DescribeDomainHealthRequestRequestTypeDef

def get_value() -> DescribeDomainHealthRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
# DescribeDomainHealthRequestRequestTypeDef definition

class DescribeDomainHealthRequestRequestTypeDef(TypedDict):
    DomainName: str,

DescribeDomainNodesRequestRequestTypeDef#

# DescribeDomainNodesRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import DescribeDomainNodesRequestRequestTypeDef

def get_value() -> DescribeDomainNodesRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
# DescribeDomainNodesRequestRequestTypeDef definition

class DescribeDomainNodesRequestRequestTypeDef(TypedDict):
    DomainName: str,

DomainNodesStatusTypeDef#

# DomainNodesStatusTypeDef usage example

from mypy_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],
  1. See NodeTypeType
  2. See OpenSearchPartitionInstanceTypeType
  3. See NodeStatusType
  4. See VolumeTypeType

DescribeDomainRequestRequestTypeDef#

# DescribeDomainRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import DescribeDomainRequestRequestTypeDef

def get_value() -> DescribeDomainRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
# DescribeDomainRequestRequestTypeDef definition

class DescribeDomainRequestRequestTypeDef(TypedDict):
    DomainName: str,

DescribeDomainsRequestRequestTypeDef#

# DescribeDomainsRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import DescribeDomainsRequestRequestTypeDef

def get_value() -> DescribeDomainsRequestRequestTypeDef:
    return {
        "DomainNames": ...,
    }
# DescribeDomainsRequestRequestTypeDef definition

class DescribeDomainsRequestRequestTypeDef(TypedDict):
    DomainNames: Sequence[str],

DescribeDryRunProgressRequestRequestTypeDef#

# DescribeDryRunProgressRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import DescribeDryRunProgressRequestRequestTypeDef

def get_value() -> DescribeDryRunProgressRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
# DescribeDryRunProgressRequestRequestTypeDef definition

class DescribeDryRunProgressRequestRequestTypeDef(TypedDict):
    DomainName: str,
    DryRunId: NotRequired[str],
    LoadDryRunConfig: NotRequired[bool],

DryRunResultsTypeDef#

# DryRunResultsTypeDef usage example

from mypy_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 usage example

from mypy_boto3_opensearch.type_defs import FilterTypeDef

def get_value() -> FilterTypeDef:
    return {
        "Name": ...,
    }
# FilterTypeDef definition

class FilterTypeDef(TypedDict):
    Name: NotRequired[str],
    Values: NotRequired[Sequence[str]],

DescribeInstanceTypeLimitsRequestRequestTypeDef#

# DescribeInstanceTypeLimitsRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import DescribeInstanceTypeLimitsRequestRequestTypeDef

def get_value() -> DescribeInstanceTypeLimitsRequestRequestTypeDef:
    return {
        "InstanceType": ...,
        "EngineVersion": ...,
    }
# DescribeInstanceTypeLimitsRequestRequestTypeDef definition

class DescribeInstanceTypeLimitsRequestRequestTypeDef(TypedDict):
    InstanceType: OpenSearchPartitionInstanceTypeType,  # (1)
    EngineVersion: str,
    DomainName: NotRequired[str],
  1. See OpenSearchPartitionInstanceTypeType

DescribePackagesFilterTypeDef#

# DescribePackagesFilterTypeDef usage example

from mypy_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]],
  1. See DescribePackagesFilterNameType

DescribeReservedInstanceOfferingsRequestRequestTypeDef#

# DescribeReservedInstanceOfferingsRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import DescribeReservedInstanceOfferingsRequestRequestTypeDef

def get_value() -> DescribeReservedInstanceOfferingsRequestRequestTypeDef:
    return {
        "ReservedInstanceOfferingId": ...,
    }
# DescribeReservedInstanceOfferingsRequestRequestTypeDef definition

class DescribeReservedInstanceOfferingsRequestRequestTypeDef(TypedDict):
    ReservedInstanceOfferingId: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

DescribeReservedInstancesRequestRequestTypeDef#

# DescribeReservedInstancesRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import DescribeReservedInstancesRequestRequestTypeDef

def get_value() -> DescribeReservedInstancesRequestRequestTypeDef:
    return {
        "ReservedInstanceId": ...,
    }
# DescribeReservedInstancesRequestRequestTypeDef definition

class DescribeReservedInstancesRequestRequestTypeDef(TypedDict):
    ReservedInstanceId: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

DescribeVpcEndpointsRequestRequestTypeDef#

# DescribeVpcEndpointsRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import DescribeVpcEndpointsRequestRequestTypeDef

def get_value() -> DescribeVpcEndpointsRequestRequestTypeDef:
    return {
        "VpcEndpointIds": ...,
    }
# DescribeVpcEndpointsRequestRequestTypeDef definition

class DescribeVpcEndpointsRequestRequestTypeDef(TypedDict):
    VpcEndpointIds: Sequence[str],

VpcEndpointErrorTypeDef#

# VpcEndpointErrorTypeDef usage example

from mypy_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],
  1. See VpcEndpointErrorCodeType

DissociatePackageRequestRequestTypeDef#

# DissociatePackageRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import DissociatePackageRequestRequestTypeDef

def get_value() -> DissociatePackageRequestRequestTypeDef:
    return {
        "PackageID": ...,
        "DomainName": ...,
    }
# DissociatePackageRequestRequestTypeDef definition

class DissociatePackageRequestRequestTypeDef(TypedDict):
    PackageID: str,
    DomainName: str,

DomainInfoTypeDef#

# DomainInfoTypeDef usage example

from mypy_boto3_opensearch.type_defs import DomainInfoTypeDef

def get_value() -> DomainInfoTypeDef:
    return {
        "DomainName": ...,
    }
# DomainInfoTypeDef definition

class DomainInfoTypeDef(TypedDict):
    DomainName: NotRequired[str],
    EngineType: NotRequired[EngineTypeType],  # (1)
  1. See EngineTypeType

ErrorDetailsTypeDef#

# ErrorDetailsTypeDef usage example

from mypy_boto3_opensearch.type_defs import ErrorDetailsTypeDef

def get_value() -> ErrorDetailsTypeDef:
    return {
        "ErrorType": ...,
    }
# ErrorDetailsTypeDef definition

class ErrorDetailsTypeDef(TypedDict):
    ErrorType: NotRequired[str],
    ErrorMessage: NotRequired[str],

VPCDerivedInfoTypeDef#

# VPCDerivedInfoTypeDef usage example

from mypy_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 usage example

from mypy_boto3_opensearch.type_defs import ValidationFailureTypeDef

def get_value() -> ValidationFailureTypeDef:
    return {
        "Code": ...,
    }
# ValidationFailureTypeDef definition

class ValidationFailureTypeDef(TypedDict):
    Code: NotRequired[str],
    Message: NotRequired[str],

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef usage example

from mypy_boto3_opensearch.type_defs import EmptyResponseMetadataTypeDef

def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }
# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetCompatibleVersionsRequestRequestTypeDef#

# GetCompatibleVersionsRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import GetCompatibleVersionsRequestRequestTypeDef

def get_value() -> GetCompatibleVersionsRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
# GetCompatibleVersionsRequestRequestTypeDef definition

class GetCompatibleVersionsRequestRequestTypeDef(TypedDict):
    DomainName: NotRequired[str],

GetPackageVersionHistoryRequestRequestTypeDef#

# GetPackageVersionHistoryRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import GetPackageVersionHistoryRequestRequestTypeDef

def get_value() -> GetPackageVersionHistoryRequestRequestTypeDef:
    return {
        "PackageID": ...,
    }
# GetPackageVersionHistoryRequestRequestTypeDef definition

class GetPackageVersionHistoryRequestRequestTypeDef(TypedDict):
    PackageID: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

PackageVersionHistoryTypeDef#

# PackageVersionHistoryTypeDef usage example

from mypy_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],

GetUpgradeHistoryRequestRequestTypeDef#

# GetUpgradeHistoryRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import GetUpgradeHistoryRequestRequestTypeDef

def get_value() -> GetUpgradeHistoryRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
# GetUpgradeHistoryRequestRequestTypeDef definition

class GetUpgradeHistoryRequestRequestTypeDef(TypedDict):
    DomainName: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

GetUpgradeStatusRequestRequestTypeDef#

# GetUpgradeStatusRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import GetUpgradeStatusRequestRequestTypeDef

def get_value() -> GetUpgradeStatusRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
# GetUpgradeStatusRequestRequestTypeDef definition

class GetUpgradeStatusRequestRequestTypeDef(TypedDict):
    DomainName: str,

GetUpgradeStatusResponseTypeDef#

# GetUpgradeStatusResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import GetUpgradeStatusResponseTypeDef

def get_value() -> GetUpgradeStatusResponseTypeDef:
    return {
        "UpgradeStep": ...,
        "StepStatus": ...,
        "UpgradeName": ...,
        "ResponseMetadata": ...,
    }
# GetUpgradeStatusResponseTypeDef definition

class GetUpgradeStatusResponseTypeDef(TypedDict):
    UpgradeStep: UpgradeStepType,  # (1)
    StepStatus: UpgradeStatusType,  # (2)
    UpgradeName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See UpgradeStepType
  2. See UpgradeStatusType
  3. See ResponseMetadataTypeDef

InboundConnectionStatusTypeDef#

# InboundConnectionStatusTypeDef usage example

from mypy_boto3_opensearch.type_defs import InboundConnectionStatusTypeDef

def get_value() -> InboundConnectionStatusTypeDef:
    return {
        "StatusCode": ...,
    }
# InboundConnectionStatusTypeDef definition

class InboundConnectionStatusTypeDef(TypedDict):
    StatusCode: NotRequired[InboundConnectionStatusCodeType],  # (1)
    Message: NotRequired[str],
  1. See InboundConnectionStatusCodeType

InstanceCountLimitsTypeDef#

# InstanceCountLimitsTypeDef usage example

from mypy_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 usage example

from mypy_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]],
  1. See OpenSearchPartitionInstanceTypeType

ListDomainNamesRequestRequestTypeDef#

# ListDomainNamesRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import ListDomainNamesRequestRequestTypeDef

def get_value() -> ListDomainNamesRequestRequestTypeDef:
    return {
        "EngineType": ...,
    }
# ListDomainNamesRequestRequestTypeDef definition

class ListDomainNamesRequestRequestTypeDef(TypedDict):
    EngineType: NotRequired[EngineTypeType],  # (1)
  1. See EngineTypeType

ListDomainsForPackageRequestRequestTypeDef#

# ListDomainsForPackageRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import ListDomainsForPackageRequestRequestTypeDef

def get_value() -> ListDomainsForPackageRequestRequestTypeDef:
    return {
        "PackageID": ...,
    }
# ListDomainsForPackageRequestRequestTypeDef definition

class ListDomainsForPackageRequestRequestTypeDef(TypedDict):
    PackageID: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListInstanceTypeDetailsRequestRequestTypeDef#

# ListInstanceTypeDetailsRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import ListInstanceTypeDetailsRequestRequestTypeDef

def get_value() -> ListInstanceTypeDetailsRequestRequestTypeDef:
    return {
        "EngineVersion": ...,
    }
# ListInstanceTypeDetailsRequestRequestTypeDef definition

class ListInstanceTypeDetailsRequestRequestTypeDef(TypedDict):
    EngineVersion: str,
    DomainName: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    RetrieveAZs: NotRequired[bool],
    InstanceType: NotRequired[str],

ListPackagesForDomainRequestRequestTypeDef#

# ListPackagesForDomainRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import ListPackagesForDomainRequestRequestTypeDef

def get_value() -> ListPackagesForDomainRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
# ListPackagesForDomainRequestRequestTypeDef definition

class ListPackagesForDomainRequestRequestTypeDef(TypedDict):
    DomainName: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListScheduledActionsRequestRequestTypeDef#

# ListScheduledActionsRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import ListScheduledActionsRequestRequestTypeDef

def get_value() -> ListScheduledActionsRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
# ListScheduledActionsRequestRequestTypeDef definition

class ListScheduledActionsRequestRequestTypeDef(TypedDict):
    DomainName: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ScheduledActionTypeDef#

# ScheduledActionTypeDef usage example

from mypy_boto3_opensearch.type_defs import ScheduledActionTypeDef

def get_value() -> ScheduledActionTypeDef:
    return {
        "Id": ...,
        "Type": ...,
        "Severity": ...,
        "ScheduledTime": ...,
    }
# 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],
  1. See ActionTypeType
  2. See ActionSeverityType
  3. See ScheduledByType
  4. See ActionStatusType

ListTagsRequestRequestTypeDef#

# ListTagsRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import ListTagsRequestRequestTypeDef

def get_value() -> ListTagsRequestRequestTypeDef:
    return {
        "ARN": ...,
    }
# ListTagsRequestRequestTypeDef definition

class ListTagsRequestRequestTypeDef(TypedDict):
    ARN: str,

ListVersionsRequestRequestTypeDef#

# ListVersionsRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import ListVersionsRequestRequestTypeDef

def get_value() -> ListVersionsRequestRequestTypeDef:
    return {
        "MaxResults": ...,
    }
# ListVersionsRequestRequestTypeDef definition

class ListVersionsRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListVersionsResponseTypeDef#

# ListVersionsResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import ListVersionsResponseTypeDef

def get_value() -> ListVersionsResponseTypeDef:
    return {
        "Versions": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListVersionsResponseTypeDef definition

class ListVersionsResponseTypeDef(TypedDict):
    Versions: List[str],
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListVpcEndpointAccessRequestRequestTypeDef#

# ListVpcEndpointAccessRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import ListVpcEndpointAccessRequestRequestTypeDef

def get_value() -> ListVpcEndpointAccessRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
# ListVpcEndpointAccessRequestRequestTypeDef definition

class ListVpcEndpointAccessRequestRequestTypeDef(TypedDict):
    DomainName: str,
    NextToken: NotRequired[str],

ListVpcEndpointsForDomainRequestRequestTypeDef#

# ListVpcEndpointsForDomainRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import ListVpcEndpointsForDomainRequestRequestTypeDef

def get_value() -> ListVpcEndpointsForDomainRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
# ListVpcEndpointsForDomainRequestRequestTypeDef definition

class ListVpcEndpointsForDomainRequestRequestTypeDef(TypedDict):
    DomainName: str,
    NextToken: NotRequired[str],

ListVpcEndpointsRequestRequestTypeDef#

# ListVpcEndpointsRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import ListVpcEndpointsRequestRequestTypeDef

def get_value() -> ListVpcEndpointsRequestRequestTypeDef:
    return {
        "NextToken": ...,
    }
# ListVpcEndpointsRequestRequestTypeDef definition

class ListVpcEndpointsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],

WindowStartTimeTypeDef#

# WindowStartTimeTypeDef usage example

from mypy_boto3_opensearch.type_defs import WindowStartTimeTypeDef

def get_value() -> WindowStartTimeTypeDef:
    return {
        "Hours": ...,
        "Minutes": ...,
    }
# WindowStartTimeTypeDef definition

class WindowStartTimeTypeDef(TypedDict):
    Hours: int,
    Minutes: int,

PurchaseReservedInstanceOfferingRequestRequestTypeDef#

# PurchaseReservedInstanceOfferingRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import PurchaseReservedInstanceOfferingRequestRequestTypeDef

def get_value() -> PurchaseReservedInstanceOfferingRequestRequestTypeDef:
    return {
        "ReservedInstanceOfferingId": ...,
        "ReservationName": ...,
    }
# PurchaseReservedInstanceOfferingRequestRequestTypeDef definition

class PurchaseReservedInstanceOfferingRequestRequestTypeDef(TypedDict):
    ReservedInstanceOfferingId: str,
    ReservationName: str,
    InstanceCount: NotRequired[int],

PurchaseReservedInstanceOfferingResponseTypeDef#

# PurchaseReservedInstanceOfferingResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import PurchaseReservedInstanceOfferingResponseTypeDef

def get_value() -> PurchaseReservedInstanceOfferingResponseTypeDef:
    return {
        "ReservedInstanceId": ...,
        "ReservationName": ...,
        "ResponseMetadata": ...,
    }
# PurchaseReservedInstanceOfferingResponseTypeDef definition

class PurchaseReservedInstanceOfferingResponseTypeDef(TypedDict):
    ReservedInstanceId: str,
    ReservationName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

RecurringChargeTypeDef#

# RecurringChargeTypeDef usage example

from mypy_boto3_opensearch.type_defs import RecurringChargeTypeDef

def get_value() -> RecurringChargeTypeDef:
    return {
        "RecurringChargeAmount": ...,
    }
# RecurringChargeTypeDef definition

class RecurringChargeTypeDef(TypedDict):
    RecurringChargeAmount: NotRequired[float],
    RecurringChargeFrequency: NotRequired[str],

RejectInboundConnectionRequestRequestTypeDef#

# RejectInboundConnectionRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import RejectInboundConnectionRequestRequestTypeDef

def get_value() -> RejectInboundConnectionRequestRequestTypeDef:
    return {
        "ConnectionId": ...,
    }
# RejectInboundConnectionRequestRequestTypeDef definition

class RejectInboundConnectionRequestRequestTypeDef(TypedDict):
    ConnectionId: str,

RemoveTagsRequestRequestTypeDef#

# RemoveTagsRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import RemoveTagsRequestRequestTypeDef

def get_value() -> RemoveTagsRequestRequestTypeDef:
    return {
        "ARN": ...,
        "TagKeys": ...,
    }
# RemoveTagsRequestRequestTypeDef definition

class RemoveTagsRequestRequestTypeDef(TypedDict):
    ARN: str,
    TagKeys: Sequence[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef usage example

from mypy_boto3_opensearch.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

RevokeVpcEndpointAccessRequestRequestTypeDef#

# RevokeVpcEndpointAccessRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import RevokeVpcEndpointAccessRequestRequestTypeDef

def get_value() -> RevokeVpcEndpointAccessRequestRequestTypeDef:
    return {
        "DomainName": ...,
        "Account": ...,
    }
# RevokeVpcEndpointAccessRequestRequestTypeDef definition

class RevokeVpcEndpointAccessRequestRequestTypeDef(TypedDict):
    DomainName: str,
    Account: str,

SAMLIdpTypeDef#

# SAMLIdpTypeDef usage example

from mypy_boto3_opensearch.type_defs import SAMLIdpTypeDef

def get_value() -> SAMLIdpTypeDef:
    return {
        "MetadataContent": ...,
        "EntityId": ...,
    }
# SAMLIdpTypeDef definition

class SAMLIdpTypeDef(TypedDict):
    MetadataContent: str,
    EntityId: str,

StartServiceSoftwareUpdateRequestRequestTypeDef#

# StartServiceSoftwareUpdateRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import StartServiceSoftwareUpdateRequestRequestTypeDef

def get_value() -> StartServiceSoftwareUpdateRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
# StartServiceSoftwareUpdateRequestRequestTypeDef definition

class StartServiceSoftwareUpdateRequestRequestTypeDef(TypedDict):
    DomainName: str,
    ScheduleAt: NotRequired[ScheduleAtType],  # (1)
    DesiredStartTime: NotRequired[int],
  1. See ScheduleAtType

StorageTypeLimitTypeDef#

# StorageTypeLimitTypeDef usage example

from mypy_boto3_opensearch.type_defs import StorageTypeLimitTypeDef

def get_value() -> StorageTypeLimitTypeDef:
    return {
        "LimitName": ...,
    }
# StorageTypeLimitTypeDef definition

class StorageTypeLimitTypeDef(TypedDict):
    LimitName: NotRequired[str],
    LimitValues: NotRequired[List[str]],

UpdateScheduledActionRequestRequestTypeDef#

# UpdateScheduledActionRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import UpdateScheduledActionRequestRequestTypeDef

def get_value() -> UpdateScheduledActionRequestRequestTypeDef:
    return {
        "DomainName": ...,
        "ActionID": ...,
        "ActionType": ...,
        "ScheduleAt": ...,
    }
# UpdateScheduledActionRequestRequestTypeDef definition

class UpdateScheduledActionRequestRequestTypeDef(TypedDict):
    DomainName: str,
    ActionID: str,
    ActionType: ActionTypeType,  # (1)
    ScheduleAt: ScheduleAtType,  # (2)
    DesiredStartTime: NotRequired[int],
  1. See ActionTypeType
  2. See ScheduleAtType

UpgradeDomainRequestRequestTypeDef#

# UpgradeDomainRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import UpgradeDomainRequestRequestTypeDef

def get_value() -> UpgradeDomainRequestRequestTypeDef:
    return {
        "DomainName": ...,
        "TargetVersion": ...,
    }
# UpgradeDomainRequestRequestTypeDef definition

class UpgradeDomainRequestRequestTypeDef(TypedDict):
    DomainName: str,
    TargetVersion: str,
    PerformCheckOnly: NotRequired[bool],
    AdvancedOptions: NotRequired[Mapping[str, str]],

UpgradeStepItemTypeDef#

# UpgradeStepItemTypeDef usage example

from mypy_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],
  1. See UpgradeStepType
  2. See UpgradeStatusType

DomainInformationContainerTypeDef#

# DomainInformationContainerTypeDef usage example

from mypy_boto3_opensearch.type_defs import DomainInformationContainerTypeDef

def get_value() -> DomainInformationContainerTypeDef:
    return {
        "AWSDomainInformation": ...,
    }
# DomainInformationContainerTypeDef definition

class DomainInformationContainerTypeDef(TypedDict):
    AWSDomainInformation: NotRequired[AWSDomainInformationTypeDef],  # (1)
  1. See AWSDomainInformationTypeDef

AccessPoliciesStatusTypeDef#

# AccessPoliciesStatusTypeDef usage example

from mypy_boto3_opensearch.type_defs import AccessPoliciesStatusTypeDef

def get_value() -> AccessPoliciesStatusTypeDef:
    return {
        "Options": ...,
        "Status": ...,
    }
# AccessPoliciesStatusTypeDef definition

class AccessPoliciesStatusTypeDef(TypedDict):
    Options: str,
    Status: OptionStatusTypeDef,  # (1)
  1. See OptionStatusTypeDef

AdvancedOptionsStatusTypeDef#

# AdvancedOptionsStatusTypeDef usage example

from mypy_boto3_opensearch.type_defs import AdvancedOptionsStatusTypeDef

def get_value() -> AdvancedOptionsStatusTypeDef:
    return {
        "Options": ...,
        "Status": ...,
    }
# AdvancedOptionsStatusTypeDef definition

class AdvancedOptionsStatusTypeDef(TypedDict):
    Options: Dict[str, str],
    Status: OptionStatusTypeDef,  # (1)
  1. See OptionStatusTypeDef

VersionStatusTypeDef#

# VersionStatusTypeDef usage example

from mypy_boto3_opensearch.type_defs import VersionStatusTypeDef

def get_value() -> VersionStatusTypeDef:
    return {
        "Options": ...,
        "Status": ...,
    }
# VersionStatusTypeDef definition

class VersionStatusTypeDef(TypedDict):
    Options: str,
    Status: OptionStatusTypeDef,  # (1)
  1. See OptionStatusTypeDef

AddTagsRequestRequestTypeDef#

# AddTagsRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import AddTagsRequestRequestTypeDef

def get_value() -> AddTagsRequestRequestTypeDef:
    return {
        "ARN": ...,
        "TagList": ...,
    }
# AddTagsRequestRequestTypeDef definition

class AddTagsRequestRequestTypeDef(TypedDict):
    ARN: str,
    TagList: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

ListTagsResponseTypeDef#

# ListTagsResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import ListTagsResponseTypeDef

def get_value() -> ListTagsResponseTypeDef:
    return {
        "TagList": ...,
        "ResponseMetadata": ...,
    }
# ListTagsResponseTypeDef definition

class ListTagsResponseTypeDef(TypedDict):
    TagList: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

AuthorizeVpcEndpointAccessResponseTypeDef#

# AuthorizeVpcEndpointAccessResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import AuthorizeVpcEndpointAccessResponseTypeDef

def get_value() -> AuthorizeVpcEndpointAccessResponseTypeDef:
    return {
        "AuthorizedPrincipal": ...,
        "ResponseMetadata": ...,
    }
# AuthorizeVpcEndpointAccessResponseTypeDef definition

class AuthorizeVpcEndpointAccessResponseTypeDef(TypedDict):
    AuthorizedPrincipal: AuthorizedPrincipalTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AuthorizedPrincipalTypeDef
  2. See ResponseMetadataTypeDef

ListVpcEndpointAccessResponseTypeDef#

# ListVpcEndpointAccessResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import ListVpcEndpointAccessResponseTypeDef

def get_value() -> ListVpcEndpointAccessResponseTypeDef:
    return {
        "AuthorizedPrincipalList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListVpcEndpointAccessResponseTypeDef definition

class ListVpcEndpointAccessResponseTypeDef(TypedDict):
    AuthorizedPrincipalList: List[AuthorizedPrincipalTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AuthorizedPrincipalTypeDef
  2. See ResponseMetadataTypeDef

AutoTuneDetailsTypeDef#

# AutoTuneDetailsTypeDef usage example

from mypy_boto3_opensearch.type_defs import AutoTuneDetailsTypeDef

def get_value() -> AutoTuneDetailsTypeDef:
    return {
        "ScheduledAutoTuneDetails": ...,
    }
# AutoTuneDetailsTypeDef definition

class AutoTuneDetailsTypeDef(TypedDict):
    ScheduledAutoTuneDetails: NotRequired[ScheduledAutoTuneDetailsTypeDef],  # (1)
  1. See ScheduledAutoTuneDetailsTypeDef

AutoTuneMaintenanceScheduleTypeDef#

# AutoTuneMaintenanceScheduleTypeDef usage example

from mypy_boto3_opensearch.type_defs import AutoTuneMaintenanceScheduleTypeDef

def get_value() -> AutoTuneMaintenanceScheduleTypeDef:
    return {
        "StartAt": ...,
    }
# AutoTuneMaintenanceScheduleTypeDef definition

class AutoTuneMaintenanceScheduleTypeDef(TypedDict):
    StartAt: NotRequired[Union[datetime, str]],
    Duration: NotRequired[DurationTypeDef],  # (1)
    CronExpressionForRecurrence: NotRequired[str],
  1. See DurationTypeDef

EnvironmentInfoTypeDef#

# EnvironmentInfoTypeDef usage example

from mypy_boto3_opensearch.type_defs import EnvironmentInfoTypeDef

def get_value() -> EnvironmentInfoTypeDef:
    return {
        "AvailabilityZoneInformation": ...,
    }
# EnvironmentInfoTypeDef definition

class EnvironmentInfoTypeDef(TypedDict):
    AvailabilityZoneInformation: NotRequired[List[AvailabilityZoneInfoTypeDef]],  # (1)
  1. See AvailabilityZoneInfoTypeDef

CancelServiceSoftwareUpdateResponseTypeDef#

# CancelServiceSoftwareUpdateResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import CancelServiceSoftwareUpdateResponseTypeDef

def get_value() -> CancelServiceSoftwareUpdateResponseTypeDef:
    return {
        "ServiceSoftwareOptions": ...,
        "ResponseMetadata": ...,
    }
# CancelServiceSoftwareUpdateResponseTypeDef definition

class CancelServiceSoftwareUpdateResponseTypeDef(TypedDict):
    ServiceSoftwareOptions: ServiceSoftwareOptionsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ServiceSoftwareOptionsTypeDef
  2. See ResponseMetadataTypeDef

StartServiceSoftwareUpdateResponseTypeDef#

# StartServiceSoftwareUpdateResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import StartServiceSoftwareUpdateResponseTypeDef

def get_value() -> StartServiceSoftwareUpdateResponseTypeDef:
    return {
        "ServiceSoftwareOptions": ...,
        "ResponseMetadata": ...,
    }
# StartServiceSoftwareUpdateResponseTypeDef definition

class StartServiceSoftwareUpdateResponseTypeDef(TypedDict):
    ServiceSoftwareOptions: ServiceSoftwareOptionsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ServiceSoftwareOptionsTypeDef
  2. See ResponseMetadataTypeDef

UpgradeDomainResponseTypeDef#

# UpgradeDomainResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import UpgradeDomainResponseTypeDef

def get_value() -> UpgradeDomainResponseTypeDef:
    return {
        "UpgradeId": ...,
        "DomainName": ...,
        "TargetVersion": ...,
        "PerformCheckOnly": ...,
        "AdvancedOptions": ...,
        "ChangeProgressDetails": ...,
        "ResponseMetadata": ...,
    }
# UpgradeDomainResponseTypeDef definition

class UpgradeDomainResponseTypeDef(TypedDict):
    UpgradeId: str,
    DomainName: str,
    TargetVersion: str,
    PerformCheckOnly: bool,
    AdvancedOptions: Dict[str, str],
    ChangeProgressDetails: ChangeProgressDetailsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ChangeProgressDetailsTypeDef
  2. See ResponseMetadataTypeDef

ChangeProgressStatusDetailsTypeDef#

# ChangeProgressStatusDetailsTypeDef usage example

from mypy_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)
  1. See OverallChangeStatusType
  2. See ChangeProgressStageTypeDef

ClusterConfigTypeDef#

# ClusterConfigTypeDef usage example

from mypy_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],
  1. See OpenSearchPartitionInstanceTypeType
  2. See ZoneAwarenessConfigTypeDef
  3. See OpenSearchPartitionInstanceTypeType
  4. See OpenSearchWarmPartitionInstanceTypeType
  5. See ColdStorageOptionsTypeDef

CognitoOptionsStatusTypeDef#

# CognitoOptionsStatusTypeDef usage example

from mypy_boto3_opensearch.type_defs import CognitoOptionsStatusTypeDef

def get_value() -> CognitoOptionsStatusTypeDef:
    return {
        "Options": ...,
        "Status": ...,
    }
# CognitoOptionsStatusTypeDef definition

class CognitoOptionsStatusTypeDef(TypedDict):
    Options: CognitoOptionsTypeDef,  # (1)
    Status: OptionStatusTypeDef,  # (2)
  1. See CognitoOptionsTypeDef
  2. See OptionStatusTypeDef

GetCompatibleVersionsResponseTypeDef#

# GetCompatibleVersionsResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import GetCompatibleVersionsResponseTypeDef

def get_value() -> GetCompatibleVersionsResponseTypeDef:
    return {
        "CompatibleVersions": ...,
        "ResponseMetadata": ...,
    }
# GetCompatibleVersionsResponseTypeDef definition

class GetCompatibleVersionsResponseTypeDef(TypedDict):
    CompatibleVersions: List[CompatibleVersionsMapTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CompatibleVersionsMapTypeDef
  2. See ResponseMetadataTypeDef

DomainEndpointOptionsStatusTypeDef#

# DomainEndpointOptionsStatusTypeDef usage example

from mypy_boto3_opensearch.type_defs import DomainEndpointOptionsStatusTypeDef

def get_value() -> DomainEndpointOptionsStatusTypeDef:
    return {
        "Options": ...,
        "Status": ...,
    }
# DomainEndpointOptionsStatusTypeDef definition

class DomainEndpointOptionsStatusTypeDef(TypedDict):
    Options: DomainEndpointOptionsTypeDef,  # (1)
    Status: OptionStatusTypeDef,  # (2)
  1. See DomainEndpointOptionsTypeDef
  2. See OptionStatusTypeDef

EBSOptionsStatusTypeDef#

# EBSOptionsStatusTypeDef usage example

from mypy_boto3_opensearch.type_defs import EBSOptionsStatusTypeDef

def get_value() -> EBSOptionsStatusTypeDef:
    return {
        "Options": ...,
        "Status": ...,
    }
# EBSOptionsStatusTypeDef definition

class EBSOptionsStatusTypeDef(TypedDict):
    Options: EBSOptionsTypeDef,  # (1)
    Status: OptionStatusTypeDef,  # (2)
  1. See EBSOptionsTypeDef
  2. See OptionStatusTypeDef

EncryptionAtRestOptionsStatusTypeDef#

# EncryptionAtRestOptionsStatusTypeDef usage example

from mypy_boto3_opensearch.type_defs import EncryptionAtRestOptionsStatusTypeDef

def get_value() -> EncryptionAtRestOptionsStatusTypeDef:
    return {
        "Options": ...,
        "Status": ...,
    }
# EncryptionAtRestOptionsStatusTypeDef definition

class EncryptionAtRestOptionsStatusTypeDef(TypedDict):
    Options: EncryptionAtRestOptionsTypeDef,  # (1)
    Status: OptionStatusTypeDef,  # (2)
  1. See EncryptionAtRestOptionsTypeDef
  2. See OptionStatusTypeDef

LogPublishingOptionsStatusTypeDef#

# LogPublishingOptionsStatusTypeDef usage example

from mypy_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)
  1. See LogTypeType LogPublishingOptionTypeDef
  2. See OptionStatusTypeDef

NodeToNodeEncryptionOptionsStatusTypeDef#

# NodeToNodeEncryptionOptionsStatusTypeDef usage example

from mypy_boto3_opensearch.type_defs import NodeToNodeEncryptionOptionsStatusTypeDef

def get_value() -> NodeToNodeEncryptionOptionsStatusTypeDef:
    return {
        "Options": ...,
        "Status": ...,
    }
# NodeToNodeEncryptionOptionsStatusTypeDef definition

class NodeToNodeEncryptionOptionsStatusTypeDef(TypedDict):
    Options: NodeToNodeEncryptionOptionsTypeDef,  # (1)
    Status: OptionStatusTypeDef,  # (2)
  1. See NodeToNodeEncryptionOptionsTypeDef
  2. See OptionStatusTypeDef

SnapshotOptionsStatusTypeDef#

# SnapshotOptionsStatusTypeDef usage example

from mypy_boto3_opensearch.type_defs import SnapshotOptionsStatusTypeDef

def get_value() -> SnapshotOptionsStatusTypeDef:
    return {
        "Options": ...,
        "Status": ...,
    }
# SnapshotOptionsStatusTypeDef definition

class SnapshotOptionsStatusTypeDef(TypedDict):
    Options: SnapshotOptionsTypeDef,  # (1)
    Status: OptionStatusTypeDef,  # (2)
  1. See SnapshotOptionsTypeDef
  2. See OptionStatusTypeDef

SoftwareUpdateOptionsStatusTypeDef#

# SoftwareUpdateOptionsStatusTypeDef usage example

from mypy_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)
  1. See SoftwareUpdateOptionsTypeDef
  2. See OptionStatusTypeDef

CreateVpcEndpointRequestRequestTypeDef#

# CreateVpcEndpointRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import CreateVpcEndpointRequestRequestTypeDef

def get_value() -> CreateVpcEndpointRequestRequestTypeDef:
    return {
        "DomainArn": ...,
        "VpcOptions": ...,
    }
# CreateVpcEndpointRequestRequestTypeDef definition

class CreateVpcEndpointRequestRequestTypeDef(TypedDict):
    DomainArn: str,
    VpcOptions: VPCOptionsTypeDef,  # (1)
    ClientToken: NotRequired[str],
  1. See VPCOptionsTypeDef

UpdateVpcEndpointRequestRequestTypeDef#

# UpdateVpcEndpointRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import UpdateVpcEndpointRequestRequestTypeDef

def get_value() -> UpdateVpcEndpointRequestRequestTypeDef:
    return {
        "VpcEndpointId": ...,
        "VpcOptions": ...,
    }
# UpdateVpcEndpointRequestRequestTypeDef definition

class UpdateVpcEndpointRequestRequestTypeDef(TypedDict):
    VpcEndpointId: str,
    VpcOptions: VPCOptionsTypeDef,  # (1)
  1. See VPCOptionsTypeDef

CreatePackageRequestRequestTypeDef#

# CreatePackageRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import CreatePackageRequestRequestTypeDef

def get_value() -> CreatePackageRequestRequestTypeDef:
    return {
        "PackageName": ...,
        "PackageType": ...,
        "PackageSource": ...,
    }
# CreatePackageRequestRequestTypeDef definition

class CreatePackageRequestRequestTypeDef(TypedDict):
    PackageName: str,
    PackageType: PackageTypeType,  # (1)
    PackageSource: PackageSourceTypeDef,  # (2)
    PackageDescription: NotRequired[str],
  1. See PackageTypeType
  2. See PackageSourceTypeDef

UpdatePackageRequestRequestTypeDef#

# UpdatePackageRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import UpdatePackageRequestRequestTypeDef

def get_value() -> UpdatePackageRequestRequestTypeDef:
    return {
        "PackageID": ...,
        "PackageSource": ...,
    }
# UpdatePackageRequestRequestTypeDef definition

class UpdatePackageRequestRequestTypeDef(TypedDict):
    PackageID: str,
    PackageSource: PackageSourceTypeDef,  # (1)
    PackageDescription: NotRequired[str],
    CommitMessage: NotRequired[str],
  1. See PackageSourceTypeDef

DeleteVpcEndpointResponseTypeDef#

# DeleteVpcEndpointResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import DeleteVpcEndpointResponseTypeDef

def get_value() -> DeleteVpcEndpointResponseTypeDef:
    return {
        "VpcEndpointSummary": ...,
        "ResponseMetadata": ...,
    }
# DeleteVpcEndpointResponseTypeDef definition

class DeleteVpcEndpointResponseTypeDef(TypedDict):
    VpcEndpointSummary: VpcEndpointSummaryTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See VpcEndpointSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListVpcEndpointsForDomainResponseTypeDef#

# ListVpcEndpointsForDomainResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import ListVpcEndpointsForDomainResponseTypeDef

def get_value() -> ListVpcEndpointsForDomainResponseTypeDef:
    return {
        "VpcEndpointSummaryList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListVpcEndpointsForDomainResponseTypeDef definition

class ListVpcEndpointsForDomainResponseTypeDef(TypedDict):
    VpcEndpointSummaryList: List[VpcEndpointSummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See VpcEndpointSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListVpcEndpointsResponseTypeDef#

# ListVpcEndpointsResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import ListVpcEndpointsResponseTypeDef

def get_value() -> ListVpcEndpointsResponseTypeDef:
    return {
        "VpcEndpointSummaryList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListVpcEndpointsResponseTypeDef definition

class ListVpcEndpointsResponseTypeDef(TypedDict):
    VpcEndpointSummaryList: List[VpcEndpointSummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See VpcEndpointSummaryTypeDef
  2. See ResponseMetadataTypeDef

DescribeDomainNodesResponseTypeDef#

# DescribeDomainNodesResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import DescribeDomainNodesResponseTypeDef

def get_value() -> DescribeDomainNodesResponseTypeDef:
    return {
        "DomainNodesStatusList": ...,
        "ResponseMetadata": ...,
    }
# DescribeDomainNodesResponseTypeDef definition

class DescribeDomainNodesResponseTypeDef(TypedDict):
    DomainNodesStatusList: List[DomainNodesStatusTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainNodesStatusTypeDef
  2. See ResponseMetadataTypeDef

DescribeInboundConnectionsRequestRequestTypeDef#

# DescribeInboundConnectionsRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import DescribeInboundConnectionsRequestRequestTypeDef

def get_value() -> DescribeInboundConnectionsRequestRequestTypeDef:
    return {
        "Filters": ...,
    }
# DescribeInboundConnectionsRequestRequestTypeDef definition

class DescribeInboundConnectionsRequestRequestTypeDef(TypedDict):
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See FilterTypeDef

DescribeOutboundConnectionsRequestRequestTypeDef#

# DescribeOutboundConnectionsRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import DescribeOutboundConnectionsRequestRequestTypeDef

def get_value() -> DescribeOutboundConnectionsRequestRequestTypeDef:
    return {
        "Filters": ...,
    }
# DescribeOutboundConnectionsRequestRequestTypeDef definition

class DescribeOutboundConnectionsRequestRequestTypeDef(TypedDict):
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See FilterTypeDef

DescribePackagesRequestRequestTypeDef#

# DescribePackagesRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import DescribePackagesRequestRequestTypeDef

def get_value() -> DescribePackagesRequestRequestTypeDef:
    return {
        "Filters": ...,
    }
# DescribePackagesRequestRequestTypeDef definition

class DescribePackagesRequestRequestTypeDef(TypedDict):
    Filters: NotRequired[Sequence[DescribePackagesFilterTypeDef]],  # (1)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See DescribePackagesFilterTypeDef

ListDomainNamesResponseTypeDef#

# ListDomainNamesResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import ListDomainNamesResponseTypeDef

def get_value() -> ListDomainNamesResponseTypeDef:
    return {
        "DomainNames": ...,
        "ResponseMetadata": ...,
    }
# ListDomainNamesResponseTypeDef definition

class ListDomainNamesResponseTypeDef(TypedDict):
    DomainNames: List[DomainInfoTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainInfoTypeDef
  2. See ResponseMetadataTypeDef

DomainPackageDetailsTypeDef#

# DomainPackageDetailsTypeDef usage example

from mypy_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],
    ReferencePath: NotRequired[str],
    ErrorDetails: NotRequired[ErrorDetailsTypeDef],  # (3)
  1. See PackageTypeType
  2. See DomainPackageStatusType
  3. See ErrorDetailsTypeDef

PackageDetailsTypeDef#

# PackageDetailsTypeDef usage example

from mypy_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)
  1. See PackageTypeType
  2. See PackageStatusType
  3. See ErrorDetailsTypeDef

VPCDerivedInfoStatusTypeDef#

# VPCDerivedInfoStatusTypeDef usage example

from mypy_boto3_opensearch.type_defs import VPCDerivedInfoStatusTypeDef

def get_value() -> VPCDerivedInfoStatusTypeDef:
    return {
        "Options": ...,
        "Status": ...,
    }
# VPCDerivedInfoStatusTypeDef definition

class VPCDerivedInfoStatusTypeDef(TypedDict):
    Options: VPCDerivedInfoTypeDef,  # (1)
    Status: OptionStatusTypeDef,  # (2)
  1. See VPCDerivedInfoTypeDef
  2. See OptionStatusTypeDef

VpcEndpointTypeDef#

# VpcEndpointTypeDef usage example

from mypy_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],
  1. See VPCDerivedInfoTypeDef
  2. See VpcEndpointStatusType

DryRunProgressStatusTypeDef#

# DryRunProgressStatusTypeDef usage example

from mypy_boto3_opensearch.type_defs import DryRunProgressStatusTypeDef

def get_value() -> DryRunProgressStatusTypeDef:
    return {
        "DryRunId": ...,
        "DryRunStatus": ...,
        "CreationDate": ...,
        "UpdateDate": ...,
    }
# DryRunProgressStatusTypeDef definition

class DryRunProgressStatusTypeDef(TypedDict):
    DryRunId: str,
    DryRunStatus: str,
    CreationDate: str,
    UpdateDate: str,
    ValidationFailures: NotRequired[List[ValidationFailureTypeDef]],  # (1)
  1. See ValidationFailureTypeDef

GetPackageVersionHistoryResponseTypeDef#

# GetPackageVersionHistoryResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import GetPackageVersionHistoryResponseTypeDef

def get_value() -> GetPackageVersionHistoryResponseTypeDef:
    return {
        "PackageID": ...,
        "PackageVersionHistoryList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# GetPackageVersionHistoryResponseTypeDef definition

class GetPackageVersionHistoryResponseTypeDef(TypedDict):
    PackageID: str,
    PackageVersionHistoryList: List[PackageVersionHistoryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PackageVersionHistoryTypeDef
  2. See ResponseMetadataTypeDef

InstanceLimitsTypeDef#

# InstanceLimitsTypeDef usage example

from mypy_boto3_opensearch.type_defs import InstanceLimitsTypeDef

def get_value() -> InstanceLimitsTypeDef:
    return {
        "InstanceCountLimits": ...,
    }
# InstanceLimitsTypeDef definition

class InstanceLimitsTypeDef(TypedDict):
    InstanceCountLimits: NotRequired[InstanceCountLimitsTypeDef],  # (1)
  1. See InstanceCountLimitsTypeDef

ListInstanceTypeDetailsResponseTypeDef#

# ListInstanceTypeDetailsResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import ListInstanceTypeDetailsResponseTypeDef

def get_value() -> ListInstanceTypeDetailsResponseTypeDef:
    return {
        "InstanceTypeDetails": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListInstanceTypeDetailsResponseTypeDef definition

class ListInstanceTypeDetailsResponseTypeDef(TypedDict):
    InstanceTypeDetails: List[InstanceTypeDetailsTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See InstanceTypeDetailsTypeDef
  2. See ResponseMetadataTypeDef

ListScheduledActionsResponseTypeDef#

# ListScheduledActionsResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import ListScheduledActionsResponseTypeDef

def get_value() -> ListScheduledActionsResponseTypeDef:
    return {
        "ScheduledActions": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListScheduledActionsResponseTypeDef definition

class ListScheduledActionsResponseTypeDef(TypedDict):
    ScheduledActions: List[ScheduledActionTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ScheduledActionTypeDef
  2. See ResponseMetadataTypeDef

UpdateScheduledActionResponseTypeDef#

# UpdateScheduledActionResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import UpdateScheduledActionResponseTypeDef

def get_value() -> UpdateScheduledActionResponseTypeDef:
    return {
        "ScheduledAction": ...,
        "ResponseMetadata": ...,
    }
# UpdateScheduledActionResponseTypeDef definition

class UpdateScheduledActionResponseTypeDef(TypedDict):
    ScheduledAction: ScheduledActionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ScheduledActionTypeDef
  2. See ResponseMetadataTypeDef

OffPeakWindowTypeDef#

# OffPeakWindowTypeDef usage example

from mypy_boto3_opensearch.type_defs import OffPeakWindowTypeDef

def get_value() -> OffPeakWindowTypeDef:
    return {
        "WindowStartTime": ...,
    }
# OffPeakWindowTypeDef definition

class OffPeakWindowTypeDef(TypedDict):
    WindowStartTime: NotRequired[WindowStartTimeTypeDef],  # (1)
  1. See WindowStartTimeTypeDef

ReservedInstanceOfferingTypeDef#

# ReservedInstanceOfferingTypeDef usage example

from mypy_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)
  1. See OpenSearchPartitionInstanceTypeType
  2. See ReservedInstancePaymentOptionType
  3. See RecurringChargeTypeDef

ReservedInstanceTypeDef#

# ReservedInstanceTypeDef usage example

from mypy_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)
  1. See OpenSearchPartitionInstanceTypeType
  2. See ReservedInstancePaymentOptionType
  3. See RecurringChargeTypeDef

SAMLOptionsInputTypeDef#

# SAMLOptionsInputTypeDef usage example

from mypy_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],
  1. See SAMLIdpTypeDef

SAMLOptionsOutputTypeDef#

# SAMLOptionsOutputTypeDef usage example

from mypy_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],
  1. See SAMLIdpTypeDef

StorageTypeTypeDef#

# StorageTypeTypeDef usage example

from mypy_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)
  1. See StorageTypeLimitTypeDef

UpgradeHistoryTypeDef#

# UpgradeHistoryTypeDef usage example

from mypy_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)
  1. See UpgradeStatusType
  2. See UpgradeStepItemTypeDef

CreateOutboundConnectionRequestRequestTypeDef#

# CreateOutboundConnectionRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import CreateOutboundConnectionRequestRequestTypeDef

def get_value() -> CreateOutboundConnectionRequestRequestTypeDef:
    return {
        "LocalDomainInfo": ...,
        "RemoteDomainInfo": ...,
        "ConnectionAlias": ...,
    }
# CreateOutboundConnectionRequestRequestTypeDef definition

class CreateOutboundConnectionRequestRequestTypeDef(TypedDict):
    LocalDomainInfo: DomainInformationContainerTypeDef,  # (1)
    RemoteDomainInfo: DomainInformationContainerTypeDef,  # (1)
    ConnectionAlias: str,
    ConnectionMode: NotRequired[ConnectionModeType],  # (3)
  1. See DomainInformationContainerTypeDef
  2. See DomainInformationContainerTypeDef
  3. See ConnectionModeType

CreateOutboundConnectionResponseTypeDef#

# CreateOutboundConnectionResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import CreateOutboundConnectionResponseTypeDef

def get_value() -> CreateOutboundConnectionResponseTypeDef:
    return {
        "LocalDomainInfo": ...,
        "RemoteDomainInfo": ...,
        "ConnectionAlias": ...,
        "ConnectionStatus": ...,
        "ConnectionId": ...,
        "ConnectionMode": ...,
        "ConnectionProperties": ...,
        "ResponseMetadata": ...,
    }
# 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)
  1. See DomainInformationContainerTypeDef
  2. See DomainInformationContainerTypeDef
  3. See OutboundConnectionStatusTypeDef
  4. See ConnectionModeType
  5. See ConnectionPropertiesTypeDef
  6. See ResponseMetadataTypeDef

InboundConnectionTypeDef#

# InboundConnectionTypeDef usage example

from mypy_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)
  1. See DomainInformationContainerTypeDef
  2. See DomainInformationContainerTypeDef
  3. See InboundConnectionStatusTypeDef
  4. See ConnectionModeType

OutboundConnectionTypeDef#

# OutboundConnectionTypeDef usage example

from mypy_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)
  1. See DomainInformationContainerTypeDef
  2. See DomainInformationContainerTypeDef
  3. See OutboundConnectionStatusTypeDef
  4. See ConnectionModeType
  5. See ConnectionPropertiesTypeDef

AutoTuneTypeDef#

# AutoTuneTypeDef usage example

from mypy_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)
  1. See AutoTuneTypeType
  2. See AutoTuneDetailsTypeDef

AutoTuneOptionsInputTypeDef#

# AutoTuneOptionsInputTypeDef usage example

from mypy_boto3_opensearch.type_defs import AutoTuneOptionsInputTypeDef

def get_value() -> AutoTuneOptionsInputTypeDef:
    return {
        "DesiredState": ...,
    }
# AutoTuneOptionsInputTypeDef definition

class AutoTuneOptionsInputTypeDef(TypedDict):
    DesiredState: NotRequired[AutoTuneDesiredStateType],  # (1)
    MaintenanceSchedules: NotRequired[Sequence[AutoTuneMaintenanceScheduleTypeDef]],  # (2)
    UseOffPeakWindow: NotRequired[bool],
  1. See AutoTuneDesiredStateType
  2. See AutoTuneMaintenanceScheduleTypeDef

AutoTuneOptionsTypeDef#

# AutoTuneOptionsTypeDef usage example

from mypy_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[List[AutoTuneMaintenanceScheduleTypeDef]],  # (3)
    UseOffPeakWindow: NotRequired[bool],
  1. See AutoTuneDesiredStateType
  2. See RollbackOnDisableType
  3. See AutoTuneMaintenanceScheduleTypeDef

DescribeDomainHealthResponseTypeDef#

# DescribeDomainHealthResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import DescribeDomainHealthResponseTypeDef

def get_value() -> DescribeDomainHealthResponseTypeDef:
    return {
        "DomainState": ...,
        "AvailabilityZoneCount": ...,
        "ActiveAvailabilityZoneCount": ...,
        "StandByAvailabilityZoneCount": ...,
        "DataNodeCount": ...,
        "DedicatedMaster": ...,
        "MasterEligibleNodeCount": ...,
        "WarmNodeCount": ...,
        "MasterNode": ...,
        "ClusterHealth": ...,
        "TotalShards": ...,
        "TotalUnAssignedShards": ...,
        "EnvironmentInformation": ...,
        "ResponseMetadata": ...,
    }
# 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)
  1. See DomainStateType
  2. See MasterNodeStatusType
  3. See DomainHealthType
  4. See EnvironmentInfoTypeDef
  5. See ResponseMetadataTypeDef

DescribeDomainChangeProgressResponseTypeDef#

# DescribeDomainChangeProgressResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import DescribeDomainChangeProgressResponseTypeDef

def get_value() -> DescribeDomainChangeProgressResponseTypeDef:
    return {
        "ChangeProgressStatus": ...,
        "ResponseMetadata": ...,
    }
# DescribeDomainChangeProgressResponseTypeDef definition

class DescribeDomainChangeProgressResponseTypeDef(TypedDict):
    ChangeProgressStatus: ChangeProgressStatusDetailsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ChangeProgressStatusDetailsTypeDef
  2. See ResponseMetadataTypeDef

ClusterConfigStatusTypeDef#

# ClusterConfigStatusTypeDef usage example

from mypy_boto3_opensearch.type_defs import ClusterConfigStatusTypeDef

def get_value() -> ClusterConfigStatusTypeDef:
    return {
        "Options": ...,
        "Status": ...,
    }
# ClusterConfigStatusTypeDef definition

class ClusterConfigStatusTypeDef(TypedDict):
    Options: ClusterConfigTypeDef,  # (1)
    Status: OptionStatusTypeDef,  # (2)
  1. See ClusterConfigTypeDef
  2. See OptionStatusTypeDef

AssociatePackageResponseTypeDef#

# AssociatePackageResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import AssociatePackageResponseTypeDef

def get_value() -> AssociatePackageResponseTypeDef:
    return {
        "DomainPackageDetails": ...,
        "ResponseMetadata": ...,
    }
# AssociatePackageResponseTypeDef definition

class AssociatePackageResponseTypeDef(TypedDict):
    DomainPackageDetails: DomainPackageDetailsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainPackageDetailsTypeDef
  2. See ResponseMetadataTypeDef

DissociatePackageResponseTypeDef#

# DissociatePackageResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import DissociatePackageResponseTypeDef

def get_value() -> DissociatePackageResponseTypeDef:
    return {
        "DomainPackageDetails": ...,
        "ResponseMetadata": ...,
    }
# DissociatePackageResponseTypeDef definition

class DissociatePackageResponseTypeDef(TypedDict):
    DomainPackageDetails: DomainPackageDetailsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainPackageDetailsTypeDef
  2. See ResponseMetadataTypeDef

ListDomainsForPackageResponseTypeDef#

# ListDomainsForPackageResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import ListDomainsForPackageResponseTypeDef

def get_value() -> ListDomainsForPackageResponseTypeDef:
    return {
        "DomainPackageDetailsList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListDomainsForPackageResponseTypeDef definition

class ListDomainsForPackageResponseTypeDef(TypedDict):
    DomainPackageDetailsList: List[DomainPackageDetailsTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainPackageDetailsTypeDef
  2. See ResponseMetadataTypeDef

ListPackagesForDomainResponseTypeDef#

# ListPackagesForDomainResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import ListPackagesForDomainResponseTypeDef

def get_value() -> ListPackagesForDomainResponseTypeDef:
    return {
        "DomainPackageDetailsList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListPackagesForDomainResponseTypeDef definition

class ListPackagesForDomainResponseTypeDef(TypedDict):
    DomainPackageDetailsList: List[DomainPackageDetailsTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainPackageDetailsTypeDef
  2. See ResponseMetadataTypeDef

CreatePackageResponseTypeDef#

# CreatePackageResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import CreatePackageResponseTypeDef

def get_value() -> CreatePackageResponseTypeDef:
    return {
        "PackageDetails": ...,
        "ResponseMetadata": ...,
    }
# CreatePackageResponseTypeDef definition

class CreatePackageResponseTypeDef(TypedDict):
    PackageDetails: PackageDetailsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PackageDetailsTypeDef
  2. See ResponseMetadataTypeDef

DeletePackageResponseTypeDef#

# DeletePackageResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import DeletePackageResponseTypeDef

def get_value() -> DeletePackageResponseTypeDef:
    return {
        "PackageDetails": ...,
        "ResponseMetadata": ...,
    }
# DeletePackageResponseTypeDef definition

class DeletePackageResponseTypeDef(TypedDict):
    PackageDetails: PackageDetailsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PackageDetailsTypeDef
  2. See ResponseMetadataTypeDef

DescribePackagesResponseTypeDef#

# DescribePackagesResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import DescribePackagesResponseTypeDef

def get_value() -> DescribePackagesResponseTypeDef:
    return {
        "PackageDetailsList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# DescribePackagesResponseTypeDef definition

class DescribePackagesResponseTypeDef(TypedDict):
    PackageDetailsList: List[PackageDetailsTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PackageDetailsTypeDef
  2. See ResponseMetadataTypeDef

UpdatePackageResponseTypeDef#

# UpdatePackageResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import UpdatePackageResponseTypeDef

def get_value() -> UpdatePackageResponseTypeDef:
    return {
        "PackageDetails": ...,
        "ResponseMetadata": ...,
    }
# UpdatePackageResponseTypeDef definition

class UpdatePackageResponseTypeDef(TypedDict):
    PackageDetails: PackageDetailsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PackageDetailsTypeDef
  2. See ResponseMetadataTypeDef

CreateVpcEndpointResponseTypeDef#

# CreateVpcEndpointResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import CreateVpcEndpointResponseTypeDef

def get_value() -> CreateVpcEndpointResponseTypeDef:
    return {
        "VpcEndpoint": ...,
        "ResponseMetadata": ...,
    }
# CreateVpcEndpointResponseTypeDef definition

class CreateVpcEndpointResponseTypeDef(TypedDict):
    VpcEndpoint: VpcEndpointTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See VpcEndpointTypeDef
  2. See ResponseMetadataTypeDef

DescribeVpcEndpointsResponseTypeDef#

# DescribeVpcEndpointsResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import DescribeVpcEndpointsResponseTypeDef

def get_value() -> DescribeVpcEndpointsResponseTypeDef:
    return {
        "VpcEndpoints": ...,
        "VpcEndpointErrors": ...,
        "ResponseMetadata": ...,
    }
# DescribeVpcEndpointsResponseTypeDef definition

class DescribeVpcEndpointsResponseTypeDef(TypedDict):
    VpcEndpoints: List[VpcEndpointTypeDef],  # (1)
    VpcEndpointErrors: List[VpcEndpointErrorTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See VpcEndpointTypeDef
  2. See VpcEndpointErrorTypeDef
  3. See ResponseMetadataTypeDef

UpdateVpcEndpointResponseTypeDef#

# UpdateVpcEndpointResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import UpdateVpcEndpointResponseTypeDef

def get_value() -> UpdateVpcEndpointResponseTypeDef:
    return {
        "VpcEndpoint": ...,
        "ResponseMetadata": ...,
    }
# UpdateVpcEndpointResponseTypeDef definition

class UpdateVpcEndpointResponseTypeDef(TypedDict):
    VpcEndpoint: VpcEndpointTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See VpcEndpointTypeDef
  2. See ResponseMetadataTypeDef

OffPeakWindowOptionsTypeDef#

# OffPeakWindowOptionsTypeDef usage example

from mypy_boto3_opensearch.type_defs import OffPeakWindowOptionsTypeDef

def get_value() -> OffPeakWindowOptionsTypeDef:
    return {
        "Enabled": ...,
    }
# OffPeakWindowOptionsTypeDef definition

class OffPeakWindowOptionsTypeDef(TypedDict):
    Enabled: NotRequired[bool],
    OffPeakWindow: NotRequired[OffPeakWindowTypeDef],  # (1)
  1. See OffPeakWindowTypeDef

DescribeReservedInstanceOfferingsResponseTypeDef#

# DescribeReservedInstanceOfferingsResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import DescribeReservedInstanceOfferingsResponseTypeDef

def get_value() -> DescribeReservedInstanceOfferingsResponseTypeDef:
    return {
        "NextToken": ...,
        "ReservedInstanceOfferings": ...,
        "ResponseMetadata": ...,
    }
# DescribeReservedInstanceOfferingsResponseTypeDef definition

class DescribeReservedInstanceOfferingsResponseTypeDef(TypedDict):
    NextToken: str,
    ReservedInstanceOfferings: List[ReservedInstanceOfferingTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ReservedInstanceOfferingTypeDef
  2. See ResponseMetadataTypeDef

DescribeReservedInstancesResponseTypeDef#

# DescribeReservedInstancesResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import DescribeReservedInstancesResponseTypeDef

def get_value() -> DescribeReservedInstancesResponseTypeDef:
    return {
        "NextToken": ...,
        "ReservedInstances": ...,
        "ResponseMetadata": ...,
    }
# DescribeReservedInstancesResponseTypeDef definition

class DescribeReservedInstancesResponseTypeDef(TypedDict):
    NextToken: str,
    ReservedInstances: List[ReservedInstanceTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ReservedInstanceTypeDef
  2. See ResponseMetadataTypeDef

AdvancedSecurityOptionsInputTypeDef#

# AdvancedSecurityOptionsInputTypeDef usage example

from mypy_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)
    AnonymousAuthEnabled: NotRequired[bool],
  1. See MasterUserOptionsTypeDef
  2. See SAMLOptionsInputTypeDef

AdvancedSecurityOptionsTypeDef#

# AdvancedSecurityOptionsTypeDef usage example

from mypy_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)
    AnonymousAuthDisableDate: NotRequired[datetime],
    AnonymousAuthEnabled: NotRequired[bool],
  1. See SAMLOptionsOutputTypeDef

LimitsTypeDef#

# LimitsTypeDef usage example

from mypy_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)
  1. See StorageTypeTypeDef
  2. See InstanceLimitsTypeDef
  3. See AdditionalLimitTypeDef

GetUpgradeHistoryResponseTypeDef#

# GetUpgradeHistoryResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import GetUpgradeHistoryResponseTypeDef

def get_value() -> GetUpgradeHistoryResponseTypeDef:
    return {
        "UpgradeHistories": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# GetUpgradeHistoryResponseTypeDef definition

class GetUpgradeHistoryResponseTypeDef(TypedDict):
    UpgradeHistories: List[UpgradeHistoryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See UpgradeHistoryTypeDef
  2. See ResponseMetadataTypeDef

AcceptInboundConnectionResponseTypeDef#

# AcceptInboundConnectionResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import AcceptInboundConnectionResponseTypeDef

def get_value() -> AcceptInboundConnectionResponseTypeDef:
    return {
        "Connection": ...,
        "ResponseMetadata": ...,
    }
# AcceptInboundConnectionResponseTypeDef definition

class AcceptInboundConnectionResponseTypeDef(TypedDict):
    Connection: InboundConnectionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See InboundConnectionTypeDef
  2. See ResponseMetadataTypeDef

DeleteInboundConnectionResponseTypeDef#

# DeleteInboundConnectionResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import DeleteInboundConnectionResponseTypeDef

def get_value() -> DeleteInboundConnectionResponseTypeDef:
    return {
        "Connection": ...,
        "ResponseMetadata": ...,
    }
# DeleteInboundConnectionResponseTypeDef definition

class DeleteInboundConnectionResponseTypeDef(TypedDict):
    Connection: InboundConnectionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See InboundConnectionTypeDef
  2. See ResponseMetadataTypeDef

DescribeInboundConnectionsResponseTypeDef#

# DescribeInboundConnectionsResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import DescribeInboundConnectionsResponseTypeDef

def get_value() -> DescribeInboundConnectionsResponseTypeDef:
    return {
        "Connections": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# DescribeInboundConnectionsResponseTypeDef definition

class DescribeInboundConnectionsResponseTypeDef(TypedDict):
    Connections: List[InboundConnectionTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See InboundConnectionTypeDef
  2. See ResponseMetadataTypeDef

RejectInboundConnectionResponseTypeDef#

# RejectInboundConnectionResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import RejectInboundConnectionResponseTypeDef

def get_value() -> RejectInboundConnectionResponseTypeDef:
    return {
        "Connection": ...,
        "ResponseMetadata": ...,
    }
# RejectInboundConnectionResponseTypeDef definition

class RejectInboundConnectionResponseTypeDef(TypedDict):
    Connection: InboundConnectionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See InboundConnectionTypeDef
  2. See ResponseMetadataTypeDef

DeleteOutboundConnectionResponseTypeDef#

# DeleteOutboundConnectionResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import DeleteOutboundConnectionResponseTypeDef

def get_value() -> DeleteOutboundConnectionResponseTypeDef:
    return {
        "Connection": ...,
        "ResponseMetadata": ...,
    }
# DeleteOutboundConnectionResponseTypeDef definition

class DeleteOutboundConnectionResponseTypeDef(TypedDict):
    Connection: OutboundConnectionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See OutboundConnectionTypeDef
  2. See ResponseMetadataTypeDef

DescribeOutboundConnectionsResponseTypeDef#

# DescribeOutboundConnectionsResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import DescribeOutboundConnectionsResponseTypeDef

def get_value() -> DescribeOutboundConnectionsResponseTypeDef:
    return {
        "Connections": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# DescribeOutboundConnectionsResponseTypeDef definition

class DescribeOutboundConnectionsResponseTypeDef(TypedDict):
    Connections: List[OutboundConnectionTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See OutboundConnectionTypeDef
  2. See ResponseMetadataTypeDef

DescribeDomainAutoTunesResponseTypeDef#

# DescribeDomainAutoTunesResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import DescribeDomainAutoTunesResponseTypeDef

def get_value() -> DescribeDomainAutoTunesResponseTypeDef:
    return {
        "AutoTunes": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# DescribeDomainAutoTunesResponseTypeDef definition

class DescribeDomainAutoTunesResponseTypeDef(TypedDict):
    AutoTunes: List[AutoTuneTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AutoTuneTypeDef
  2. See ResponseMetadataTypeDef

AutoTuneOptionsStatusTypeDef#

# AutoTuneOptionsStatusTypeDef usage example

from mypy_boto3_opensearch.type_defs import AutoTuneOptionsStatusTypeDef

def get_value() -> AutoTuneOptionsStatusTypeDef:
    return {
        "Options": ...,
    }
# AutoTuneOptionsStatusTypeDef definition

class AutoTuneOptionsStatusTypeDef(TypedDict):
    Options: NotRequired[AutoTuneOptionsTypeDef],  # (1)
    Status: NotRequired[AutoTuneStatusTypeDef],  # (2)
  1. See AutoTuneOptionsTypeDef
  2. See AutoTuneStatusTypeDef

OffPeakWindowOptionsStatusTypeDef#

# OffPeakWindowOptionsStatusTypeDef usage example

from mypy_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)
  1. See OffPeakWindowOptionsTypeDef
  2. See OptionStatusTypeDef

CreateDomainRequestRequestTypeDef#

# CreateDomainRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import CreateDomainRequestRequestTypeDef

def get_value() -> CreateDomainRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
# CreateDomainRequestRequestTypeDef definition

class CreateDomainRequestRequestTypeDef(TypedDict):
    DomainName: str,
    EngineVersion: NotRequired[str],
    ClusterConfig: NotRequired[ClusterConfigTypeDef],  # (1)
    EBSOptions: NotRequired[EBSOptionsTypeDef],  # (2)
    AccessPolicies: NotRequired[str],
    SnapshotOptions: NotRequired[SnapshotOptionsTypeDef],  # (3)
    VPCOptions: NotRequired[VPCOptionsTypeDef],  # (4)
    CognitoOptions: NotRequired[CognitoOptionsTypeDef],  # (5)
    EncryptionAtRestOptions: NotRequired[EncryptionAtRestOptionsTypeDef],  # (6)
    NodeToNodeEncryptionOptions: NotRequired[NodeToNodeEncryptionOptionsTypeDef],  # (7)
    AdvancedOptions: NotRequired[Mapping[str, str]],
    LogPublishingOptions: NotRequired[Mapping[LogTypeType, LogPublishingOptionTypeDef]],  # (8)
    DomainEndpointOptions: NotRequired[DomainEndpointOptionsTypeDef],  # (9)
    AdvancedSecurityOptions: NotRequired[AdvancedSecurityOptionsInputTypeDef],  # (10)
    TagList: NotRequired[Sequence[TagTypeDef]],  # (11)
    AutoTuneOptions: NotRequired[AutoTuneOptionsInputTypeDef],  # (12)
    OffPeakWindowOptions: NotRequired[OffPeakWindowOptionsTypeDef],  # (13)
    SoftwareUpdateOptions: NotRequired[SoftwareUpdateOptionsTypeDef],  # (14)
  1. See ClusterConfigTypeDef
  2. See EBSOptionsTypeDef
  3. See SnapshotOptionsTypeDef
  4. See VPCOptionsTypeDef
  5. See CognitoOptionsTypeDef
  6. See EncryptionAtRestOptionsTypeDef
  7. See NodeToNodeEncryptionOptionsTypeDef
  8. See LogTypeType LogPublishingOptionTypeDef
  9. See DomainEndpointOptionsTypeDef
  10. See AdvancedSecurityOptionsInputTypeDef
  11. See TagTypeDef
  12. See AutoTuneOptionsInputTypeDef
  13. See OffPeakWindowOptionsTypeDef
  14. See SoftwareUpdateOptionsTypeDef

UpdateDomainConfigRequestRequestTypeDef#

# UpdateDomainConfigRequestRequestTypeDef usage example

from mypy_boto3_opensearch.type_defs import UpdateDomainConfigRequestRequestTypeDef

def get_value() -> UpdateDomainConfigRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
# UpdateDomainConfigRequestRequestTypeDef definition

class UpdateDomainConfigRequestRequestTypeDef(TypedDict):
    DomainName: str,
    ClusterConfig: NotRequired[ClusterConfigTypeDef],  # (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],
    LogPublishingOptions: NotRequired[Mapping[LogTypeType, LogPublishingOptionTypeDef]],  # (6)
    EncryptionAtRestOptions: NotRequired[EncryptionAtRestOptionsTypeDef],  # (7)
    DomainEndpointOptions: NotRequired[DomainEndpointOptionsTypeDef],  # (8)
    NodeToNodeEncryptionOptions: NotRequired[NodeToNodeEncryptionOptionsTypeDef],  # (9)
    AdvancedSecurityOptions: NotRequired[AdvancedSecurityOptionsInputTypeDef],  # (10)
    AutoTuneOptions: NotRequired[AutoTuneOptionsTypeDef],  # (11)
    DryRun: NotRequired[bool],
    DryRunMode: NotRequired[DryRunModeType],  # (12)
    OffPeakWindowOptions: NotRequired[OffPeakWindowOptionsTypeDef],  # (13)
    SoftwareUpdateOptions: NotRequired[SoftwareUpdateOptionsTypeDef],  # (14)
  1. See ClusterConfigTypeDef
  2. See EBSOptionsTypeDef
  3. See SnapshotOptionsTypeDef
  4. See VPCOptionsTypeDef
  5. See CognitoOptionsTypeDef
  6. See LogTypeType LogPublishingOptionTypeDef
  7. See EncryptionAtRestOptionsTypeDef
  8. See DomainEndpointOptionsTypeDef
  9. See NodeToNodeEncryptionOptionsTypeDef
  10. See AdvancedSecurityOptionsInputTypeDef
  11. See AutoTuneOptionsTypeDef
  12. See DryRunModeType
  13. See OffPeakWindowOptionsTypeDef
  14. See SoftwareUpdateOptionsTypeDef

AdvancedSecurityOptionsStatusTypeDef#

# AdvancedSecurityOptionsStatusTypeDef usage example

from mypy_boto3_opensearch.type_defs import AdvancedSecurityOptionsStatusTypeDef

def get_value() -> AdvancedSecurityOptionsStatusTypeDef:
    return {
        "Options": ...,
        "Status": ...,
    }
# AdvancedSecurityOptionsStatusTypeDef definition

class AdvancedSecurityOptionsStatusTypeDef(TypedDict):
    Options: AdvancedSecurityOptionsTypeDef,  # (1)
    Status: OptionStatusTypeDef,  # (2)
  1. See AdvancedSecurityOptionsTypeDef
  2. See OptionStatusTypeDef

DomainStatusTypeDef#

# DomainStatusTypeDef usage example

from mypy_boto3_opensearch.type_defs import DomainStatusTypeDef

def get_value() -> DomainStatusTypeDef:
    return {
        "DomainId": ...,
        "DomainName": ...,
        "ARN": ...,
        "ClusterConfig": ...,
    }
# DomainStatusTypeDef definition

class DomainStatusTypeDef(TypedDict):
    DomainId: str,
    DomainName: str,
    ARN: str,
    ClusterConfig: ClusterConfigTypeDef,  # (1)
    Created: NotRequired[bool],
    Deleted: NotRequired[bool],
    Endpoint: NotRequired[str],
    Endpoints: NotRequired[Dict[str, str]],
    Processing: NotRequired[bool],
    UpgradeProcessing: NotRequired[bool],
    EngineVersion: NotRequired[str],
    EBSOptions: NotRequired[EBSOptionsTypeDef],  # (2)
    AccessPolicies: NotRequired[str],
    SnapshotOptions: NotRequired[SnapshotOptionsTypeDef],  # (3)
    VPCOptions: NotRequired[VPCDerivedInfoTypeDef],  # (4)
    CognitoOptions: NotRequired[CognitoOptionsTypeDef],  # (5)
    EncryptionAtRestOptions: NotRequired[EncryptionAtRestOptionsTypeDef],  # (6)
    NodeToNodeEncryptionOptions: NotRequired[NodeToNodeEncryptionOptionsTypeDef],  # (7)
    AdvancedOptions: NotRequired[Dict[str, str]],
    LogPublishingOptions: NotRequired[Dict[LogTypeType, LogPublishingOptionTypeDef]],  # (8)
    ServiceSoftwareOptions: NotRequired[ServiceSoftwareOptionsTypeDef],  # (9)
    DomainEndpointOptions: NotRequired[DomainEndpointOptionsTypeDef],  # (10)
    AdvancedSecurityOptions: NotRequired[AdvancedSecurityOptionsTypeDef],  # (11)
    AutoTuneOptions: NotRequired[AutoTuneOptionsOutputTypeDef],  # (12)
    ChangeProgressDetails: NotRequired[ChangeProgressDetailsTypeDef],  # (13)
    OffPeakWindowOptions: NotRequired[OffPeakWindowOptionsTypeDef],  # (14)
    SoftwareUpdateOptions: NotRequired[SoftwareUpdateOptionsTypeDef],  # (15)
  1. See ClusterConfigTypeDef
  2. See EBSOptionsTypeDef
  3. See SnapshotOptionsTypeDef
  4. See VPCDerivedInfoTypeDef
  5. See CognitoOptionsTypeDef
  6. See EncryptionAtRestOptionsTypeDef
  7. See NodeToNodeEncryptionOptionsTypeDef
  8. See LogTypeType LogPublishingOptionTypeDef
  9. See ServiceSoftwareOptionsTypeDef
  10. See DomainEndpointOptionsTypeDef
  11. See AdvancedSecurityOptionsTypeDef
  12. See AutoTuneOptionsOutputTypeDef
  13. See ChangeProgressDetailsTypeDef
  14. See OffPeakWindowOptionsTypeDef
  15. See SoftwareUpdateOptionsTypeDef

DescribeInstanceTypeLimitsResponseTypeDef#

# DescribeInstanceTypeLimitsResponseTypeDef usage example

from mypy_boto3_opensearch.type_defs import DescribeInstanceTypeLimitsResponseTypeDef

def get_value() -> DescribeInstanceTypeLimitsResponseTypeDef:
    return {
        "LimitsByRole": ...,
        "ResponseMetadata": ...,
    }
# DescribeInstanceTypeLimitsResponseTypeDef definition

class DescribeInstanceTypeLimitsResponseTypeDef(TypedDict):
    LimitsByRole: Dict[str, LimitsTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See LimitsTypeDef
  2. See ResponseMetadataTypeDef

DomainConfigTypeDef#

# DomainConfigTypeDef usage example

from mypy_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)
    SnapshotOptions: NotRequired[SnapshotOptionsStatusTypeDef],  # (5)
    VPCOptions: NotRequired[VPCDerivedInfoStatusTypeDef],  # (6)
    CognitoOptions: NotRequired[CognitoOptionsStatusTypeDef],  # (7)
    EncryptionAtRestOptions: NotRequired[EncryptionAtRestOptionsStatusTypeDef],  # (8)
    NodeToNodeEncryptionOptions: NotRequired[NodeToNodeEncryptionOptionsStatusTypeDef],  # (9)
    AdvancedOptions: NotRequired[AdvancedOptionsStatusTypeDef],  # (10)
    LogPublishingOptions: NotRequired[LogPublishingOptionsStatusTypeDef],  # (11)
    DomainEndpointOptions: NotRequired[DomainEndpointOptionsStatusTypeDef],  # (12)
    AdvancedSecurityOptions: NotRequired[AdvancedSecurityOptionsStatusTypeDef],  # (13)
    AutoTuneOptions: NotRequired[AutoTuneOptionsStatusTypeDef],  # (14)
    ChangeProgressDetails: NotRequired[ChangeProgressDetailsTypeDef],  # (15)
    OffPeakWindowOptions: NotRequired[OffPeakWindowOptionsStatusTypeDef],  # (16)
    SoftwareUpdateOptions: NotRequired[SoftwareUpdateOptionsStatusTypeDef],  # (17)
  1. See VersionStatusTypeDef
  2. See ClusterConfigStatusTypeDef
  3. See EBSOptionsStatusTypeDef
  4. See AccessPoliciesStatusTypeDef
  5. See SnapshotOptionsStatusTypeDef
  6. See VPCDerivedInfoStatusTypeDef
  7. See CognitoOptionsStatusTypeDef
  8. See EncryptionAtRestOptionsStatusTypeDef
  9. See NodeToNodeEncryptionOptionsStatusTypeDef
  10. See AdvancedOptionsStatusTypeDef
  11. See LogPublishingOptionsStatusTypeDef
  12. See DomainEndpointOptionsStatusTypeDef
  13. See AdvancedSecurityOptionsStatusTypeDef
  14. See