Skip to content

Typed dictionaries

Index > ElasticsearchService > Typed dictionaries

Auto-generated documentation for ElasticsearchService type annotations stubs module mypy-boto3-es.

AcceptInboundCrossClusterSearchConnectionRequestRequestTypeDef

Usage Example
from mypy_boto3_es.type_defs import AcceptInboundCrossClusterSearchConnectionRequestRequestTypeDef

def get_value() -> AcceptInboundCrossClusterSearchConnectionRequestRequestTypeDef:
    return {
        "CrossClusterSearchConnectionId": ...,
    }
Definition
class AcceptInboundCrossClusterSearchConnectionRequestRequestTypeDef(TypedDict):
    CrossClusterSearchConnectionId: str,

ResponseMetadataTypeDef

Usage Example
from mypy_boto3_es.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
Definition
class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

OptionStatusTypeDef

Usage Example
from mypy_boto3_es.type_defs import OptionStatusTypeDef

def get_value() -> OptionStatusTypeDef:
    return {
        "CreationDate": ...,
        "UpdateDate": ...,
        "State": ...,
    }
Definition
class OptionStatusTypeDef(TypedDict):
    CreationDate: datetime,
    UpdateDate: datetime,
    State: OptionStateType,  # (1)
    UpdateVersion: NotRequired[int],
    PendingDeletion: NotRequired[bool],
  1. See OptionStateType

TagTypeDef

Usage Example
from mypy_boto3_es.type_defs import TagTypeDef

def get_value() -> TagTypeDef:
    return {
        "Key": ...,
        "Value": ...,
    }
Definition
class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

AdditionalLimitTypeDef

Usage Example
from mypy_boto3_es.type_defs import AdditionalLimitTypeDef

def get_value() -> AdditionalLimitTypeDef:
    return {
        "LimitName": ...,
    }
Definition
class AdditionalLimitTypeDef(TypedDict):
    LimitName: NotRequired[str],
    LimitValues: NotRequired[List[str]],

MasterUserOptionsTypeDef

Usage Example
from mypy_boto3_es.type_defs import MasterUserOptionsTypeDef

def get_value() -> MasterUserOptionsTypeDef:
    return {
        "MasterUserARN": ...,
    }
Definition
class MasterUserOptionsTypeDef(TypedDict):
    MasterUserARN: NotRequired[str],
    MasterUserName: NotRequired[str],
    MasterUserPassword: NotRequired[str],

AssociatePackageRequestRequestTypeDef

Usage Example
from mypy_boto3_es.type_defs import AssociatePackageRequestRequestTypeDef

def get_value() -> AssociatePackageRequestRequestTypeDef:
    return {
        "PackageID": ...,
        "DomainName": ...,
    }
Definition
class AssociatePackageRequestRequestTypeDef(TypedDict):
    PackageID: str,
    DomainName: str,

ScheduledAutoTuneDetailsTypeDef

Usage Example
from mypy_boto3_es.type_defs import ScheduledAutoTuneDetailsTypeDef

def get_value() -> ScheduledAutoTuneDetailsTypeDef:
    return {
        "Date": ...,
    }
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

Usage Example
from mypy_boto3_es.type_defs import DurationTypeDef

def get_value() -> DurationTypeDef:
    return {
        "Value": ...,
    }
Definition
class DurationTypeDef(TypedDict):
    Value: NotRequired[int],
    Unit: NotRequired[TimeUnitType],  # (1)
  1. See TimeUnitType

AutoTuneOptionsOutputTypeDef

Usage Example
from mypy_boto3_es.type_defs import AutoTuneOptionsOutputTypeDef

def get_value() -> AutoTuneOptionsOutputTypeDef:
    return {
        "State": ...,
    }
Definition
class AutoTuneOptionsOutputTypeDef(TypedDict):
    State: NotRequired[AutoTuneStateType],  # (1)
    ErrorMessage: NotRequired[str],
  1. See AutoTuneStateType

AutoTuneStatusTypeDef

Usage Example
from mypy_boto3_es.type_defs import AutoTuneStatusTypeDef

def get_value() -> AutoTuneStatusTypeDef:
    return {
        "CreationDate": ...,
        "UpdateDate": ...,
        "State": ...,
    }
Definition
class AutoTuneStatusTypeDef(TypedDict):
    CreationDate: datetime,
    UpdateDate: datetime,
    State: AutoTuneStateType,  # (1)
    UpdateVersion: NotRequired[int],
    ErrorMessage: NotRequired[str],
    PendingDeletion: NotRequired[bool],
  1. See AutoTuneStateType

CancelElasticsearchServiceSoftwareUpdateRequestRequestTypeDef

Usage Example
from mypy_boto3_es.type_defs import CancelElasticsearchServiceSoftwareUpdateRequestRequestTypeDef

def get_value() -> CancelElasticsearchServiceSoftwareUpdateRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
Definition
class CancelElasticsearchServiceSoftwareUpdateRequestRequestTypeDef(TypedDict):
    DomainName: str,

ServiceSoftwareOptionsTypeDef

Usage Example
from mypy_boto3_es.type_defs import ServiceSoftwareOptionsTypeDef

def get_value() -> ServiceSoftwareOptionsTypeDef:
    return {
        "CurrentVersion": ...,
    }
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

Usage Example
from mypy_boto3_es.type_defs import ChangeProgressDetailsTypeDef

def get_value() -> ChangeProgressDetailsTypeDef:
    return {
        "ChangeId": ...,
    }
Definition
class ChangeProgressDetailsTypeDef(TypedDict):
    ChangeId: NotRequired[str],
    Message: NotRequired[str],

ChangeProgressStageTypeDef

Usage Example
from mypy_boto3_es.type_defs import ChangeProgressStageTypeDef

def get_value() -> ChangeProgressStageTypeDef:
    return {
        "Name": ...,
    }
Definition
class ChangeProgressStageTypeDef(TypedDict):
    Name: NotRequired[str],
    Status: NotRequired[str],
    Description: NotRequired[str],
    LastUpdated: NotRequired[datetime],

CognitoOptionsTypeDef

Usage Example
from mypy_boto3_es.type_defs import CognitoOptionsTypeDef

def get_value() -> CognitoOptionsTypeDef:
    return {
        "Enabled": ...,
    }
Definition
class CognitoOptionsTypeDef(TypedDict):
    Enabled: NotRequired[bool],
    UserPoolId: NotRequired[str],
    IdentityPoolId: NotRequired[str],
    RoleArn: NotRequired[str],

ColdStorageOptionsTypeDef

Usage Example
from mypy_boto3_es.type_defs import ColdStorageOptionsTypeDef

def get_value() -> ColdStorageOptionsTypeDef:
    return {
        "Enabled": ...,
    }
Definition
class ColdStorageOptionsTypeDef(TypedDict):
    Enabled: bool,

CompatibleVersionsMapTypeDef

Usage Example
from mypy_boto3_es.type_defs import CompatibleVersionsMapTypeDef

def get_value() -> CompatibleVersionsMapTypeDef:
    return {
        "SourceVersion": ...,
    }
Definition
class CompatibleVersionsMapTypeDef(TypedDict):
    SourceVersion: NotRequired[str],
    TargetVersions: NotRequired[List[str]],

DomainEndpointOptionsTypeDef

Usage Example
from mypy_boto3_es.type_defs import DomainEndpointOptionsTypeDef

def get_value() -> DomainEndpointOptionsTypeDef:
    return {
        "EnforceHTTPS": ...,
    }
