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],
- See OptionStateType
TagTypeDef
Usage Example
from mypy_boto3_es.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
"Value": ...,
}
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": ...,
}
AuthorizeVpcEndpointAccessRequestRequestTypeDef
Usage Example
from mypy_boto3_es.type_defs import AuthorizeVpcEndpointAccessRequestRequestTypeDef
def get_value() -> AuthorizeVpcEndpointAccessRequestRequestTypeDef:
return {
"DomainName": ...,
"Account": ...,
}
Definition
class AuthorizeVpcEndpointAccessRequestRequestTypeDef(TypedDict):
DomainName: str,
Account: str,
AuthorizedPrincipalTypeDef
Usage Example
from mypy_boto3_es.type_defs import AuthorizedPrincipalTypeDef
def get_value() -> AuthorizedPrincipalTypeDef:
return {
"PrincipalType": ...,
}
Definition
class AuthorizedPrincipalTypeDef(TypedDict):
PrincipalType: NotRequired[PrincipalTypeType], # (1)
Principal: NotRequired[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)
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)
- 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],
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],
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],
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": ...,
}
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],
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],
- 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": ...,
}
SnapshotOptionsTypeDef
Usage Example
from mypy_boto3_es.type_defs import SnapshotOptionsTypeDef
def get_value() -> SnapshotOptionsTypeDef:
return {
"AutomatedSnapshotStartHour": ...,
}
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],
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": ...,
}
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": ...,
}
DeleteVpcEndpointRequestRequestTypeDef
Usage Example
from mypy_boto3_es.type_defs import DeleteVpcEndpointRequestRequestTypeDef
def get_value() -> DeleteVpcEndpointRequestRequestTypeDef:
return {
"VpcEndpointId": ...,
}
VpcEndpointSummaryTypeDef
Usage Example
from mypy_boto3_es.type_defs import VpcEndpointSummaryTypeDef
def get_value() -> VpcEndpointSummaryTypeDef:
return {
"VpcEndpointId": ...,
}
Definition
class VpcEndpointSummaryTypeDef(TypedDict):
VpcEndpointId: NotRequired[str],
VpcEndpointOwner: NotRequired[str],
DomainArn: NotRequired[str],
Status: NotRequired[VpcEndpointStatusType], # (1)
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": ...,
}
DescribeElasticsearchDomainRequestRequestTypeDef
Usage Example
from mypy_boto3_es.type_defs import DescribeElasticsearchDomainRequestRequestTypeDef
def get_value() -> DescribeElasticsearchDomainRequestRequestTypeDef:
return {
"DomainName": ...,
}
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],
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]],
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],
DescribeVpcEndpointsRequestRequestTypeDef
Usage Example
from mypy_boto3_es.type_defs import DescribeVpcEndpointsRequestRequestTypeDef
def get_value() -> DescribeVpcEndpointsRequestRequestTypeDef:
return {
"VpcEndpointIds": ...,
}
Definition
class DescribeVpcEndpointsRequestRequestTypeDef(TypedDict):
VpcEndpointIds: Sequence[str],
VpcEndpointErrorTypeDef
Usage Example
from mypy_boto3_es.type_defs import VpcEndpointErrorTypeDef
def get_value() -> VpcEndpointErrorTypeDef:
return {
"VpcEndpointId": ...,
}
Definition
class VpcEndpointErrorTypeDef(TypedDict):
VpcEndpointId: NotRequired[str],
ErrorCode: NotRequired[VpcEndpointErrorCodeType], # (1)
ErrorMessage: NotRequired[str],
DissociatePackageRequestRequestTypeDef
Usage Example
from mypy_boto3_es.type_defs import DissociatePackageRequestRequestTypeDef
def get_value() -> DissociatePackageRequestRequestTypeDef:
return {
"PackageID": ...,
"DomainName": ...,
}
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)
- 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": ...,
}
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": ...,
}
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],
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)
- 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": ...,
}
ListVpcEndpointAccessRequestRequestTypeDef
Usage Example
from mypy_boto3_es.type_defs import ListVpcEndpointAccessRequestRequestTypeDef
def get_value() -> ListVpcEndpointAccessRequestRequestTypeDef:
return {
"DomainName": ...,
}
Definition
class ListVpcEndpointAccessRequestRequestTypeDef(TypedDict):
DomainName: str,
NextToken: NotRequired[str],
ListVpcEndpointsForDomainRequestRequestTypeDef
Usage Example
from mypy_boto3_es.type_defs import ListVpcEndpointsForDomainRequestRequestTypeDef
def get_value() -> ListVpcEndpointsForDomainRequestRequestTypeDef:
return {
"DomainName": ...,
}
Definition
class ListVpcEndpointsForDomainRequestRequestTypeDef(TypedDict):
DomainName: str,
NextToken: NotRequired[str],
ListVpcEndpointsRequestRequestTypeDef
Usage Example
from mypy_boto3_es.type_defs import ListVpcEndpointsRequestRequestTypeDef
def get_value() -> ListVpcEndpointsRequestRequestTypeDef:
return {
"NextToken": ...,
}
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": ...,
}
RevokeVpcEndpointAccessRequestRequestTypeDef
Usage Example
from mypy_boto3_es.type_defs import RevokeVpcEndpointAccessRequestRequestTypeDef
def get_value() -> RevokeVpcEndpointAccessRequestRequestTypeDef:
return {
"DomainName": ...,
"Account": ...,
}
Definition
class RevokeVpcEndpointAccessRequestRequestTypeDef(TypedDict):
DomainName: str,
Account: str,
SAMLIdpTypeDef
Usage Example
from mypy_boto3_es.type_defs import SAMLIdpTypeDef
def get_value() -> SAMLIdpTypeDef:
return {
"MetadataContent": ...,
"EntityId": ...,
}
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],
- See UpgradeStepType
- 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)
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)
- See UpgradeStepType
- See UpgradeStatusType
- 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)
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)
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)
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)
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)
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)
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)
- 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)
- See TagTypeDef
- See ResponseMetadataTypeDef
AuthorizeVpcEndpointAccessResponseTypeDef
Usage Example
from mypy_boto3_es.type_defs import AuthorizeVpcEndpointAccessResponseTypeDef
def get_value() -> AuthorizeVpcEndpointAccessResponseTypeDef:
return {
"AuthorizedPrincipal": ...,
"ResponseMetadata": ...,
}
Definition
class AuthorizeVpcEndpointAccessResponseTypeDef(TypedDict):
AuthorizedPrincipal: AuthorizedPrincipalTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListVpcEndpointAccessResponseTypeDef
Usage Example
from mypy_boto3_es.type_defs import ListVpcEndpointAccessResponseTypeDef
def get_value() -> ListVpcEndpointAccessResponseTypeDef:
return {
"AuthorizedPrincipalList": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListVpcEndpointAccessResponseTypeDef(TypedDict):
AuthorizedPrincipalList: List[AuthorizedPrincipalTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
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)
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],
- 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)
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)
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)
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)
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)
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)
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)
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)
- See EBSOptionsTypeDef
- 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)
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)
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)
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)
CreateVpcEndpointRequestRequestTypeDef
Usage Example
from mypy_boto3_es.type_defs import CreateVpcEndpointRequestRequestTypeDef
def get_value() -> CreateVpcEndpointRequestRequestTypeDef:
return {
"DomainArn": ...,
"VpcOptions": ...,
}
Definition
class CreateVpcEndpointRequestRequestTypeDef(TypedDict):
DomainArn: str,
VpcOptions: VPCOptionsTypeDef, # (1)
ClientToken: NotRequired[str],
UpdateVpcEndpointRequestRequestTypeDef
Usage Example
from mypy_boto3_es.type_defs import UpdateVpcEndpointRequestRequestTypeDef
def get_value() -> UpdateVpcEndpointRequestRequestTypeDef:
return {
"VpcEndpointId": ...,
"VpcOptions": ...,
}
Definition
class UpdateVpcEndpointRequestRequestTypeDef(TypedDict):
VpcEndpointId: str,
VpcOptions: VPCOptionsTypeDef, # (1)