Definition
class DomainEndpointOptionsTypeDef(TypedDict):
    EnforceHTTPS: NotRequired[bool],
    TLSSecurityPolicy: NotRequired[TLSSecurityPolicyType],  # (1)
    CustomEndpointEnabled: NotRequired[bool],
    CustomEndpoint: NotRequired[str],
    CustomEndpointCertificateArn: NotRequired[str],
  1. See TLSSecurityPolicyType

EBSOptionsTypeDef

Usage Example
from mypy_boto3_es.type_defs import EBSOptionsTypeDef

def get_value() -> EBSOptionsTypeDef:
    return {
        "EBSEnabled": ...,
    }
Definition
class EBSOptionsTypeDef(TypedDict):
    EBSEnabled: NotRequired[bool],
    VolumeType: NotRequired[VolumeTypeType],  # (1)
    VolumeSize: NotRequired[int],
    Iops: NotRequired[int],
    Throughput: NotRequired[int],
  1. See VolumeTypeType

EncryptionAtRestOptionsTypeDef

Usage Example
from mypy_boto3_es.type_defs import EncryptionAtRestOptionsTypeDef

def get_value() -> EncryptionAtRestOptionsTypeDef:
    return {
        "Enabled": ...,
    }
Definition
class EncryptionAtRestOptionsTypeDef(TypedDict):
    Enabled: NotRequired[bool],
    KmsKeyId: NotRequired[str],

LogPublishingOptionTypeDef

Usage Example
from mypy_boto3_es.type_defs import LogPublishingOptionTypeDef

def get_value() -> LogPublishingOptionTypeDef:
    return {
        "CloudWatchLogsLogGroupArn": ...,
    }
Definition
class LogPublishingOptionTypeDef(TypedDict):
    CloudWatchLogsLogGroupArn: NotRequired[str],
    Enabled: NotRequired[bool],

NodeToNodeEncryptionOptionsTypeDef

Usage Example
from mypy_boto3_es.type_defs import NodeToNodeEncryptionOptionsTypeDef

def get_value() -> NodeToNodeEncryptionOptionsTypeDef:
    return {
        "Enabled": ...,
    }
Definition
class NodeToNodeEncryptionOptionsTypeDef(TypedDict):
    Enabled: NotRequired[bool],

SnapshotOptionsTypeDef

Usage Example
from mypy_boto3_es.type_defs import SnapshotOptionsTypeDef

def get_value() -> SnapshotOptionsTypeDef:
    return {
        "AutomatedSnapshotStartHour": ...,
    }
Definition
class SnapshotOptionsTypeDef(TypedDict):
    AutomatedSnapshotStartHour: NotRequired[int],

VPCOptionsTypeDef

Usage Example
from mypy_boto3_es.type_defs import VPCOptionsTypeDef

def get_value() -> VPCOptionsTypeDef:
    return {
        "SubnetIds": ...,
    }
Definition
class VPCOptionsTypeDef(TypedDict):
    SubnetIds: NotRequired[Sequence[str]],
    SecurityGroupIds: NotRequired[Sequence[str]],

DomainInformationTypeDef

Usage Example
from mypy_boto3_es.type_defs import DomainInformationTypeDef

def get_value() -> DomainInformationTypeDef:
    return {
        "DomainName": ...,
    }
Definition
class DomainInformationTypeDef(TypedDict):
    DomainName: str,
    OwnerId: NotRequired[str],
    Region: NotRequired[str],

OutboundCrossClusterSearchConnectionStatusTypeDef

Usage Example
from mypy_boto3_es.type_defs import OutboundCrossClusterSearchConnectionStatusTypeDef

def get_value() -> OutboundCrossClusterSearchConnectionStatusTypeDef:
    return {
        "StatusCode": ...,
    }
Definition
class OutboundCrossClusterSearchConnectionStatusTypeDef(TypedDict):
    StatusCode: NotRequired[OutboundCrossClusterSearchConnectionStatusCodeType],  # (1)
    Message: NotRequired[str],
  1. See OutboundCrossClusterSearchConnectionStatusCodeType

PackageSourceTypeDef

Usage Example
from mypy_boto3_es.type_defs import PackageSourceTypeDef

def get_value() -> PackageSourceTypeDef:
    return {
        "S3BucketName": ...,
    }
Definition
class PackageSourceTypeDef(TypedDict):
    S3BucketName: NotRequired[str],
    S3Key: NotRequired[str],

DeleteElasticsearchDomainRequestRequestTypeDef

Usage Example
from mypy_boto3_es.type_defs import DeleteElasticsearchDomainRequestRequestTypeDef

def get_value() -> DeleteElasticsearchDomainRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
Definition
class DeleteElasticsearchDomainRequestRequestTypeDef(TypedDict):
    DomainName: str,

DeleteInboundCrossClusterSearchConnectionRequestRequestTypeDef

Usage Example
from mypy_boto3_es.type_defs import DeleteInboundCrossClusterSearchConnectionRequestRequestTypeDef

def get_value() -> DeleteInboundCrossClusterSearchConnectionRequestRequestTypeDef:
    return {
        "CrossClusterSearchConnectionId": ...,
    }
Definition
class DeleteInboundCrossClusterSearchConnectionRequestRequestTypeDef(TypedDict):
    CrossClusterSearchConnectionId: str,

DeleteOutboundCrossClusterSearchConnectionRequestRequestTypeDef

Usage Example
from mypy_boto3_es.type_defs import DeleteOutboundCrossClusterSearchConnectionRequestRequestTypeDef

def get_value() -> DeleteOutboundCrossClusterSearchConnectionRequestRequestTypeDef:
    return {
        "CrossClusterSearchConnectionId": ...,
    }
Definition
class DeleteOutboundCrossClusterSearchConnectionRequestRequestTypeDef(TypedDict):
    CrossClusterSearchConnectionId: str,

DeletePackageRequestRequestTypeDef

Usage Example
from mypy_boto3_es.type_defs import DeletePackageRequestRequestTypeDef

def get_value() -> DeletePackageRequestRequestTypeDef:
    return {
        "PackageID": ...,
    }
Definition
class DeletePackageRequestRequestTypeDef(TypedDict):
    PackageID: str,

DescribeDomainAutoTunesRequestRequestTypeDef

Usage Example
from mypy_boto3_es.type_defs import DescribeDomainAutoTunesRequestRequestTypeDef

def get_value() -> DescribeDomainAutoTunesRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
Definition
class DescribeDomainAutoTunesRequestRequestTypeDef(TypedDict):
    DomainName: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

DescribeDomainChangeProgressRequestRequestTypeDef

Usage Example
from mypy_boto3_es.type_defs import DescribeDomainChangeProgressRequestRequestTypeDef

def get_value() -> DescribeDomainChangeProgressRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
Definition
class DescribeDomainChangeProgressRequestRequestTypeDef(TypedDict):
    DomainName: str,
    ChangeId: NotRequired[str],

DescribeElasticsearchDomainConfigRequestRequestTypeDef

Usage Example
from mypy_boto3_es.type_defs import DescribeElasticsearchDomainConfigRequestRequestTypeDef

def get_value() -> DescribeElasticsearchDomainConfigRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
Definition
class DescribeElasticsearchDomainConfigRequestRequestTypeDef(TypedDict):
    DomainName: str,

DescribeElasticsearchDomainRequestRequestTypeDef

Usage Example
from mypy_boto3_es.type_defs import DescribeElasticsearchDomainRequestRequestTypeDef

def get_value() -> DescribeElasticsearchDomainRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
Definition
class DescribeElasticsearchDomainRequestRequestTypeDef(TypedDict):
    DomainName: str,

DescribeElasticsearchDomainsRequestRequestTypeDef

Usage Example
from mypy_boto3_es.type_defs import DescribeElasticsearchDomainsRequestRequestTypeDef

def get_value() -> DescribeElasticsearchDomainsRequestRequestTypeDef:
    return {
        "DomainNames": ...,
    }
Definition
class DescribeElasticsearchDomainsRequestRequestTypeDef(TypedDict):
    DomainNames: Sequence[str],

DescribeElasticsearchInstanceTypeLimitsRequestRequestTypeDef

Usage Example
from mypy_boto3_es.type_defs import DescribeElasticsearchInstanceTypeLimitsRequestRequestTypeDef

def get_value() -> DescribeElasticsearchInstanceTypeLimitsRequestRequestTypeDef:
    return {
        "InstanceType": ...,
        "ElasticsearchVersion": ...,
    }
Definition
class DescribeElasticsearchInstanceTypeLimitsRequestRequestTypeDef(TypedDict):
    InstanceType: ESPartitionInstanceTypeType,  # (1)
    ElasticsearchVersion: str,
    DomainName: NotRequired[str],
  1. See ESPartitionInstanceTypeType

FilterTypeDef

Usage Example
from mypy_boto3_es.type_defs import FilterTypeDef

def get_value() -> FilterTypeDef:
    return {
        "Name": ...,
    }
Definition
class FilterTypeDef(TypedDict):
    Name: NotRequired[str],
    Values: NotRequired[Sequence[str]],

DescribePackagesFilterTypeDef

Usage Example
from mypy_boto3_es.type_defs import DescribePackagesFilterTypeDef

def get_value() -> DescribePackagesFilterTypeDef:
    return {
        "Name": ...,
    }
Definition
class DescribePackagesFilterTypeDef(TypedDict):
    Name: NotRequired[DescribePackagesFilterNameType],  # (1)
    Value: NotRequired[Sequence[str]],
  1. See DescribePackagesFilterNameType

PaginatorConfigTypeDef

Usage Example
from mypy_boto3_es.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }
Definition
class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

DescribeReservedElasticsearchInstanceOfferingsRequestRequestTypeDef

Usage Example
from mypy_boto3_es.type_defs import DescribeReservedElasticsearchInstanceOfferingsRequestRequestTypeDef

def get_value() -> DescribeReservedElasticsearchInstanceOfferingsRequestRequestTypeDef:
    return {
        "ReservedElasticsearchInstanceOfferingId": ...,
    }
Definition
class DescribeReservedElasticsearchInstanceOfferingsRequestRequestTypeDef(TypedDict):
    ReservedElasticsearchInstanceOfferingId: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

DescribeReservedElasticsearchInstancesRequestRequestTypeDef

Usage Example
from mypy_boto3_es.type_defs import DescribeReservedElasticsearchInstancesRequestRequestTypeDef

def get_value() -> DescribeReservedElasticsearchInstancesRequestRequestTypeDef:
    return {
        "ReservedElasticsearchInstanceId": ...,
    }
Definition
class DescribeReservedElasticsearchInstancesRequestRequestTypeDef(TypedDict):
    ReservedElasticsearchInstanceId: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

DissociatePackageRequestRequestTypeDef

Usage Example
from mypy_boto3_es.type_defs import DissociatePackageRequestRequestTypeDef

def get_value() -> DissociatePackageRequestRequestTypeDef:
    return {
        "PackageID": ...,
        "DomainName": ...,
    }
Definition
class DissociatePackageRequestRequestTypeDef(TypedDict):
    PackageID: str,
    DomainName: str,

DomainInfoTypeDef

Usage Example
from mypy_boto3_es.type_defs import DomainInfoTypeDef

def get_value() -> DomainInfoTypeDef:
    return {
        "DomainName": ...,
    }
Definition
class DomainInfoTypeDef(TypedDict):
    DomainName: NotRequired[str],
    EngineType: NotRequired[EngineTypeType],  # (1)
  1. See EngineTypeType

ErrorDetailsTypeDef

Usage Example
from mypy_boto3_es.type_defs import ErrorDetailsTypeDef

def get_value() -> ErrorDetailsTypeDef:
    return {
        "ErrorType": ...,
    }
Definition
class ErrorDetailsTypeDef(TypedDict):
    ErrorType: NotRequired[str],
    ErrorMessage: NotRequired[str],

DryRunResultsTypeDef

Usage Example
from mypy_boto3_es.type_defs import DryRunResultsTypeDef

def get_value() -> DryRunResultsTypeDef:
    return {
        "DeploymentType": ...,
    }
Definition
class DryRunResultsTypeDef(TypedDict):
    DeploymentType: NotRequired[str],
    Message: NotRequired[str],

ZoneAwarenessConfigTypeDef

Usage Example
from mypy_boto3_es.type_defs import ZoneAwarenessConfigTypeDef

def get_value() -> ZoneAwarenessConfigTypeDef:
    return {
        "AvailabilityZoneCount": ...,
    }
Definition
class ZoneAwarenessConfigTypeDef(TypedDict):
    AvailabilityZoneCount: NotRequired[int],

VPCDerivedInfoTypeDef

Usage Example
from mypy_boto3_es.type_defs import VPCDerivedInfoTypeDef

def get_value() -> VPCDerivedInfoTypeDef:
    return {
        "VPCId": ...,
    }
Definition
class VPCDerivedInfoTypeDef(TypedDict):
    VPCId: NotRequired[str],
    SubnetIds: NotRequired[List[str]],
    AvailabilityZones: NotRequired[List[str]],
    SecurityGroupIds: NotRequired[List[str]],

GetCompatibleElasticsearchVersionsRequestRequestTypeDef

Usage Example
from mypy_boto3_es.type_defs import GetCompatibleElasticsearchVersionsRequestRequestTypeDef

def get_value() -> GetCompatibleElasticsearchVersionsRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
Definition
class GetCompatibleElasticsearchVersionsRequestRequestTypeDef(TypedDict):
    DomainName: NotRequired[str],

GetPackageVersionHistoryRequestRequestTypeDef

Usage Example
from mypy_boto3_es.type_defs import GetPackageVersionHistoryRequestRequestTypeDef

def get_value() -> GetPackageVersionHistoryRequestRequestTypeDef:
    return {
        "PackageID": ...,
    }
Definition
class GetPackageVersionHistoryRequestRequestTypeDef(TypedDict):
    PackageID: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

PackageVersionHistoryTypeDef

Usage Example
from mypy_boto3_es.type_defs import PackageVersionHistoryTypeDef

def get_value() -> PackageVersionHistoryTypeDef:
    return {
        "PackageVersion": ...,
    }
Definition
class PackageVersionHistoryTypeDef(TypedDict):
    PackageVersion: NotRequired[str],
    CommitMessage: NotRequired[str],
    CreatedAt: NotRequired[datetime],

GetUpgradeHistoryRequestRequestTypeDef

Usage Example
from mypy_boto3_es.type_defs import GetUpgradeHistoryRequestRequestTypeDef

def get_value() -> GetUpgradeHistoryRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
Definition
class GetUpgradeHistoryRequestRequestTypeDef(TypedDict):
    DomainName: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

GetUpgradeStatusRequestRequestTypeDef

Usage Example
from mypy_boto3_es.type_defs import GetUpgradeStatusRequestRequestTypeDef

def get_value() -> GetUpgradeStatusRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
Definition
class GetUpgradeStatusRequestRequestTypeDef(TypedDict):
    DomainName: str,

InboundCrossClusterSearchConnectionStatusTypeDef

Usage Example
from mypy_boto3_es.type_defs import InboundCrossClusterSearchConnectionStatusTypeDef

def get_value() -> InboundCrossClusterSearchConnectionStatusTypeDef:
    return {
        "StatusCode": ...,
    }
Definition
class InboundCrossClusterSearchConnectionStatusTypeDef(TypedDict):
    StatusCode: NotRequired[InboundCrossClusterSearchConnectionStatusCodeType],  # (1)
    Message: NotRequired[str],
  1. See InboundCrossClusterSearchConnectionStatusCodeType

InstanceCountLimitsTypeDef

Usage Example
from mypy_boto3_es.type_defs import InstanceCountLimitsTypeDef

def get_value() -> InstanceCountLimitsTypeDef:
    return {
        "MinimumInstanceCount": ...,
    }
Definition
class InstanceCountLimitsTypeDef(TypedDict):
    MinimumInstanceCount: NotRequired[int],
    MaximumInstanceCount: NotRequired[int],

ListDomainNamesRequestRequestTypeDef

Usage Example
from mypy_boto3_es.type_defs import ListDomainNamesRequestRequestTypeDef

def get_value() -> ListDomainNamesRequestRequestTypeDef:
    return {
        "EngineType": ...,
    }
Definition
class ListDomainNamesRequestRequestTypeDef(TypedDict):
    EngineType: NotRequired[EngineTypeType],  # (1)
  1. See EngineTypeType

ListDomainsForPackageRequestRequestTypeDef

Usage Example
from mypy_boto3_es.type_defs import ListDomainsForPackageRequestRequestTypeDef

def get_value() -> ListDomainsForPackageRequestRequestTypeDef:
    return {
        "PackageID": ...,
    }
Definition
class ListDomainsForPackageRequestRequestTypeDef(TypedDict):
    PackageID: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListElasticsearchInstanceTypesRequestRequestTypeDef

Usage Example
from mypy_boto3_es.type_defs import ListElasticsearchInstanceTypesRequestRequestTypeDef

def get_value() -> ListElasticsearchInstanceTypesRequestRequestTypeDef:
    return {
        "ElasticsearchVersion": ...,
    }
Definition
class ListElasticsearchInstanceTypesRequestRequestTypeDef(TypedDict):
    ElasticsearchVersion: str,
    DomainName: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListElasticsearchVersionsRequestRequestTypeDef

Usage Example
from mypy_boto3_es.type_defs import ListElasticsearchVersionsRequestRequestTypeDef

def get_value() -> ListElasticsearchVersionsRequestRequestTypeDef:
    return {
        "MaxResults": ...,
    }
Definition
class ListElasticsearchVersionsRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListPackagesForDomainRequestRequestTypeDef

Usage Example
from mypy_boto3_es.type_defs import ListPackagesForDomainRequestRequestTypeDef

def get_value() -> ListPackagesForDomainRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
Definition
class ListPackagesForDomainRequestRequestTypeDef(TypedDict):
    DomainName: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListTagsRequestRequestTypeDef

Usage Example
from mypy_boto3_es.type_defs import ListTagsRequestRequestTypeDef

def get_value() -> ListTagsRequestRequestTypeDef:
    return {
        "ARN": ...,
    }
Definition
class ListTagsRequestRequestTypeDef(TypedDict):
    ARN: str,

PurchaseReservedElasticsearchInstanceOfferingRequestRequestTypeDef

Usage Example
from mypy_boto3_es.type_defs import PurchaseReservedElasticsearchInstanceOfferingRequestRequestTypeDef

def get_value() -> PurchaseReservedElasticsearchInstanceOfferingRequestRequestTypeDef:
    return {
        "ReservedElasticsearchInstanceOfferingId": ...,
        "ReservationName": ...,
    }
Definition
class PurchaseReservedElasticsearchInstanceOfferingRequestRequestTypeDef(TypedDict):
    ReservedElasticsearchInstanceOfferingId: str,
    ReservationName: str,
    InstanceCount: NotRequired[int],

RecurringChargeTypeDef

Usage Example
from mypy_boto3_es.type_defs import RecurringChargeTypeDef

def get_value() -> RecurringChargeTypeDef:
    return {
        "RecurringChargeAmount": ...,
    }
Definition
class RecurringChargeTypeDef(TypedDict):
    RecurringChargeAmount: NotRequired[float],
    RecurringChargeFrequency: NotRequired[str],

RejectInboundCrossClusterSearchConnectionRequestRequestTypeDef

Usage Example
from mypy_boto3_es.type_defs import RejectInboundCrossClusterSearchConnectionRequestRequestTypeDef

def get_value() -> RejectInboundCrossClusterSearchConnectionRequestRequestTypeDef:
    return {
        "CrossClusterSearchConnectionId": ...,
    }
Definition
class RejectInboundCrossClusterSearchConnectionRequestRequestTypeDef(TypedDict):
    CrossClusterSearchConnectionId: str,

RemoveTagsRequestRequestTypeDef

Usage Example
from mypy_boto3_es.type_defs import RemoveTagsRequestRequestTypeDef

def get_value() -> RemoveTagsRequestRequestTypeDef:
    return {
        "ARN": ...,
        "TagKeys": ...,
    }
Definition
class RemoveTagsRequestRequestTypeDef(TypedDict):
    ARN: str,
    TagKeys: Sequence[str],

SAMLIdpTypeDef

Usage Example
from mypy_boto3_es.type_defs import SAMLIdpTypeDef

def get_value() -> SAMLIdpTypeDef:
    return {
        "MetadataContent": ...,
        "EntityId": ...,
    }
Definition
class SAMLIdpTypeDef(TypedDict):
    MetadataContent: str,
    EntityId: str,

StartElasticsearchServiceSoftwareUpdateRequestRequestTypeDef

Usage Example
from mypy_boto3_es.type_defs import StartElasticsearchServiceSoftwareUpdateRequestRequestTypeDef

def get_value() -> StartElasticsearchServiceSoftwareUpdateRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
Definition
class StartElasticsearchServiceSoftwareUpdateRequestRequestTypeDef(TypedDict):
    DomainName: str,

StorageTypeLimitTypeDef

Usage Example
from mypy_boto3_es.type_defs import StorageTypeLimitTypeDef

def get_value() -> StorageTypeLimitTypeDef:
    return {
        "LimitName": ...,
    }
Definition
class StorageTypeLimitTypeDef(TypedDict):
    LimitName: NotRequired[str],
    LimitValues: NotRequired[List[str]],

UpgradeElasticsearchDomainRequestRequestTypeDef

Usage Example
from mypy_boto3_es.type_defs import UpgradeElasticsearchDomainRequestRequestTypeDef

def get_value() -> UpgradeElasticsearchDomainRequestRequestTypeDef:
    return {
        "DomainName": ...,
        "TargetVersion": ...,
    }
Definition
class UpgradeElasticsearchDomainRequestRequestTypeDef(TypedDict):
    DomainName: str,
    TargetVersion: str,
    PerformCheckOnly: NotRequired[bool],

UpgradeStepItemTypeDef

Usage Example
from mypy_boto3_es.type_defs import UpgradeStepItemTypeDef

def get_value() -> UpgradeStepItemTypeDef:
    return {
        "UpgradeStep": ...,
    }
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

EmptyResponseMetadataTypeDef

Usage Example
from mypy_boto3_es.type_defs import EmptyResponseMetadataTypeDef

def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }
Definition
class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetUpgradeStatusResponseTypeDef

Usage Example
from mypy_boto3_es.type_defs import GetUpgradeStatusResponseTypeDef

def get_value() -> GetUpgradeStatusResponseTypeDef:
    return {
        "UpgradeStep": ...,
        "StepStatus": ...,
        "UpgradeName": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetUpgradeStatusResponseTypeDef(TypedDict):
    UpgradeStep: UpgradeStepType,  # (1)
    StepStatus: UpgradeStatusType,  # (2)
    UpgradeName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See UpgradeStepType
  2. See UpgradeStatusType
  3. See ResponseMetadataTypeDef

ListElasticsearchInstanceTypesResponseTypeDef

Usage Example
from mypy_boto3_es.type_defs import ListElasticsearchInstanceTypesResponseTypeDef

def get_value() -> ListElasticsearchInstanceTypesResponseTypeDef:
    return {
        "ElasticsearchInstanceTypes": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListElasticsearchInstanceTypesResponseTypeDef(TypedDict):
    ElasticsearchInstanceTypes: List[ESPartitionInstanceTypeType],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ESPartitionInstanceTypeType
  2. See ResponseMetadataTypeDef

ListElasticsearchVersionsResponseTypeDef

Usage Example
from mypy_boto3_es.type_defs import ListElasticsearchVersionsResponseTypeDef

def get_value() -> ListElasticsearchVersionsResponseTypeDef:
    return {
        "ElasticsearchVersions": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListElasticsearchVersionsResponseTypeDef(TypedDict):
    ElasticsearchVersions: List[str],
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

PurchaseReservedElasticsearchInstanceOfferingResponseTypeDef

Usage Example
from mypy_boto3_es.type_defs import PurchaseReservedElasticsearchInstanceOfferingResponseTypeDef

def get_value() -> PurchaseReservedElasticsearchInstanceOfferingResponseTypeDef:
    return {
        "ReservedElasticsearchInstanceId": ...,
        "ReservationName": ...,
        "ResponseMetadata": ...,
    }
Definition
class PurchaseReservedElasticsearchInstanceOfferingResponseTypeDef(TypedDict):
    ReservedElasticsearchInstanceId: str,
    ReservationName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

AccessPoliciesStatusTypeDef

Usage Example
from mypy_boto3_es.type_defs import AccessPoliciesStatusTypeDef

def get_value() -> AccessPoliciesStatusTypeDef:
    return {
        "Options": ...,
        "Status": ...,
    }
Definition
class AccessPoliciesStatusTypeDef(TypedDict):
    Options: str,
    Status: OptionStatusTypeDef,  # (1)
  1. See OptionStatusTypeDef

AdvancedOptionsStatusTypeDef

Usage Example
from mypy_boto3_es.type_defs import AdvancedOptionsStatusTypeDef

def get_value() -> AdvancedOptionsStatusTypeDef:
    return {
        "Options": ...,
        "Status": ...,
    }
Definition
class AdvancedOptionsStatusTypeDef(TypedDict):
    Options: Dict[str, str],
    Status: OptionStatusTypeDef,  # (1)
  1. See OptionStatusTypeDef

ElasticsearchVersionStatusTypeDef

Usage Example
from mypy_boto3_es.type_defs import ElasticsearchVersionStatusTypeDef

def get_value() -> ElasticsearchVersionStatusTypeDef:
    return {
        "Options": ...,
        "Status": ...,
    }
Definition
class ElasticsearchVersionStatusTypeDef(TypedDict):
    Options: str,
    Status: OptionStatusTypeDef,  # (1)
  1. See OptionStatusTypeDef

AddTagsRequestRequestTypeDef

Usage Example
from mypy_boto3_es.type_defs import AddTagsRequestRequestTypeDef

def get_value() -> AddTagsRequestRequestTypeDef:
    return {
        "ARN": ...,
        "TagList": ...,
    }
Definition
class AddTagsRequestRequestTypeDef(TypedDict):
    ARN: str,
    TagList: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

ListTagsResponseTypeDef

Usage Example
from mypy_boto3_es.type_defs import ListTagsResponseTypeDef

def get_value() -> ListTagsResponseTypeDef:
    return {
        "TagList": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListTagsResponseTypeDef(TypedDict):
    TagList: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

AutoTuneDetailsTypeDef

Usage Example
from mypy_boto3_es.type_defs import AutoTuneDetailsTypeDef

def get_value() -> AutoTuneDetailsTypeDef:
    return {
        "ScheduledAutoTuneDetails": ...,
    }
Definition
class AutoTuneDetailsTypeDef(TypedDict):
    ScheduledAutoTuneDetails: NotRequired[ScheduledAutoTuneDetailsTypeDef],  # (1)
  1. See ScheduledAutoTuneDetailsTypeDef

AutoTuneMaintenanceScheduleTypeDef

Usage Example
from mypy_boto3_es.type_defs import AutoTuneMaintenanceScheduleTypeDef

def get_value() -> AutoTuneMaintenanceScheduleTypeDef:
    return {
        "StartAt": ...,
    }
Definition
class AutoTuneMaintenanceScheduleTypeDef(TypedDict):
    StartAt: NotRequired[Union[datetime, str]],
    Duration: NotRequired[DurationTypeDef],  # (1)
    CronExpressionForRecurrence: NotRequired[str],
  1. See DurationTypeDef

CancelElasticsearchServiceSoftwareUpdateResponseTypeDef

Usage Example
from mypy_boto3_es.type_defs import CancelElasticsearchServiceSoftwareUpdateResponseTypeDef

def get_value() -> CancelElasticsearchServiceSoftwareUpdateResponseTypeDef:
    return {
        "ServiceSoftwareOptions": ...,
        "ResponseMetadata": ...,
    }
Definition
class CancelElasticsearchServiceSoftwareUpdateResponseTypeDef(TypedDict):
    ServiceSoftwareOptions: ServiceSoftwareOptionsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ServiceSoftwareOptionsTypeDef
  2. See ResponseMetadataTypeDef

StartElasticsearchServiceSoftwareUpdateResponseTypeDef

Usage Example
from mypy_boto3_es.type_defs import StartElasticsearchServiceSoftwareUpdateResponseTypeDef

def get_value() -> StartElasticsearchServiceSoftwareUpdateResponseTypeDef:
    return {
        "ServiceSoftwareOptions": ...,
        "ResponseMetadata": ...,
    }
Definition
class StartElasticsearchServiceSoftwareUpdateResponseTypeDef(TypedDict):
    ServiceSoftwareOptions: ServiceSoftwareOptionsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ServiceSoftwareOptionsTypeDef
  2. See ResponseMetadataTypeDef

UpgradeElasticsearchDomainResponseTypeDef

Usage Example
from mypy_boto3_es.type_defs import UpgradeElasticsearchDomainResponseTypeDef

def get_value() -> UpgradeElasticsearchDomainResponseTypeDef:
    return {
        "DomainName": ...,
        "TargetVersion": ...,
        "PerformCheckOnly": ...,
        "ChangeProgressDetails": ...,
        "ResponseMetadata": ...,
    }
Definition
class UpgradeElasticsearchDomainResponseTypeDef(TypedDict):
    DomainName: str,
    TargetVersion: str,
    PerformCheckOnly: bool,
    ChangeProgressDetails: ChangeProgressDetailsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ChangeProgressDetailsTypeDef
  2. See ResponseMetadataTypeDef

ChangeProgressStatusDetailsTypeDef

Usage Example
from mypy_boto3_es.type_defs import ChangeProgressStatusDetailsTypeDef

def get_value() -> ChangeProgressStatusDetailsTypeDef:
    return {
        "ChangeId": ...,
    }
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

CognitoOptionsStatusTypeDef

Usage Example
from mypy_boto3_es.type_defs import CognitoOptionsStatusTypeDef

def get_value() -> CognitoOptionsStatusTypeDef:
    return {
        "Options": ...,
        "Status": ...,
    }
Definition
class CognitoOptionsStatusTypeDef(TypedDict):
    Options: CognitoOptionsTypeDef,  # (1)
    Status: OptionStatusTypeDef,  # (2)
  1. See CognitoOptionsTypeDef
  2. See OptionStatusTypeDef

GetCompatibleElasticsearchVersionsResponseTypeDef

Usage Example
from mypy_boto3_es.type_defs import GetCompatibleElasticsearchVersionsResponseTypeDef

def get_value() -> GetCompatibleElasticsearchVersionsResponseTypeDef:
    return {
        "CompatibleElasticsearchVersions": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetCompatibleElasticsearchVersionsResponseTypeDef(TypedDict):
    CompatibleElasticsearchVersions: List[CompatibleVersionsMapTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CompatibleVersionsMapTypeDef
  2. See ResponseMetadataTypeDef

DomainEndpointOptionsStatusTypeDef

Usage Example
from mypy_boto3_es.type_defs import DomainEndpointOptionsStatusTypeDef

def get_value() -> DomainEndpointOptionsStatusTypeDef:
    return {
        "Options": ...,
        "Status": ...,
    }
Definition
class DomainEndpointOptionsStatusTypeDef(TypedDict):
    Options: DomainEndpointOptionsTypeDef,  # (1)
    Status: OptionStatusTypeDef,  # (2)
  1. See DomainEndpointOptionsTypeDef
  2. See OptionStatusTypeDef

EBSOptionsStatusTypeDef

Usage Example
from mypy_boto3_es.type_defs import EBSOptionsStatusTypeDef

def get_value() -> EBSOptionsStatusTypeDef:
    return {
        "Options": ...,
        "Status": ...,
    }
Definition
class EBSOptionsStatusTypeDef(TypedDict):
    Options: EBSOptionsTypeDef,  # (1)
    Status: OptionStatusTypeDef,  # (2)
  1. See EBSOptionsTypeDef
  2. See OptionStatusTypeDef

EncryptionAtRestOptionsStatusTypeDef

Usage Example
from mypy_boto3_es.type_defs import EncryptionAtRestOptionsStatusTypeDef

def get_value() -> EncryptionAtRestOptionsStatusTypeDef:
    return {
        "Options": ...,
        "Status": ...,
    }
Definition
class EncryptionAtRestOptionsStatusTypeDef(TypedDict):
    Options: EncryptionAtRestOptionsTypeDef,  # (1)
    Status: OptionStatusTypeDef,  # (2)
  1. See EncryptionAtRestOptionsTypeDef
  2. See OptionStatusTypeDef

LogPublishingOptionsStatusTypeDef

Usage Example
from mypy_boto3_es.type_defs import LogPublishingOptionsStatusTypeDef

def get_value() -> LogPublishingOptionsStatusTypeDef:
    return {
        "Options": ...,
    }
Definition
class LogPublishingOptionsStatusTypeDef(TypedDict):
    Options: NotRequired[Dict[LogTypeType, LogPublishingOptionTypeDef]],  # (1)
    Status: NotRequired[OptionStatusTypeDef],  # (2)
  1. See LogTypeType LogPublishingOptionTypeDef
  2. See OptionStatusTypeDef

NodeToNodeEncryptionOptionsStatusTypeDef

Usage Example
from mypy_boto3_es.type_defs import NodeToNodeEncryptionOptionsStatusTypeDef

def get_value() -> NodeToNodeEncryptionOptionsStatusTypeDef:
    return {
        "Options": ...,
        "Status": ...,
    }
Definition
class NodeToNodeEncryptionOptionsStatusTypeDef(TypedDict):
    Options: NodeToNodeEncryptionOptionsTypeDef,  # (1)
    Status: OptionStatusTypeDef,  # (2)
  1. See NodeToNodeEncryptionOptionsTypeDef
  2. See OptionStatusTypeDef

SnapshotOptionsStatusTypeDef

Usage Example
from mypy_boto3_es.type_defs import SnapshotOptionsStatusTypeDef

def get_value() -> SnapshotOptionsStatusTypeDef:
    return {
        "Options": ...,
        "Status": ...,
    }
Definition
class SnapshotOptionsStatusTypeDef(TypedDict):
    Options: SnapshotOptionsTypeDef,  # (1)
    Status: OptionStatusTypeDef,  # (2)
  1. See SnapshotOptionsTypeDef
  2. See OptionStatusTypeDef

CreateOutboundCrossClusterSearchConnectionRequestRequestTypeDef

Usage Example
from mypy_boto3_es.type_defs import CreateOutboundCrossClusterSearchConnectionRequestRequestTypeDef

def get_value() -> CreateOutboundCrossClusterSearchConnectionRequestRequestTypeDef:
    return {
        "SourceDomainInfo": ...,
        "DestinationDomainInfo": ...,
        "ConnectionAlias": ...,
    }
Definition
class CreateOutboundCrossClusterSearchConnectionRequestRequestTypeDef(TypedDict):
    SourceDomainInfo: DomainInformationTypeDef,  # (1)
    DestinationDomainInfo: DomainInformationTypeDef,  # (1)
    ConnectionAlias: str,
  1. See DomainInformationTypeDef
  2. See DomainInformationTypeDef

CreateOutboundCrossClusterSearchConnectionResponseTypeDef

Usage Example
from mypy_boto3_es.type_defs import CreateOutboundCrossClusterSearchConnectionResponseTypeDef

def get_value() -> CreateOutboundCrossClusterSearchConnectionResponseTypeDef:
    return {
        "SourceDomainInfo": ...,
        "DestinationDomainInfo": ...,
        "ConnectionAlias": ...,
        "ConnectionStatus": ...,
        "CrossClusterSearchConnectionId": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateOutboundCrossClusterSearchConnectionResponseTypeDef(TypedDict):
    SourceDomainInfo: DomainInformationTypeDef,  # (1)
    DestinationDomainInfo: DomainInformationTypeDef,  # (1)
    ConnectionAlias: str,
    ConnectionStatus: OutboundCrossClusterSearchConnectionStatusTypeDef,  # (3)
    CrossClusterSearchConnectionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See DomainInformationTypeDef
  2. See DomainInformationTypeDef
  3. See OutboundCrossClusterSearchConnectionStatusTypeDef
  4. See ResponseMetadataTypeDef

OutboundCrossClusterSearchConnectionTypeDef

Usage Example
from mypy_boto3_es.type_defs import OutboundCrossClusterSearchConnectionTypeDef

def get_value() -> OutboundCrossClusterSearchConnectionTypeDef:
    return {
        "SourceDomainInfo": ...,
    }
Definition
class OutboundCrossClusterSearchConnectionTypeDef(TypedDict):
    SourceDomainInfo: NotRequired[DomainInformationTypeDef],  # (1)
    DestinationDomainInfo: NotRequired[DomainInformationTypeDef],  # (1)
    CrossClusterSearchConnectionId: NotRequired[str],
    ConnectionAlias: NotRequired[str],
    ConnectionStatus: NotRequired[OutboundCrossClusterSearchConnectionStatusTypeDef],  # (3)
  1. See DomainInformationTypeDef
  2. See DomainInformationTypeDef
  3. See OutboundCrossClusterSearchConnectionStatusTypeDef

CreatePackageRequestRequestTypeDef

Usage Example
from mypy_boto3_es.type_defs import CreatePackageRequestRequestTypeDef

def get_value() -> CreatePackageRequestRequestTypeDef:
    return {
        "PackageName": ...,
        "PackageType": ...,
        "PackageSource": ...,
    }
Definition
class CreatePackageRequestRequestTypeDef(TypedDict):
    PackageName: str,
    PackageType: PackageTypeType,  # (1)
    PackageSource: PackageSourceTypeDef,  # (2)
    PackageDescription: NotRequired[str],
  1. See PackageTypeType
  2. See PackageSourceTypeDef

UpdatePackageRequestRequestTypeDef

Usage Example
from mypy_boto3_es.type_defs import UpdatePackageRequestRequestTypeDef

def get_value() -> UpdatePackageRequestRequestTypeDef:
    return {
        "PackageID": ...,
        "PackageSource": ...,
    }
Definition
class UpdatePackageRequestRequestTypeDef(TypedDict):
    PackageID: str,
    PackageSource: PackageSourceTypeDef,  # (1)
    PackageDescription: NotRequired[str],
    CommitMessage: NotRequired[str],
  1. See PackageSourceTypeDef

DescribeInboundCrossClusterSearchConnectionsRequestRequestTypeDef

Usage Example
from mypy_boto3_es.type_defs import DescribeInboundCrossClusterSearchConnectionsRequestRequestTypeDef

def get_value() -> DescribeInboundCrossClusterSearchConnectionsRequestRequestTypeDef:
    return {
        "Filters": ...,
    }
Definition
class DescribeInboundCrossClusterSearchConnectionsRequestRequestTypeDef(TypedDict):
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See FilterTypeDef

DescribeOutboundCrossClusterSearchConnectionsRequestRequestTypeDef

Usage Example
from mypy_boto3_es.type_defs import DescribeOutboundCrossClusterSearchConnectionsRequestRequestTypeDef

def get_value() -> DescribeOutboundCrossClusterSearchConnectionsRequestRequestTypeDef:
    return {
        "Filters": ...,
    }
Definition
class DescribeOutboundCrossClusterSearchConnectionsRequestRequestTypeDef(TypedDict):
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See FilterTypeDef

DescribePackagesRequestRequestTypeDef

Usage Example
from mypy_boto3_es.type_defs import DescribePackagesRequestRequestTypeDef

def get_value() -> DescribePackagesRequestRequestTypeDef:
    return {
        "Filters": ...,
    }
Definition
class DescribePackagesRequestRequestTypeDef(TypedDict):
    Filters: NotRequired[Sequence[DescribePackagesFilterTypeDef]],  # (1)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See DescribePackagesFilterTypeDef

DescribeReservedElasticsearchInstanceOfferingsRequestDescribeReservedElasticsearchInstanceOfferingsPaginateTypeDef

Usage Example
from mypy_boto3_es.type_defs import DescribeReservedElasticsearchInstanceOfferingsRequestDescribeReservedElasticsearchInstanceOfferingsPaginateTypeDef

def get_value() -> DescribeReservedElasticsearchInstanceOfferingsRequestDescribeReservedElasticsearchInstanceOfferingsPaginateTypeDef:
    return {
        "ReservedElasticsearchInstanceOfferingId": ...,
    }
Definition
class DescribeReservedElasticsearchInstanceOfferingsRequestDescribeReservedElasticsearchInstanceOfferingsPaginateTypeDef(TypedDict):
    ReservedElasticsearchInstanceOfferingId: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeReservedElasticsearchInstancesRequestDescribeReservedElasticsearchInstancesPaginateTypeDef

Usage Example
from mypy_boto3_es.type_defs import DescribeReservedElasticsearchInstancesRequestDescribeReservedElasticsearchInstancesPaginateTypeDef

def get_value() -> DescribeReservedElasticsearchInstancesRequestDescribeReservedElasticsearchInstancesPaginateTypeDef:
    return {
        "ReservedElasticsearchInstanceId": ...,
    }
Definition
class DescribeReservedElasticsearchInstancesRequestDescribeReservedElasticsearchInstancesPaginateTypeDef(TypedDict):
    ReservedElasticsearchInstanceId: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

GetUpgradeHistoryRequestGetUpgradeHistoryPaginateTypeDef

Usage Example
from mypy_boto3_es.type_defs import GetUpgradeHistoryRequestGetUpgradeHistoryPaginateTypeDef

def get_value() -> GetUpgradeHistoryRequestGetUpgradeHistoryPaginateTypeDef:
    return {
        "DomainName": ...,
    }
Definition
class GetUpgradeHistoryRequestGetUpgradeHistoryPaginateTypeDef(TypedDict):
    DomainName: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListElasticsearchInstanceTypesRequestListElasticsearchInstanceTypesPaginateTypeDef

Usage Example
from mypy_boto3_es.type_defs import ListElasticsearchInstanceTypesRequestListElasticsearchInstanceTypesPaginateTypeDef

def get_value() -> ListElasticsearchInstanceTypesRequestListElasticsearchInstanceTypesPaginateTypeDef:
    return {
        "ElasticsearchVersion": ...,
    }
Definition
class ListElasticsearchInstanceTypesRequestListElasticsearchInstanceTypesPaginateTypeDef(TypedDict):
    ElasticsearchVersion: str,
    DomainName: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListElasticsearchVersionsRequestListElasticsearchVersionsPaginateTypeDef

Usage Example
from mypy_boto3_es.type_defs import ListElasticsearchVersionsRequestListElasticsearchVersionsPaginateTypeDef

def get_value() -> ListElasticsearchVersionsRequestListElasticsearchVersionsPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }
Definition
class ListElasticsearchVersionsRequestListElasticsearchVersionsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListDomainNamesResponseTypeDef

Usage Example
from mypy_boto3_es.type_defs import ListDomainNamesResponseTypeDef

def get_value() -> ListDomainNamesResponseTypeDef:
    return {
        "DomainNames": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListDomainNamesResponseTypeDef(TypedDict):
    DomainNames: List[DomainInfoTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainInfoTypeDef
  2. See ResponseMetadataTypeDef

DomainPackageDetailsTypeDef

Usage Example
from mypy_boto3_es.type_defs import DomainPackageDetailsTypeDef

def get_value() -> DomainPackageDetailsTypeDef:
    return {
        "PackageID": ...,
    }
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

Usage Example
from mypy_boto3_es.type_defs import PackageDetailsTypeDef

def get_value() -> PackageDetailsTypeDef:
    return {
        "PackageID": ...,
    }
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

ElasticsearchClusterConfigTypeDef

Usage Example
from mypy_boto3_es.type_defs import ElasticsearchClusterConfigTypeDef

def get_value() -> ElasticsearchClusterConfigTypeDef:
    return {
        "InstanceType": ...,
    }
Definition
class ElasticsearchClusterConfigTypeDef(TypedDict):
    InstanceType: NotRequired[ESPartitionInstanceTypeType],  # (1)
    InstanceCount: NotRequired[int],
    DedicatedMasterEnabled: NotRequired[bool],
    ZoneAwarenessEnabled: NotRequired[bool],
    ZoneAwarenessConfig: NotRequired[ZoneAwarenessConfigTypeDef],  # (2)
    DedicatedMasterType: NotRequired[ESPartitionInstanceTypeType],  # (1)
    DedicatedMasterCount: NotRequired[int],
    WarmEnabled: NotRequired[bool],
    WarmType: NotRequired[ESWarmPartitionInstanceTypeType],  # (4)
    WarmCount: NotRequired[int],
    ColdStorageOptions: NotRequired[ColdStorageOptionsTypeDef],  # (5)
  1. See ESPartitionInstanceTypeType
  2. See ZoneAwarenessConfigTypeDef
  3. See ESPartitionInstanceTypeType
  4. See ESWarmPartitionInstanceTypeType
  5. See ColdStorageOptionsTypeDef

VPCDerivedInfoStatusTypeDef

Usage Example
from mypy_boto3_es.type_defs import VPCDerivedInfoStatusTypeDef

def get_value() -> VPCDerivedInfoStatusTypeDef:
    return {
        "Options": ...,
        "Status": ...,
    }
Definition
class VPCDerivedInfoStatusTypeDef(TypedDict):
    Options: VPCDerivedInfoTypeDef,  # (1)
    Status: OptionStatusTypeDef,  # (2)
  1. See VPCDerivedInfoTypeDef
  2. See OptionStatusTypeDef

GetPackageVersionHistoryResponseTypeDef

Usage Example
from mypy_boto3_es.type_defs import GetPackageVersionHistoryResponseTypeDef

def get_value() -> GetPackageVersionHistoryResponseTypeDef:
    return {
        "PackageID": ...,
        "PackageVersionHistoryList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetPackageVersionHistoryResponseTypeDef(TypedDict):
    PackageID: str,
    PackageVersionHistoryList: List[PackageVersionHistoryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PackageVersionHistoryTypeDef
  2. See ResponseMetadataTypeDef

InboundCrossClusterSearchConnectionTypeDef

Usage Example
from mypy_boto3_es.type_defs import InboundCrossClusterSearchConnectionTypeDef

def get_value() -> InboundCrossClusterSearchConnectionTypeDef:
    return {
        "SourceDomainInfo": ...,
    }
Definition
class InboundCrossClusterSearchConnectionTypeDef(TypedDict):
    SourceDomainInfo: NotRequired[DomainInformationTypeDef],  # (1)
    DestinationDomainInfo: NotRequired[DomainInformationTypeDef],  # (1)
    CrossClusterSearchConnectionId: NotRequired[str],
    ConnectionStatus: NotRequired[InboundCrossClusterSearchConnectionStatusTypeDef],  # (3)
  1. See DomainInformationTypeDef
  2. See DomainInformationTypeDef
  3. See InboundCrossClusterSearchConnectionStatusTypeDef

InstanceLimitsTypeDef

Usage Example
from mypy_boto3_es.type_defs import InstanceLimitsTypeDef

def get_value() -> InstanceLimitsTypeDef:
    return {
        "InstanceCountLimits": ...,
    }
Definition
class InstanceLimitsTypeDef(TypedDict):
    InstanceCountLimits: NotRequired[InstanceCountLimitsTypeDef],  # (1)
  1. See InstanceCountLimitsTypeDef

ReservedElasticsearchInstanceOfferingTypeDef

Usage Example
from mypy_boto3_es.type_defs import ReservedElasticsearchInstanceOfferingTypeDef

def get_value() -> ReservedElasticsearchInstanceOfferingTypeDef:
    return {
        "ReservedElasticsearchInstanceOfferingId": ...,
    }
Definition
class ReservedElasticsearchInstanceOfferingTypeDef(TypedDict):
    ReservedElasticsearchInstanceOfferingId: NotRequired[str],
    ElasticsearchInstanceType: NotRequired[ESPartitionInstanceTypeType],  # (1)
    Duration: NotRequired[int],
    FixedPrice: NotRequired[float],
    UsagePrice: NotRequired[float],
    CurrencyCode: NotRequired[str],
    PaymentOption: NotRequired[ReservedElasticsearchInstancePaymentOptionType],  # (2)
    RecurringCharges: NotRequired[List[RecurringChargeTypeDef]],  # (3)
  1. See ESPartitionInstanceTypeType
  2. See ReservedElasticsearchInstancePaymentOptionType
  3. See RecurringChargeTypeDef

ReservedElasticsearchInstanceTypeDef

Usage Example
from mypy_boto3_es.type_defs import ReservedElasticsearchInstanceTypeDef

def get_value() -> ReservedElasticsearchInstanceTypeDef:
    return {
        "ReservationName": ...,
    }
Definition
class ReservedElasticsearchInstanceTypeDef(TypedDict):
    ReservationName: NotRequired[str],
    ReservedElasticsearchInstanceId: NotRequired[str],
    ReservedElasticsearchInstanceOfferingId: NotRequired[str],
    ElasticsearchInstanceType: NotRequired[ESPartitionInstanceTypeType],  # (1)
    StartTime: NotRequired[datetime],
    Duration: NotRequired[int],
    FixedPrice: NotRequired[float],
    UsagePrice: NotRequired[float],
    CurrencyCode: NotRequired[str],
    ElasticsearchInstanceCount: NotRequired[int],
    State: NotRequired[str],
    PaymentOption: NotRequired[ReservedElasticsearchInstancePaymentOptionType],  # (2)
    RecurringCharges: NotRequired[List[RecurringChargeTypeDef]],  # (3)
  1. See ESPartitionInstanceTypeType
  2. See ReservedElasticsearchInstancePaymentOptionType
  3. See RecurringChargeTypeDef

SAMLOptionsInputTypeDef

Usage Example
from mypy_boto3_es.type_defs import SAMLOptionsInputTypeDef

def get_value() -> SAMLOptionsInputTypeDef:
    return {
        "Enabled": ...,
    }
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

Usage Example
from mypy_boto3_es.type_defs import SAMLOptionsOutputTypeDef

def get_value() -> SAMLOptionsOutputTypeDef:
    return {
        "Enabled": ...,
    }
Definition
class SAMLOptionsOutputTypeDef(TypedDict):
    Enabled: NotRequired[bool],
    Idp: NotRequired[SAMLIdpTypeDef],  # (1)
    SubjectKey: NotRequired[str],
    RolesKey: NotRequired[str],
    SessionTimeoutMinutes: NotRequired[int],
  1. See SAMLIdpTypeDef

StorageTypeTypeDef

Usage Example
from mypy_boto3_es.type_defs import StorageTypeTypeDef

def get_value() -> StorageTypeTypeDef:
    return {
        "StorageTypeName": ...,
    }
Definition
class StorageTypeTypeDef(TypedDict):
    StorageTypeName: NotRequired[str],
    StorageSubTypeName: NotRequired[str],
    StorageTypeLimits: NotRequired[List[StorageTypeLimitTypeDef]],  # (1)
  1. See StorageTypeLimitTypeDef

UpgradeHistoryTypeDef

Usage Example
from mypy_boto3_es.type_defs import UpgradeHistoryTypeDef

def get_va