Type definitions#
Index > ElasticsearchService > Type definitions
Auto-generated documentation for ElasticsearchService type annotations stubs module types-boto3-es.
TimestampTypeDef#
# TimestampTypeDef Union usage example
from types_boto3_es.type_defs import TimestampTypeDef
def get_value() -> TimestampTypeDef:
return ...
# TimestampTypeDef definition
TimestampTypeDef = Union[
datetime,
str,
]AutoTuneMaintenanceScheduleUnionTypeDef#
# AutoTuneMaintenanceScheduleUnionTypeDef Union usage example
from types_boto3_es.type_defs import AutoTuneMaintenanceScheduleUnionTypeDef
def get_value() -> AutoTuneMaintenanceScheduleUnionTypeDef:
return ...
# AutoTuneMaintenanceScheduleUnionTypeDef definition
AutoTuneMaintenanceScheduleUnionTypeDef = Union[
AutoTuneMaintenanceScheduleTypeDef, # (1)
AutoTuneMaintenanceScheduleOutputTypeDef, # (2)
]AutoTuneOptionsUnionTypeDef#
# AutoTuneOptionsUnionTypeDef Union usage example
from types_boto3_es.type_defs import AutoTuneOptionsUnionTypeDef
def get_value() -> AutoTuneOptionsUnionTypeDef:
return ...
# AutoTuneOptionsUnionTypeDef definition
AutoTuneOptionsUnionTypeDef = Union[
AutoTuneOptionsTypeDef, # (1)
AutoTuneOptionsExtraTypeDef, # (2)
]AcceptInboundCrossClusterSearchConnectionRequestTypeDef#
# AcceptInboundCrossClusterSearchConnectionRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import AcceptInboundCrossClusterSearchConnectionRequestTypeDef
def get_value() -> AcceptInboundCrossClusterSearchConnectionRequestTypeDef:
return {
"CrossClusterSearchConnectionId": ...,
}
# AcceptInboundCrossClusterSearchConnectionRequestTypeDef definition
class AcceptInboundCrossClusterSearchConnectionRequestTypeDef(TypedDict):
CrossClusterSearchConnectionId: str,ResponseMetadataTypeDef#
# ResponseMetadataTypeDef TypedDict usage example
from types_boto3_es.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],OptionStatusTypeDef#
# OptionStatusTypeDef TypedDict usage example
from types_boto3_es.type_defs import OptionStatusTypeDef
def get_value() -> OptionStatusTypeDef:
return {
"CreationDate": ...,
}
# OptionStatusTypeDef definition
class OptionStatusTypeDef(TypedDict):
CreationDate: datetime,
UpdateDate: datetime,
State: OptionStateType, # (1)
UpdateVersion: NotRequired[int],
PendingDeletion: NotRequired[bool],- See OptionStateType
TagTypeDef#
# TagTypeDef TypedDict usage example
from types_boto3_es.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
}
# TagTypeDef definition
class TagTypeDef(TypedDict):
Key: str,
Value: str,AdditionalLimitTypeDef#
# AdditionalLimitTypeDef TypedDict usage example
from types_boto3_es.type_defs import AdditionalLimitTypeDef
def get_value() -> AdditionalLimitTypeDef:
return {
"LimitName": ...,
}
# AdditionalLimitTypeDef definition
class AdditionalLimitTypeDef(TypedDict):
LimitName: NotRequired[str],
LimitValues: NotRequired[List[str]],MasterUserOptionsTypeDef#
# MasterUserOptionsTypeDef TypedDict usage example
from types_boto3_es.type_defs import MasterUserOptionsTypeDef
def get_value() -> MasterUserOptionsTypeDef:
return {
"MasterUserARN": ...,
}
# MasterUserOptionsTypeDef definition
class MasterUserOptionsTypeDef(TypedDict):
MasterUserARN: NotRequired[str],
MasterUserName: NotRequired[str],
MasterUserPassword: NotRequired[str],AssociatePackageRequestTypeDef#
# AssociatePackageRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import AssociatePackageRequestTypeDef
def get_value() -> AssociatePackageRequestTypeDef:
return {
"PackageID": ...,
}
# AssociatePackageRequestTypeDef definition
class AssociatePackageRequestTypeDef(TypedDict):
PackageID: str,
DomainName: str,AuthorizeVpcEndpointAccessRequestTypeDef#
# AuthorizeVpcEndpointAccessRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import AuthorizeVpcEndpointAccessRequestTypeDef
def get_value() -> AuthorizeVpcEndpointAccessRequestTypeDef:
return {
"DomainName": ...,
}
# AuthorizeVpcEndpointAccessRequestTypeDef definition
class AuthorizeVpcEndpointAccessRequestTypeDef(TypedDict):
DomainName: str,
Account: str,AuthorizedPrincipalTypeDef#
# AuthorizedPrincipalTypeDef TypedDict usage example
from types_boto3_es.type_defs import AuthorizedPrincipalTypeDef
def get_value() -> AuthorizedPrincipalTypeDef:
return {
"PrincipalType": ...,
}
# AuthorizedPrincipalTypeDef definition
class AuthorizedPrincipalTypeDef(TypedDict):
PrincipalType: NotRequired[PrincipalTypeType], # (1)
Principal: NotRequired[str],ScheduledAutoTuneDetailsTypeDef#
# ScheduledAutoTuneDetailsTypeDef TypedDict usage example
from types_boto3_es.type_defs import ScheduledAutoTuneDetailsTypeDef
def get_value() -> ScheduledAutoTuneDetailsTypeDef:
return {
"Date": ...,
}
# ScheduledAutoTuneDetailsTypeDef definition
class ScheduledAutoTuneDetailsTypeDef(TypedDict):
Date: NotRequired[datetime],
ActionType: NotRequired[ScheduledAutoTuneActionTypeType], # (1)
Action: NotRequired[str],
Severity: NotRequired[ScheduledAutoTuneSeverityTypeType], # (2)DurationTypeDef#
# DurationTypeDef TypedDict usage example
from types_boto3_es.type_defs import DurationTypeDef
def get_value() -> DurationTypeDef:
return {
"Value": ...,
}
# DurationTypeDef definition
class DurationTypeDef(TypedDict):
Value: NotRequired[int],
Unit: NotRequired[TimeUnitType], # (1)- See TimeUnitType
AutoTuneOptionsOutputTypeDef#
# AutoTuneOptionsOutputTypeDef TypedDict usage example
from types_boto3_es.type_defs import AutoTuneOptionsOutputTypeDef
def get_value() -> AutoTuneOptionsOutputTypeDef:
return {
"State": ...,
}
# AutoTuneOptionsOutputTypeDef definition
class AutoTuneOptionsOutputTypeDef(TypedDict):
State: NotRequired[AutoTuneStateType], # (1)
ErrorMessage: NotRequired[str],AutoTuneStatusTypeDef#
# AutoTuneStatusTypeDef TypedDict usage example
from types_boto3_es.type_defs import AutoTuneStatusTypeDef
def get_value() -> AutoTuneStatusTypeDef:
return {
"CreationDate": ...,
}
# AutoTuneStatusTypeDef definition
class AutoTuneStatusTypeDef(TypedDict):
CreationDate: datetime,
UpdateDate: datetime,
State: AutoTuneStateType, # (1)
UpdateVersion: NotRequired[int],
ErrorMessage: NotRequired[str],
PendingDeletion: NotRequired[bool],CancelDomainConfigChangeRequestTypeDef#
# CancelDomainConfigChangeRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import CancelDomainConfigChangeRequestTypeDef
def get_value() -> CancelDomainConfigChangeRequestTypeDef:
return {
"DomainName": ...,
}
# CancelDomainConfigChangeRequestTypeDef definition
class CancelDomainConfigChangeRequestTypeDef(TypedDict):
DomainName: str,
DryRun: NotRequired[bool],CancelledChangePropertyTypeDef#
# CancelledChangePropertyTypeDef TypedDict usage example
from types_boto3_es.type_defs import CancelledChangePropertyTypeDef
def get_value() -> CancelledChangePropertyTypeDef:
return {
"PropertyName": ...,
}
# CancelledChangePropertyTypeDef definition
class CancelledChangePropertyTypeDef(TypedDict):
PropertyName: NotRequired[str],
CancelledValue: NotRequired[str],
ActiveValue: NotRequired[str],CancelElasticsearchServiceSoftwareUpdateRequestTypeDef#
# CancelElasticsearchServiceSoftwareUpdateRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import CancelElasticsearchServiceSoftwareUpdateRequestTypeDef
def get_value() -> CancelElasticsearchServiceSoftwareUpdateRequestTypeDef:
return {
"DomainName": ...,
}
# CancelElasticsearchServiceSoftwareUpdateRequestTypeDef definition
class CancelElasticsearchServiceSoftwareUpdateRequestTypeDef(TypedDict):
DomainName: str,ServiceSoftwareOptionsTypeDef#
# ServiceSoftwareOptionsTypeDef TypedDict usage example
from types_boto3_es.type_defs import ServiceSoftwareOptionsTypeDef
def get_value() -> ServiceSoftwareOptionsTypeDef:
return {
"CurrentVersion": ...,
}
# ServiceSoftwareOptionsTypeDef definition
class ServiceSoftwareOptionsTypeDef(TypedDict):
CurrentVersion: NotRequired[str],
NewVersion: NotRequired[str],
UpdateAvailable: NotRequired[bool],
Cancellable: NotRequired[bool],
UpdateStatus: NotRequired[DeploymentStatusType], # (1)
Description: NotRequired[str],
AutomatedUpdateDate: NotRequired[datetime],
OptionalDeployment: NotRequired[bool],ChangeProgressDetailsTypeDef#
# ChangeProgressDetailsTypeDef TypedDict usage example
from types_boto3_es.type_defs import ChangeProgressDetailsTypeDef
def get_value() -> ChangeProgressDetailsTypeDef:
return {
"ChangeId": ...,
}
# ChangeProgressDetailsTypeDef definition
class ChangeProgressDetailsTypeDef(TypedDict):
ChangeId: NotRequired[str],
Message: NotRequired[str],
ConfigChangeStatus: NotRequired[ConfigChangeStatusType], # (1)
StartTime: NotRequired[datetime],
LastUpdatedTime: NotRequired[datetime],
InitiatedBy: NotRequired[InitiatedByType], # (2)ChangeProgressStageTypeDef#
# ChangeProgressStageTypeDef TypedDict usage example
from types_boto3_es.type_defs import ChangeProgressStageTypeDef
def get_value() -> ChangeProgressStageTypeDef:
return {
"Name": ...,
}
# ChangeProgressStageTypeDef definition
class ChangeProgressStageTypeDef(TypedDict):
Name: NotRequired[str],
Status: NotRequired[str],
Description: NotRequired[str],
LastUpdated: NotRequired[datetime],CognitoOptionsTypeDef#
# CognitoOptionsTypeDef TypedDict usage example
from types_boto3_es.type_defs import CognitoOptionsTypeDef
def get_value() -> CognitoOptionsTypeDef:
return {
"Enabled": ...,
}
# CognitoOptionsTypeDef definition
class CognitoOptionsTypeDef(TypedDict):
Enabled: NotRequired[bool],
UserPoolId: NotRequired[str],
IdentityPoolId: NotRequired[str],
RoleArn: NotRequired[str],ColdStorageOptionsTypeDef#
# ColdStorageOptionsTypeDef TypedDict usage example
from types_boto3_es.type_defs import ColdStorageOptionsTypeDef
def get_value() -> ColdStorageOptionsTypeDef:
return {
"Enabled": ...,
}
# ColdStorageOptionsTypeDef definition
class ColdStorageOptionsTypeDef(TypedDict):
Enabled: bool,CompatibleVersionsMapTypeDef#
# CompatibleVersionsMapTypeDef TypedDict usage example
from types_boto3_es.type_defs import CompatibleVersionsMapTypeDef
def get_value() -> CompatibleVersionsMapTypeDef:
return {
"SourceVersion": ...,
}
# CompatibleVersionsMapTypeDef definition
class CompatibleVersionsMapTypeDef(TypedDict):
SourceVersion: NotRequired[str],
TargetVersions: NotRequired[List[str]],DomainEndpointOptionsTypeDef#
# DomainEndpointOptionsTypeDef TypedDict usage example
from types_boto3_es.type_defs import DomainEndpointOptionsTypeDef
def get_value() -> DomainEndpointOptionsTypeDef:
return {
"EnforceHTTPS": ...,
}
# DomainEndpointOptionsTypeDef definition
class DomainEndpointOptionsTypeDef(TypedDict):
EnforceHTTPS: NotRequired[bool],
TLSSecurityPolicy: NotRequired[TLSSecurityPolicyType], # (1)
CustomEndpointEnabled: NotRequired[bool],
CustomEndpoint: NotRequired[str],
CustomEndpointCertificateArn: NotRequired[str],EBSOptionsTypeDef#
# EBSOptionsTypeDef TypedDict usage example
from types_boto3_es.type_defs import EBSOptionsTypeDef
def get_value() -> EBSOptionsTypeDef:
return {
"EBSEnabled": ...,
}
# EBSOptionsTypeDef definition
class EBSOptionsTypeDef(TypedDict):
EBSEnabled: NotRequired[bool],
VolumeType: NotRequired[VolumeTypeType], # (1)
VolumeSize: NotRequired[int],
Iops: NotRequired[int],
Throughput: NotRequired[int],- See VolumeTypeType
EncryptionAtRestOptionsTypeDef#
# EncryptionAtRestOptionsTypeDef TypedDict usage example
from types_boto3_es.type_defs import EncryptionAtRestOptionsTypeDef
def get_value() -> EncryptionAtRestOptionsTypeDef:
return {
"Enabled": ...,
}
# EncryptionAtRestOptionsTypeDef definition
class EncryptionAtRestOptionsTypeDef(TypedDict):
Enabled: NotRequired[bool],
KmsKeyId: NotRequired[str],LogPublishingOptionTypeDef#
# LogPublishingOptionTypeDef TypedDict usage example
from types_boto3_es.type_defs import LogPublishingOptionTypeDef
def get_value() -> LogPublishingOptionTypeDef:
return {
"CloudWatchLogsLogGroupArn": ...,
}
# LogPublishingOptionTypeDef definition
class LogPublishingOptionTypeDef(TypedDict):
CloudWatchLogsLogGroupArn: NotRequired[str],
Enabled: NotRequired[bool],NodeToNodeEncryptionOptionsTypeDef#
# NodeToNodeEncryptionOptionsTypeDef TypedDict usage example
from types_boto3_es.type_defs import NodeToNodeEncryptionOptionsTypeDef
def get_value() -> NodeToNodeEncryptionOptionsTypeDef:
return {
"Enabled": ...,
}
# NodeToNodeEncryptionOptionsTypeDef definition
class NodeToNodeEncryptionOptionsTypeDef(TypedDict):
Enabled: NotRequired[bool],SnapshotOptionsTypeDef#
# SnapshotOptionsTypeDef TypedDict usage example
from types_boto3_es.type_defs import SnapshotOptionsTypeDef
def get_value() -> SnapshotOptionsTypeDef:
return {
"AutomatedSnapshotStartHour": ...,
}
# SnapshotOptionsTypeDef definition
class SnapshotOptionsTypeDef(TypedDict):
AutomatedSnapshotStartHour: NotRequired[int],VPCOptionsTypeDef#
# VPCOptionsTypeDef TypedDict usage example
from types_boto3_es.type_defs import VPCOptionsTypeDef
def get_value() -> VPCOptionsTypeDef:
return {
"SubnetIds": ...,
}
# VPCOptionsTypeDef definition
class VPCOptionsTypeDef(TypedDict):
SubnetIds: NotRequired[Sequence[str]],
SecurityGroupIds: NotRequired[Sequence[str]],DomainInformationTypeDef#
# DomainInformationTypeDef TypedDict usage example
from types_boto3_es.type_defs import DomainInformationTypeDef
def get_value() -> DomainInformationTypeDef:
return {
"OwnerId": ...,
}
# DomainInformationTypeDef definition
class DomainInformationTypeDef(TypedDict):
DomainName: str,
OwnerId: NotRequired[str],
Region: NotRequired[str],OutboundCrossClusterSearchConnectionStatusTypeDef#
# OutboundCrossClusterSearchConnectionStatusTypeDef TypedDict usage example
from types_boto3_es.type_defs import OutboundCrossClusterSearchConnectionStatusTypeDef
def get_value() -> OutboundCrossClusterSearchConnectionStatusTypeDef:
return {
"StatusCode": ...,
}
# OutboundCrossClusterSearchConnectionStatusTypeDef definition
class OutboundCrossClusterSearchConnectionStatusTypeDef(TypedDict):
StatusCode: NotRequired[OutboundCrossClusterSearchConnectionStatusCodeType], # (1)
Message: NotRequired[str],PackageSourceTypeDef#
# PackageSourceTypeDef TypedDict usage example
from types_boto3_es.type_defs import PackageSourceTypeDef
def get_value() -> PackageSourceTypeDef:
return {
"S3BucketName": ...,
}
# PackageSourceTypeDef definition
class PackageSourceTypeDef(TypedDict):
S3BucketName: NotRequired[str],
S3Key: NotRequired[str],DeleteElasticsearchDomainRequestTypeDef#
# DeleteElasticsearchDomainRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import DeleteElasticsearchDomainRequestTypeDef
def get_value() -> DeleteElasticsearchDomainRequestTypeDef:
return {
"DomainName": ...,
}
# DeleteElasticsearchDomainRequestTypeDef definition
class DeleteElasticsearchDomainRequestTypeDef(TypedDict):
DomainName: str,DeleteInboundCrossClusterSearchConnectionRequestTypeDef#
# DeleteInboundCrossClusterSearchConnectionRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import DeleteInboundCrossClusterSearchConnectionRequestTypeDef
def get_value() -> DeleteInboundCrossClusterSearchConnectionRequestTypeDef:
return {
"CrossClusterSearchConnectionId": ...,
}
# DeleteInboundCrossClusterSearchConnectionRequestTypeDef definition
class DeleteInboundCrossClusterSearchConnectionRequestTypeDef(TypedDict):
CrossClusterSearchConnectionId: str,DeleteOutboundCrossClusterSearchConnectionRequestTypeDef#
# DeleteOutboundCrossClusterSearchConnectionRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import DeleteOutboundCrossClusterSearchConnectionRequestTypeDef
def get_value() -> DeleteOutboundCrossClusterSearchConnectionRequestTypeDef:
return {
"CrossClusterSearchConnectionId": ...,
}
# DeleteOutboundCrossClusterSearchConnectionRequestTypeDef definition
class DeleteOutboundCrossClusterSearchConnectionRequestTypeDef(TypedDict):
CrossClusterSearchConnectionId: str,DeletePackageRequestTypeDef#
# DeletePackageRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import DeletePackageRequestTypeDef
def get_value() -> DeletePackageRequestTypeDef:
return {
"PackageID": ...,
}
# DeletePackageRequestTypeDef definition
class DeletePackageRequestTypeDef(TypedDict):
PackageID: str,DeleteVpcEndpointRequestTypeDef#
# DeleteVpcEndpointRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import DeleteVpcEndpointRequestTypeDef
def get_value() -> DeleteVpcEndpointRequestTypeDef:
return {
"VpcEndpointId": ...,
}
# DeleteVpcEndpointRequestTypeDef definition
class DeleteVpcEndpointRequestTypeDef(TypedDict):
VpcEndpointId: str,VpcEndpointSummaryTypeDef#
# VpcEndpointSummaryTypeDef TypedDict usage example
from types_boto3_es.type_defs import VpcEndpointSummaryTypeDef
def get_value() -> VpcEndpointSummaryTypeDef:
return {
"VpcEndpointId": ...,
}
# VpcEndpointSummaryTypeDef definition
class VpcEndpointSummaryTypeDef(TypedDict):
VpcEndpointId: NotRequired[str],
VpcEndpointOwner: NotRequired[str],
DomainArn: NotRequired[str],
Status: NotRequired[VpcEndpointStatusType], # (1)DescribeDomainAutoTunesRequestTypeDef#
# DescribeDomainAutoTunesRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import DescribeDomainAutoTunesRequestTypeDef
def get_value() -> DescribeDomainAutoTunesRequestTypeDef:
return {
"DomainName": ...,
}
# DescribeDomainAutoTunesRequestTypeDef definition
class DescribeDomainAutoTunesRequestTypeDef(TypedDict):
DomainName: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],DescribeDomainChangeProgressRequestTypeDef#
# DescribeDomainChangeProgressRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import DescribeDomainChangeProgressRequestTypeDef
def get_value() -> DescribeDomainChangeProgressRequestTypeDef:
return {
"DomainName": ...,
}
# DescribeDomainChangeProgressRequestTypeDef definition
class DescribeDomainChangeProgressRequestTypeDef(TypedDict):
DomainName: str,
ChangeId: NotRequired[str],DescribeElasticsearchDomainConfigRequestTypeDef#
# DescribeElasticsearchDomainConfigRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import DescribeElasticsearchDomainConfigRequestTypeDef
def get_value() -> DescribeElasticsearchDomainConfigRequestTypeDef:
return {
"DomainName": ...,
}
# DescribeElasticsearchDomainConfigRequestTypeDef definition
class DescribeElasticsearchDomainConfigRequestTypeDef(TypedDict):
DomainName: str,DescribeElasticsearchDomainRequestTypeDef#
# DescribeElasticsearchDomainRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import DescribeElasticsearchDomainRequestTypeDef
def get_value() -> DescribeElasticsearchDomainRequestTypeDef:
return {
"DomainName": ...,
}
# DescribeElasticsearchDomainRequestTypeDef definition
class DescribeElasticsearchDomainRequestTypeDef(TypedDict):
DomainName: str,DescribeElasticsearchDomainsRequestTypeDef#
# DescribeElasticsearchDomainsRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import DescribeElasticsearchDomainsRequestTypeDef
def get_value() -> DescribeElasticsearchDomainsRequestTypeDef:
return {
"DomainNames": ...,
}
# DescribeElasticsearchDomainsRequestTypeDef definition
class DescribeElasticsearchDomainsRequestTypeDef(TypedDict):
DomainNames: Sequence[str],DescribeElasticsearchInstanceTypeLimitsRequestTypeDef#
# DescribeElasticsearchInstanceTypeLimitsRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import DescribeElasticsearchInstanceTypeLimitsRequestTypeDef
def get_value() -> DescribeElasticsearchInstanceTypeLimitsRequestTypeDef:
return {
"InstanceType": ...,
}
# DescribeElasticsearchInstanceTypeLimitsRequestTypeDef definition
class DescribeElasticsearchInstanceTypeLimitsRequestTypeDef(TypedDict):
InstanceType: ESPartitionInstanceTypeType, # (1)
ElasticsearchVersion: str,
DomainName: NotRequired[str],FilterTypeDef#
# FilterTypeDef TypedDict usage example
from types_boto3_es.type_defs import FilterTypeDef
def get_value() -> FilterTypeDef:
return {
"Name": ...,
}
# FilterTypeDef definition
class FilterTypeDef(TypedDict):
Name: NotRequired[str],
Values: NotRequired[Sequence[str]],DescribePackagesFilterTypeDef#
# DescribePackagesFilterTypeDef TypedDict usage example
from types_boto3_es.type_defs import DescribePackagesFilterTypeDef
def get_value() -> DescribePackagesFilterTypeDef:
return {
"Name": ...,
}
# DescribePackagesFilterTypeDef definition
class DescribePackagesFilterTypeDef(TypedDict):
Name: NotRequired[DescribePackagesFilterNameType], # (1)
Value: NotRequired[Sequence[str]],PaginatorConfigTypeDef#
# PaginatorConfigTypeDef TypedDict usage example
from types_boto3_es.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],DescribeReservedElasticsearchInstanceOfferingsRequestTypeDef#
# DescribeReservedElasticsearchInstanceOfferingsRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import DescribeReservedElasticsearchInstanceOfferingsRequestTypeDef
def get_value() -> DescribeReservedElasticsearchInstanceOfferingsRequestTypeDef:
return {
"ReservedElasticsearchInstanceOfferingId": ...,
}
# DescribeReservedElasticsearchInstanceOfferingsRequestTypeDef definition
class DescribeReservedElasticsearchInstanceOfferingsRequestTypeDef(TypedDict):
ReservedElasticsearchInstanceOfferingId: NotRequired[str],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],DescribeReservedElasticsearchInstancesRequestTypeDef#
# DescribeReservedElasticsearchInstancesRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import DescribeReservedElasticsearchInstancesRequestTypeDef
def get_value() -> DescribeReservedElasticsearchInstancesRequestTypeDef:
return {
"ReservedElasticsearchInstanceId": ...,
}
# DescribeReservedElasticsearchInstancesRequestTypeDef definition
class DescribeReservedElasticsearchInstancesRequestTypeDef(TypedDict):
ReservedElasticsearchInstanceId: NotRequired[str],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],DescribeVpcEndpointsRequestTypeDef#
# DescribeVpcEndpointsRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import DescribeVpcEndpointsRequestTypeDef
def get_value() -> DescribeVpcEndpointsRequestTypeDef:
return {
"VpcEndpointIds": ...,
}
# DescribeVpcEndpointsRequestTypeDef definition
class DescribeVpcEndpointsRequestTypeDef(TypedDict):
VpcEndpointIds: Sequence[str],VpcEndpointErrorTypeDef#
# VpcEndpointErrorTypeDef TypedDict usage example
from types_boto3_es.type_defs import VpcEndpointErrorTypeDef
def get_value() -> VpcEndpointErrorTypeDef:
return {
"VpcEndpointId": ...,
}
# VpcEndpointErrorTypeDef definition
class VpcEndpointErrorTypeDef(TypedDict):
VpcEndpointId: NotRequired[str],
ErrorCode: NotRequired[VpcEndpointErrorCodeType], # (1)
ErrorMessage: NotRequired[str],DissociatePackageRequestTypeDef#
# DissociatePackageRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import DissociatePackageRequestTypeDef
def get_value() -> DissociatePackageRequestTypeDef:
return {
"PackageID": ...,
}
# DissociatePackageRequestTypeDef definition
class DissociatePackageRequestTypeDef(TypedDict):
PackageID: str,
DomainName: str,DomainInfoTypeDef#
# DomainInfoTypeDef TypedDict usage example
from types_boto3_es.type_defs import DomainInfoTypeDef
def get_value() -> DomainInfoTypeDef:
return {
"DomainName": ...,
}
# DomainInfoTypeDef definition
class DomainInfoTypeDef(TypedDict):
DomainName: NotRequired[str],
EngineType: NotRequired[EngineTypeType], # (1)- See EngineTypeType
ErrorDetailsTypeDef#
# ErrorDetailsTypeDef TypedDict usage example
from types_boto3_es.type_defs import ErrorDetailsTypeDef
def get_value() -> ErrorDetailsTypeDef:
return {
"ErrorType": ...,
}
# ErrorDetailsTypeDef definition
class ErrorDetailsTypeDef(TypedDict):
ErrorType: NotRequired[str],
ErrorMessage: NotRequired[str],DryRunResultsTypeDef#
# DryRunResultsTypeDef TypedDict usage example
from types_boto3_es.type_defs import DryRunResultsTypeDef
def get_value() -> DryRunResultsTypeDef:
return {
"DeploymentType": ...,
}
# DryRunResultsTypeDef definition
class DryRunResultsTypeDef(TypedDict):
DeploymentType: NotRequired[str],
Message: NotRequired[str],ZoneAwarenessConfigTypeDef#
# ZoneAwarenessConfigTypeDef TypedDict usage example
from types_boto3_es.type_defs import ZoneAwarenessConfigTypeDef
def get_value() -> ZoneAwarenessConfigTypeDef:
return {
"AvailabilityZoneCount": ...,
}
# ZoneAwarenessConfigTypeDef definition
class ZoneAwarenessConfigTypeDef(TypedDict):
AvailabilityZoneCount: NotRequired[int],ModifyingPropertiesTypeDef#
# ModifyingPropertiesTypeDef TypedDict usage example
from types_boto3_es.type_defs import ModifyingPropertiesTypeDef
def get_value() -> ModifyingPropertiesTypeDef:
return {
"Name": ...,
}
# ModifyingPropertiesTypeDef definition
class ModifyingPropertiesTypeDef(TypedDict):
Name: NotRequired[str],
ActiveValue: NotRequired[str],
PendingValue: NotRequired[str],
ValueType: NotRequired[PropertyValueTypeType], # (1)VPCDerivedInfoTypeDef#
# VPCDerivedInfoTypeDef TypedDict usage example
from types_boto3_es.type_defs import VPCDerivedInfoTypeDef
def get_value() -> VPCDerivedInfoTypeDef:
return {
"VPCId": ...,
}
# VPCDerivedInfoTypeDef definition
class VPCDerivedInfoTypeDef(TypedDict):
VPCId: NotRequired[str],
SubnetIds: NotRequired[List[str]],
AvailabilityZones: NotRequired[List[str]],
SecurityGroupIds: NotRequired[List[str]],GetCompatibleElasticsearchVersionsRequestTypeDef#
# GetCompatibleElasticsearchVersionsRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import GetCompatibleElasticsearchVersionsRequestTypeDef
def get_value() -> GetCompatibleElasticsearchVersionsRequestTypeDef:
return {
"DomainName": ...,
}
# GetCompatibleElasticsearchVersionsRequestTypeDef definition
class GetCompatibleElasticsearchVersionsRequestTypeDef(TypedDict):
DomainName: NotRequired[str],GetPackageVersionHistoryRequestTypeDef#
# GetPackageVersionHistoryRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import GetPackageVersionHistoryRequestTypeDef
def get_value() -> GetPackageVersionHistoryRequestTypeDef:
return {
"PackageID": ...,
}
# GetPackageVersionHistoryRequestTypeDef definition
class GetPackageVersionHistoryRequestTypeDef(TypedDict):
PackageID: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],PackageVersionHistoryTypeDef#
# PackageVersionHistoryTypeDef TypedDict usage example
from types_boto3_es.type_defs import PackageVersionHistoryTypeDef
def get_value() -> PackageVersionHistoryTypeDef:
return {
"PackageVersion": ...,
}
# PackageVersionHistoryTypeDef definition
class PackageVersionHistoryTypeDef(TypedDict):
PackageVersion: NotRequired[str],
CommitMessage: NotRequired[str],
CreatedAt: NotRequired[datetime],GetUpgradeHistoryRequestTypeDef#
# GetUpgradeHistoryRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import GetUpgradeHistoryRequestTypeDef
def get_value() -> GetUpgradeHistoryRequestTypeDef:
return {
"DomainName": ...,
}
# GetUpgradeHistoryRequestTypeDef definition
class GetUpgradeHistoryRequestTypeDef(TypedDict):
DomainName: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],GetUpgradeStatusRequestTypeDef#
# GetUpgradeStatusRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import GetUpgradeStatusRequestTypeDef
def get_value() -> GetUpgradeStatusRequestTypeDef:
return {
"DomainName": ...,
}
# GetUpgradeStatusRequestTypeDef definition
class GetUpgradeStatusRequestTypeDef(TypedDict):
DomainName: str,InboundCrossClusterSearchConnectionStatusTypeDef#
# InboundCrossClusterSearchConnectionStatusTypeDef TypedDict usage example
from types_boto3_es.type_defs import InboundCrossClusterSearchConnectionStatusTypeDef
def get_value() -> InboundCrossClusterSearchConnectionStatusTypeDef:
return {
"StatusCode": ...,
}
# InboundCrossClusterSearchConnectionStatusTypeDef definition
class InboundCrossClusterSearchConnectionStatusTypeDef(TypedDict):
StatusCode: NotRequired[InboundCrossClusterSearchConnectionStatusCodeType], # (1)
Message: NotRequired[str],InstanceCountLimitsTypeDef#
# InstanceCountLimitsTypeDef TypedDict usage example
from types_boto3_es.type_defs import InstanceCountLimitsTypeDef
def get_value() -> InstanceCountLimitsTypeDef:
return {
"MinimumInstanceCount": ...,
}
# InstanceCountLimitsTypeDef definition
class InstanceCountLimitsTypeDef(TypedDict):
MinimumInstanceCount: NotRequired[int],
MaximumInstanceCount: NotRequired[int],ListDomainNamesRequestTypeDef#
# ListDomainNamesRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import ListDomainNamesRequestTypeDef
def get_value() -> ListDomainNamesRequestTypeDef:
return {
"EngineType": ...,
}
# ListDomainNamesRequestTypeDef definition
class ListDomainNamesRequestTypeDef(TypedDict):
EngineType: NotRequired[EngineTypeType], # (1)- See EngineTypeType
ListDomainsForPackageRequestTypeDef#
# ListDomainsForPackageRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import ListDomainsForPackageRequestTypeDef
def get_value() -> ListDomainsForPackageRequestTypeDef:
return {
"PackageID": ...,
}
# ListDomainsForPackageRequestTypeDef definition
class ListDomainsForPackageRequestTypeDef(TypedDict):
PackageID: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],ListElasticsearchInstanceTypesRequestTypeDef#
# ListElasticsearchInstanceTypesRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import ListElasticsearchInstanceTypesRequestTypeDef
def get_value() -> ListElasticsearchInstanceTypesRequestTypeDef:
return {
"ElasticsearchVersion": ...,
}
# ListElasticsearchInstanceTypesRequestTypeDef definition
class ListElasticsearchInstanceTypesRequestTypeDef(TypedDict):
ElasticsearchVersion: str,
DomainName: NotRequired[str],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],ListElasticsearchVersionsRequestTypeDef#
# ListElasticsearchVersionsRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import ListElasticsearchVersionsRequestTypeDef
def get_value() -> ListElasticsearchVersionsRequestTypeDef:
return {
"MaxResults": ...,
}
# ListElasticsearchVersionsRequestTypeDef definition
class ListElasticsearchVersionsRequestTypeDef(TypedDict):
MaxResults: NotRequired[int],
NextToken: NotRequired[str],ListPackagesForDomainRequestTypeDef#
# ListPackagesForDomainRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import ListPackagesForDomainRequestTypeDef
def get_value() -> ListPackagesForDomainRequestTypeDef:
return {
"DomainName": ...,
}
# ListPackagesForDomainRequestTypeDef definition
class ListPackagesForDomainRequestTypeDef(TypedDict):
DomainName: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],ListTagsRequestTypeDef#
# ListTagsRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import ListTagsRequestTypeDef
def get_value() -> ListTagsRequestTypeDef:
return {
"ARN": ...,
}
# ListTagsRequestTypeDef definition
class ListTagsRequestTypeDef(TypedDict):
ARN: str,ListVpcEndpointAccessRequestTypeDef#
# ListVpcEndpointAccessRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import ListVpcEndpointAccessRequestTypeDef
def get_value() -> ListVpcEndpointAccessRequestTypeDef:
return {
"DomainName": ...,
}
# ListVpcEndpointAccessRequestTypeDef definition
class ListVpcEndpointAccessRequestTypeDef(TypedDict):
DomainName: str,
NextToken: NotRequired[str],ListVpcEndpointsForDomainRequestTypeDef#
# ListVpcEndpointsForDomainRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import ListVpcEndpointsForDomainRequestTypeDef
def get_value() -> ListVpcEndpointsForDomainRequestTypeDef:
return {
"DomainName": ...,
}
# ListVpcEndpointsForDomainRequestTypeDef definition
class ListVpcEndpointsForDomainRequestTypeDef(TypedDict):
DomainName: str,
NextToken: NotRequired[str],ListVpcEndpointsRequestTypeDef#
# ListVpcEndpointsRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import ListVpcEndpointsRequestTypeDef
def get_value() -> ListVpcEndpointsRequestTypeDef:
return {
"NextToken": ...,
}
# ListVpcEndpointsRequestTypeDef definition
class ListVpcEndpointsRequestTypeDef(TypedDict):
NextToken: NotRequired[str],PurchaseReservedElasticsearchInstanceOfferingRequestTypeDef#
# PurchaseReservedElasticsearchInstanceOfferingRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import PurchaseReservedElasticsearchInstanceOfferingRequestTypeDef
def get_value() -> PurchaseReservedElasticsearchInstanceOfferingRequestTypeDef:
return {
"ReservedElasticsearchInstanceOfferingId": ...,
}
# PurchaseReservedElasticsearchInstanceOfferingRequestTypeDef definition
class PurchaseReservedElasticsearchInstanceOfferingRequestTypeDef(TypedDict):
ReservedElasticsearchInstanceOfferingId: str,
ReservationName: str,
InstanceCount: NotRequired[int],RecurringChargeTypeDef#
# RecurringChargeTypeDef TypedDict usage example
from types_boto3_es.type_defs import RecurringChargeTypeDef
def get_value() -> RecurringChargeTypeDef:
return {
"RecurringChargeAmount": ...,
}
# RecurringChargeTypeDef definition
class RecurringChargeTypeDef(TypedDict):
RecurringChargeAmount: NotRequired[float],
RecurringChargeFrequency: NotRequired[str],RejectInboundCrossClusterSearchConnectionRequestTypeDef#
# RejectInboundCrossClusterSearchConnectionRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import RejectInboundCrossClusterSearchConnectionRequestTypeDef
def get_value() -> RejectInboundCrossClusterSearchConnectionRequestTypeDef:
return {
"CrossClusterSearchConnectionId": ...,
}
# RejectInboundCrossClusterSearchConnectionRequestTypeDef definition
class RejectInboundCrossClusterSearchConnectionRequestTypeDef(TypedDict):
CrossClusterSearchConnectionId: str,RemoveTagsRequestTypeDef#
# RemoveTagsRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import RemoveTagsRequestTypeDef
def get_value() -> RemoveTagsRequestTypeDef:
return {
"ARN": ...,
}
# RemoveTagsRequestTypeDef definition
class RemoveTagsRequestTypeDef(TypedDict):
ARN: str,
TagKeys: Sequence[str],RevokeVpcEndpointAccessRequestTypeDef#
# RevokeVpcEndpointAccessRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import RevokeVpcEndpointAccessRequestTypeDef
def get_value() -> RevokeVpcEndpointAccessRequestTypeDef:
return {
"DomainName": ...,
}
# RevokeVpcEndpointAccessRequestTypeDef definition
class RevokeVpcEndpointAccessRequestTypeDef(TypedDict):
DomainName: str,
Account: str,SAMLIdpTypeDef#
# SAMLIdpTypeDef TypedDict usage example
from types_boto3_es.type_defs import SAMLIdpTypeDef
def get_value() -> SAMLIdpTypeDef:
return {
"MetadataContent": ...,
}
# SAMLIdpTypeDef definition
class SAMLIdpTypeDef(TypedDict):
MetadataContent: str,
EntityId: str,StartElasticsearchServiceSoftwareUpdateRequestTypeDef#
# StartElasticsearchServiceSoftwareUpdateRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import StartElasticsearchServiceSoftwareUpdateRequestTypeDef
def get_value() -> StartElasticsearchServiceSoftwareUpdateRequestTypeDef:
return {
"DomainName": ...,
}
# StartElasticsearchServiceSoftwareUpdateRequestTypeDef definition
class StartElasticsearchServiceSoftwareUpdateRequestTypeDef(TypedDict):
DomainName: str,StorageTypeLimitTypeDef#
# StorageTypeLimitTypeDef TypedDict usage example
from types_boto3_es.type_defs import StorageTypeLimitTypeDef
def get_value() -> StorageTypeLimitTypeDef:
return {
"LimitName": ...,
}
# StorageTypeLimitTypeDef definition
class StorageTypeLimitTypeDef(TypedDict):
LimitName: NotRequired[str],
LimitValues: NotRequired[List[str]],UpgradeElasticsearchDomainRequestTypeDef#
# UpgradeElasticsearchDomainRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import UpgradeElasticsearchDomainRequestTypeDef
def get_value() -> UpgradeElasticsearchDomainRequestTypeDef:
return {
"DomainName": ...,
}
# UpgradeElasticsearchDomainRequestTypeDef definition
class UpgradeElasticsearchDomainRequestTypeDef(TypedDict):
DomainName: str,
TargetVersion: str,
PerformCheckOnly: NotRequired[bool],UpgradeStepItemTypeDef#
# UpgradeStepItemTypeDef TypedDict usage example
from types_boto3_es.type_defs import UpgradeStepItemTypeDef
def get_value() -> UpgradeStepItemTypeDef:
return {
"UpgradeStep": ...,
}
# UpgradeStepItemTypeDef definition
class UpgradeStepItemTypeDef(TypedDict):
UpgradeStep: NotRequired[UpgradeStepType], # (1)
UpgradeStepStatus: NotRequired[UpgradeStatusType], # (2)
Issues: NotRequired[List[str]],
ProgressPercent: NotRequired[float],- See UpgradeStepType
- See UpgradeStatusType
EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef TypedDict usage example
from types_boto3_es.type_defs import EmptyResponseMetadataTypeDef
def get_value() -> EmptyResponseMetadataTypeDef:
return {
"ResponseMetadata": ...,
}
# EmptyResponseMetadataTypeDef definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)GetUpgradeStatusResponseTypeDef#
# GetUpgradeStatusResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import GetUpgradeStatusResponseTypeDef
def get_value() -> GetUpgradeStatusResponseTypeDef:
return {
"UpgradeStep": ...,
}
# GetUpgradeStatusResponseTypeDef definition
class GetUpgradeStatusResponseTypeDef(TypedDict):
UpgradeStep: UpgradeStepType, # (1)
StepStatus: UpgradeStatusType, # (2)
UpgradeName: str,
ResponseMetadata: ResponseMetadataTypeDef, # (3)- See UpgradeStepType
- See UpgradeStatusType
- See ResponseMetadataTypeDef
ListElasticsearchInstanceTypesResponseTypeDef#
# ListElasticsearchInstanceTypesResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import ListElasticsearchInstanceTypesResponseTypeDef
def get_value() -> ListElasticsearchInstanceTypesResponseTypeDef:
return {
"ElasticsearchInstanceTypes": ...,
}
# ListElasticsearchInstanceTypesResponseTypeDef definition
class ListElasticsearchInstanceTypesResponseTypeDef(TypedDict):
ElasticsearchInstanceTypes: List[ESPartitionInstanceTypeType], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],ListElasticsearchVersionsResponseTypeDef#
# ListElasticsearchVersionsResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import ListElasticsearchVersionsResponseTypeDef
def get_value() -> ListElasticsearchVersionsResponseTypeDef:
return {
"ElasticsearchVersions": ...,
}
# ListElasticsearchVersionsResponseTypeDef definition
class ListElasticsearchVersionsResponseTypeDef(TypedDict):
ElasticsearchVersions: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
NextToken: NotRequired[str],PurchaseReservedElasticsearchInstanceOfferingResponseTypeDef#
# PurchaseReservedElasticsearchInstanceOfferingResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import PurchaseReservedElasticsearchInstanceOfferingResponseTypeDef
def get_value() -> PurchaseReservedElasticsearchInstanceOfferingResponseTypeDef:
return {
"ReservedElasticsearchInstanceId": ...,
}
# PurchaseReservedElasticsearchInstanceOfferingResponseTypeDef definition
class PurchaseReservedElasticsearchInstanceOfferingResponseTypeDef(TypedDict):
ReservedElasticsearchInstanceId: str,
ReservationName: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)AccessPoliciesStatusTypeDef#
# AccessPoliciesStatusTypeDef TypedDict usage example
from types_boto3_es.type_defs import AccessPoliciesStatusTypeDef
def get_value() -> AccessPoliciesStatusTypeDef:
return {
"Options": ...,
}
# AccessPoliciesStatusTypeDef definition
class AccessPoliciesStatusTypeDef(TypedDict):
Options: str,
Status: OptionStatusTypeDef, # (1)AdvancedOptionsStatusTypeDef#
# AdvancedOptionsStatusTypeDef TypedDict usage example
from types_boto3_es.type_defs import AdvancedOptionsStatusTypeDef
def get_value() -> AdvancedOptionsStatusTypeDef:
return {
"Options": ...,
}
# AdvancedOptionsStatusTypeDef definition
class AdvancedOptionsStatusTypeDef(TypedDict):
Options: Dict[str, str],
Status: OptionStatusTypeDef, # (1)ElasticsearchVersionStatusTypeDef#
# ElasticsearchVersionStatusTypeDef TypedDict usage example
from types_boto3_es.type_defs import ElasticsearchVersionStatusTypeDef
def get_value() -> ElasticsearchVersionStatusTypeDef:
return {
"Options": ...,
}
# ElasticsearchVersionStatusTypeDef definition
class ElasticsearchVersionStatusTypeDef(TypedDict):
Options: str,
Status: OptionStatusTypeDef, # (1)AddTagsRequestTypeDef#
# AddTagsRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import AddTagsRequestTypeDef
def get_value() -> AddTagsRequestTypeDef:
return {
"ARN": ...,
}
# AddTagsRequestTypeDef definition
class AddTagsRequestTypeDef(TypedDict):
ARN: str,
TagList: Sequence[TagTypeDef], # (1)- See TagTypeDef
ListTagsResponseTypeDef#
# ListTagsResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import ListTagsResponseTypeDef
def get_value() -> ListTagsResponseTypeDef:
return {
"TagList": ...,
}
# ListTagsResponseTypeDef definition
class ListTagsResponseTypeDef(TypedDict):
TagList: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See TagTypeDef
- See ResponseMetadataTypeDef
AuthorizeVpcEndpointAccessResponseTypeDef#
# AuthorizeVpcEndpointAccessResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import AuthorizeVpcEndpointAccessResponseTypeDef
def get_value() -> AuthorizeVpcEndpointAccessResponseTypeDef:
return {
"AuthorizedPrincipal": ...,
}
# AuthorizeVpcEndpointAccessResponseTypeDef definition
class AuthorizeVpcEndpointAccessResponseTypeDef(TypedDict):
AuthorizedPrincipal: AuthorizedPrincipalTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListVpcEndpointAccessResponseTypeDef#
# ListVpcEndpointAccessResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import ListVpcEndpointAccessResponseTypeDef
def get_value() -> ListVpcEndpointAccessResponseTypeDef:
return {
"AuthorizedPrincipalList": ...,
}
# ListVpcEndpointAccessResponseTypeDef definition
class ListVpcEndpointAccessResponseTypeDef(TypedDict):
AuthorizedPrincipalList: List[AuthorizedPrincipalTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)AutoTuneDetailsTypeDef#
# AutoTuneDetailsTypeDef TypedDict usage example
from types_boto3_es.type_defs import AutoTuneDetailsTypeDef
def get_value() -> AutoTuneDetailsTypeDef:
return {
"ScheduledAutoTuneDetails": ...,
}
# AutoTuneDetailsTypeDef definition
class AutoTuneDetailsTypeDef(TypedDict):
ScheduledAutoTuneDetails: NotRequired[ScheduledAutoTuneDetailsTypeDef], # (1)AutoTuneMaintenanceScheduleOutputTypeDef#
# AutoTuneMaintenanceScheduleOutputTypeDef TypedDict usage example
from types_boto3_es.type_defs import AutoTuneMaintenanceScheduleOutputTypeDef
def get_value() -> AutoTuneMaintenanceScheduleOutputTypeDef:
return {
"StartAt": ...,
}
# AutoTuneMaintenanceScheduleOutputTypeDef definition
class AutoTuneMaintenanceScheduleOutputTypeDef(TypedDict):
StartAt: NotRequired[datetime],
Duration: NotRequired[DurationTypeDef], # (1)
CronExpressionForRecurrence: NotRequired[str],- See DurationTypeDef
AutoTuneMaintenanceScheduleTypeDef#
# AutoTuneMaintenanceScheduleTypeDef TypedDict usage example
from types_boto3_es.type_defs import AutoTuneMaintenanceScheduleTypeDef
def get_value() -> AutoTuneMaintenanceScheduleTypeDef:
return {
"StartAt": ...,
}
# AutoTuneMaintenanceScheduleTypeDef definition
class AutoTuneMaintenanceScheduleTypeDef(TypedDict):
StartAt: NotRequired[TimestampTypeDef],
Duration: NotRequired[DurationTypeDef], # (1)
CronExpressionForRecurrence: NotRequired[str],- See DurationTypeDef
CancelDomainConfigChangeResponseTypeDef#
# CancelDomainConfigChangeResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import CancelDomainConfigChangeResponseTypeDef
def get_value() -> CancelDomainConfigChangeResponseTypeDef:
return {
"DryRun": ...,
}
# CancelDomainConfigChangeResponseTypeDef definition
class CancelDomainConfigChangeResponseTypeDef(TypedDict):
DryRun: bool,
CancelledChangeIds: List[str],
CancelledChangeProperties: List[CancelledChangePropertyTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)CancelElasticsearchServiceSoftwareUpdateResponseTypeDef#
# CancelElasticsearchServiceSoftwareUpdateResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import CancelElasticsearchServiceSoftwareUpdateResponseTypeDef
def get_value() -> CancelElasticsearchServiceSoftwareUpdateResponseTypeDef:
return {
"ServiceSoftwareOptions": ...,
}
# CancelElasticsearchServiceSoftwareUpdateResponseTypeDef definition
class CancelElasticsearchServiceSoftwareUpdateResponseTypeDef(TypedDict):
ServiceSoftwareOptions: ServiceSoftwareOptionsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)StartElasticsearchServiceSoftwareUpdateResponseTypeDef#
# StartElasticsearchServiceSoftwareUpdateResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import StartElasticsearchServiceSoftwareUpdateResponseTypeDef
def get_value() -> StartElasticsearchServiceSoftwareUpdateResponseTypeDef:
return {
"ServiceSoftwareOptions": ...,
}
# StartElasticsearchServiceSoftwareUpdateResponseTypeDef definition
class StartElasticsearchServiceSoftwareUpdateResponseTypeDef(TypedDict):
ServiceSoftwareOptions: ServiceSoftwareOptionsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)UpgradeElasticsearchDomainResponseTypeDef#
# UpgradeElasticsearchDomainResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import UpgradeElasticsearchDomainResponseTypeDef
def get_value() -> UpgradeElasticsearchDomainResponseTypeDef:
return {
"DomainName": ...,
}
# UpgradeElasticsearchDomainResponseTypeDef definition
class UpgradeElasticsearchDomainResponseTypeDef(TypedDict):
DomainName: str,
TargetVersion: str,
PerformCheckOnly: bool,
ChangeProgressDetails: ChangeProgressDetailsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ChangeProgressStatusDetailsTypeDef#
# ChangeProgressStatusDetailsTypeDef TypedDict usage example
from types_boto3_es.type_defs import ChangeProgressStatusDetailsTypeDef
def get_value() -> ChangeProgressStatusDetailsTypeDef:
return {
"ChangeId": ...,
}
# ChangeProgressStatusDetailsTypeDef definition
class ChangeProgressStatusDetailsTypeDef(TypedDict):
ChangeId: NotRequired[str],
StartTime: NotRequired[datetime],
Status: NotRequired[OverallChangeStatusType], # (1)
PendingProperties: NotRequired[List[str]],
CompletedProperties: NotRequired[List[str]],
TotalNumberOfStages: NotRequired[int],
ChangeProgressStages: NotRequired[List[ChangeProgressStageTypeDef]], # (2)
ConfigChangeStatus: NotRequired[ConfigChangeStatusType], # (3)
LastUpdatedTime: NotRequired[datetime],
InitiatedBy: NotRequired[InitiatedByType], # (4)- See OverallChangeStatusType
- See ChangeProgressStageTypeDef
- See ConfigChangeStatusType
- See InitiatedByType
CognitoOptionsStatusTypeDef#
# CognitoOptionsStatusTypeDef TypedDict usage example
from types_boto3_es.type_defs import CognitoOptionsStatusTypeDef
def get_value() -> CognitoOptionsStatusTypeDef:
return {
"Options": ...,
}
# CognitoOptionsStatusTypeDef definition
class CognitoOptionsStatusTypeDef(TypedDict):
Options: CognitoOptionsTypeDef, # (1)
Status: OptionStatusTypeDef, # (2)GetCompatibleElasticsearchVersionsResponseTypeDef#
# GetCompatibleElasticsearchVersionsResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import GetCompatibleElasticsearchVersionsResponseTypeDef
def get_value() -> GetCompatibleElasticsearchVersionsResponseTypeDef:
return {
"CompatibleElasticsearchVersions": ...,
}
# GetCompatibleElasticsearchVersionsResponseTypeDef definition
class GetCompatibleElasticsearchVersionsResponseTypeDef(TypedDict):
CompatibleElasticsearchVersions: List[CompatibleVersionsMapTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DomainEndpointOptionsStatusTypeDef#
# DomainEndpointOptionsStatusTypeDef TypedDict usage example
from types_boto3_es.type_defs import DomainEndpointOptionsStatusTypeDef
def get_value() -> DomainEndpointOptionsStatusTypeDef:
return {
"Options": ...,
}
# DomainEndpointOptionsStatusTypeDef definition
class DomainEndpointOptionsStatusTypeDef(TypedDict):
Options: DomainEndpointOptionsTypeDef, # (1)
Status: OptionStatusTypeDef, # (2)EBSOptionsStatusTypeDef#
# EBSOptionsStatusTypeDef TypedDict usage example
from types_boto3_es.type_defs import EBSOptionsStatusTypeDef
def get_value() -> EBSOptionsStatusTypeDef:
return {
"Options": ...,
}
# EBSOptionsStatusTypeDef definition
class EBSOptionsStatusTypeDef(TypedDict):
Options: EBSOptionsTypeDef, # (1)
Status: OptionStatusTypeDef, # (2)- See EBSOptionsTypeDef
- See OptionStatusTypeDef
EncryptionAtRestOptionsStatusTypeDef#
# EncryptionAtRestOptionsStatusTypeDef TypedDict usage example
from types_boto3_es.type_defs import EncryptionAtRestOptionsStatusTypeDef
def get_value() -> EncryptionAtRestOptionsStatusTypeDef:
return {
"Options": ...,
}
# EncryptionAtRestOptionsStatusTypeDef definition
class EncryptionAtRestOptionsStatusTypeDef(TypedDict):
Options: EncryptionAtRestOptionsTypeDef, # (1)
Status: OptionStatusTypeDef, # (2)LogPublishingOptionsStatusTypeDef#
# LogPublishingOptionsStatusTypeDef TypedDict usage example
from types_boto3_es.type_defs import LogPublishingOptionsStatusTypeDef
def get_value() -> LogPublishingOptionsStatusTypeDef:
return {
"Options": ...,
}
# LogPublishingOptionsStatusTypeDef definition
class LogPublishingOptionsStatusTypeDef(TypedDict):
Options: NotRequired[Dict[LogTypeType, LogPublishingOptionTypeDef]], # (1)
Status: NotRequired[OptionStatusTypeDef], # (2)NodeToNodeEncryptionOptionsStatusTypeDef#
# NodeToNodeEncryptionOptionsStatusTypeDef TypedDict usage example
from types_boto3_es.type_defs import NodeToNodeEncryptionOptionsStatusTypeDef
def get_value() -> NodeToNodeEncryptionOptionsStatusTypeDef:
return {
"Options": ...,
}
# NodeToNodeEncryptionOptionsStatusTypeDef definition
class NodeToNodeEncryptionOptionsStatusTypeDef(TypedDict):
Options: NodeToNodeEncryptionOptionsTypeDef, # (1)
Status: OptionStatusTypeDef, # (2)SnapshotOptionsStatusTypeDef#
# SnapshotOptionsStatusTypeDef TypedDict usage example
from types_boto3_es.type_defs import SnapshotOptionsStatusTypeDef
def get_value() -> SnapshotOptionsStatusTypeDef:
return {
"Options": ...,
}
# SnapshotOptionsStatusTypeDef definition
class SnapshotOptionsStatusTypeDef(TypedDict):
Options: SnapshotOptionsTypeDef, # (1)
Status: OptionStatusTypeDef, # (2)CreateVpcEndpointRequestTypeDef#
# CreateVpcEndpointRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import CreateVpcEndpointRequestTypeDef
def get_value() -> CreateVpcEndpointRequestTypeDef:
return {
"DomainArn": ...,
}
# CreateVpcEndpointRequestTypeDef definition
class CreateVpcEndpointRequestTypeDef(TypedDict):
DomainArn: str,
VpcOptions: VPCOptionsTypeDef, # (1)
ClientToken: NotRequired[str],UpdateVpcEndpointRequestTypeDef#
# UpdateVpcEndpointRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import UpdateVpcEndpointRequestTypeDef
def get_value() -> UpdateVpcEndpointRequestTypeDef:
return {
"VpcEndpointId": ...,
}
# UpdateVpcEndpointRequestTypeDef definition
class UpdateVpcEndpointRequestTypeDef(TypedDict):
VpcEndpointId: str,
VpcOptions: VPCOptionsTypeDef, # (1)CreateOutboundCrossClusterSearchConnectionRequestTypeDef#
# CreateOutboundCrossClusterSearchConnectionRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import CreateOutboundCrossClusterSearchConnectionRequestTypeDef
def get_value() -> CreateOutboundCrossClusterSearchConnectionRequestTypeDef:
return {
"SourceDomainInfo": ...,
}
# CreateOutboundCrossClusterSearchConnectionRequestTypeDef definition
class CreateOutboundCrossClusterSearchConnectionRequestTypeDef(TypedDict):
SourceDomainInfo: DomainInformationTypeDef, # (1)
DestinationDomainInfo: DomainInformationTypeDef, # (1)
ConnectionAlias: str,CreateOutboundCrossClusterSearchConnectionResponseTypeDef#
# CreateOutboundCrossClusterSearchConnectionResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import CreateOutboundCrossClusterSearchConnectionResponseTypeDef
def get_value() -> CreateOutboundCrossClusterSearchConnectionResponseTypeDef:
return {
"SourceDomainInfo": ...,
}
# CreateOutboundCrossClusterSearchConnectionResponseTypeDef definition
class CreateOutboundCrossClusterSearchConnectionResponseTypeDef(TypedDict):
SourceDomainInfo: DomainInformationTypeDef, # (1)
DestinationDomainInfo: DomainInformationTypeDef, # (1)
ConnectionAlias: str,
ConnectionStatus: OutboundCrossClusterSearchConnectionStatusTypeDef, # (3)
CrossClusterSearchConnectionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (4)- See DomainInformationTypeDef
- See DomainInformationTypeDef
- See OutboundCrossClusterSearchConnectionStatusTypeDef
- See ResponseMetadataTypeDef
OutboundCrossClusterSearchConnectionTypeDef#
# OutboundCrossClusterSearchConnectionTypeDef TypedDict usage example
from types_boto3_es.type_defs import OutboundCrossClusterSearchConnectionTypeDef
def get_value() -> OutboundCrossClusterSearchConnectionTypeDef:
return {
"SourceDomainInfo": ...,
}
# OutboundCrossClusterSearchConnectionTypeDef definition
class OutboundCrossClusterSearchConnectionTypeDef(TypedDict):
SourceDomainInfo: NotRequired[DomainInformationTypeDef], # (1)
DestinationDomainInfo: NotRequired[DomainInformationTypeDef], # (1)
CrossClusterSearchConnectionId: NotRequired[str],
ConnectionAlias: NotRequired[str],
ConnectionStatus: NotRequired[OutboundCrossClusterSearchConnectionStatusTypeDef], # (3)- See DomainInformationTypeDef
- See DomainInformationTypeDef
- See OutboundCrossClusterSearchConnectionStatusTypeDef
CreatePackageRequestTypeDef#
# CreatePackageRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import CreatePackageRequestTypeDef
def get_value() -> CreatePackageRequestTypeDef:
return {
"PackageName": ...,
}
# CreatePackageRequestTypeDef definition
class CreatePackageRequestTypeDef(TypedDict):
PackageName: str,
PackageType: PackageTypeType, # (1)
PackageSource: PackageSourceTypeDef, # (2)
PackageDescription: NotRequired[str],- See PackageTypeType
- See PackageSourceTypeDef
UpdatePackageRequestTypeDef#
# UpdatePackageRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import UpdatePackageRequestTypeDef
def get_value() -> UpdatePackageRequestTypeDef:
return {
"PackageID": ...,
}
# UpdatePackageRequestTypeDef definition
class UpdatePackageRequestTypeDef(TypedDict):
PackageID: str,
PackageSource: PackageSourceTypeDef, # (1)
PackageDescription: NotRequired[str],
CommitMessage: NotRequired[str],DeleteVpcEndpointResponseTypeDef#
# DeleteVpcEndpointResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import DeleteVpcEndpointResponseTypeDef
def get_value() -> DeleteVpcEndpointResponseTypeDef:
return {
"VpcEndpointSummary": ...,
}
# DeleteVpcEndpointResponseTypeDef definition
class DeleteVpcEndpointResponseTypeDef(TypedDict):
VpcEndpointSummary: VpcEndpointSummaryTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListVpcEndpointsForDomainResponseTypeDef#
# ListVpcEndpointsForDomainResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import ListVpcEndpointsForDomainResponseTypeDef
def get_value() -> ListVpcEndpointsForDomainResponseTypeDef:
return {
"VpcEndpointSummaryList": ...,
}
# ListVpcEndpointsForDomainResponseTypeDef definition
class ListVpcEndpointsForDomainResponseTypeDef(TypedDict):
VpcEndpointSummaryList: List[VpcEndpointSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListVpcEndpointsResponseTypeDef#
# ListVpcEndpointsResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import ListVpcEndpointsResponseTypeDef
def get_value() -> ListVpcEndpointsResponseTypeDef:
return {
"VpcEndpointSummaryList": ...,
}
# ListVpcEndpointsResponseTypeDef definition
class ListVpcEndpointsResponseTypeDef(TypedDict):
VpcEndpointSummaryList: List[VpcEndpointSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)DescribeInboundCrossClusterSearchConnectionsRequestTypeDef#
# DescribeInboundCrossClusterSearchConnectionsRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import DescribeInboundCrossClusterSearchConnectionsRequestTypeDef
def get_value() -> DescribeInboundCrossClusterSearchConnectionsRequestTypeDef:
return {
"Filters": ...,
}
# DescribeInboundCrossClusterSearchConnectionsRequestTypeDef definition
class DescribeInboundCrossClusterSearchConnectionsRequestTypeDef(TypedDict):
Filters: NotRequired[Sequence[FilterTypeDef]], # (1)
MaxResults: NotRequired[int],
NextToken: NotRequired[str],- See FilterTypeDef
DescribeOutboundCrossClusterSearchConnectionsRequestTypeDef#
# DescribeOutboundCrossClusterSearchConnectionsRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import DescribeOutboundCrossClusterSearchConnectionsRequestTypeDef
def get_value() -> DescribeOutboundCrossClusterSearchConnectionsRequestTypeDef:
return {
"Filters": ...,
}
# DescribeOutboundCrossClusterSearchConnectionsRequestTypeDef definition
class DescribeOutboundCrossClusterSearchConnectionsRequestTypeDef(TypedDict):
Filters: NotRequired[Sequence[FilterTypeDef]], # (1)
MaxResults: NotRequired[int],
NextToken: NotRequired[str],- See FilterTypeDef
DescribePackagesRequestTypeDef#
# DescribePackagesRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import DescribePackagesRequestTypeDef
def get_value() -> DescribePackagesRequestTypeDef:
return {
"Filters": ...,
}
# DescribePackagesRequestTypeDef definition
class DescribePackagesRequestTypeDef(TypedDict):
Filters: NotRequired[Sequence[DescribePackagesFilterTypeDef]], # (1)
MaxResults: NotRequired[int],
NextToken: NotRequired[str],DescribeReservedElasticsearchInstanceOfferingsRequestPaginateTypeDef#
# DescribeReservedElasticsearchInstanceOfferingsRequestPaginateTypeDef TypedDict usage example
from types_boto3_es.type_defs import DescribeReservedElasticsearchInstanceOfferingsRequestPaginateTypeDef
def get_value() -> DescribeReservedElasticsearchInstanceOfferingsRequestPaginateTypeDef:
return {
"ReservedElasticsearchInstanceOfferingId": ...,
}
# DescribeReservedElasticsearchInstanceOfferingsRequestPaginateTypeDef definition
class DescribeReservedElasticsearchInstanceOfferingsRequestPaginateTypeDef(TypedDict):
ReservedElasticsearchInstanceOfferingId: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)DescribeReservedElasticsearchInstancesRequestPaginateTypeDef#
# DescribeReservedElasticsearchInstancesRequestPaginateTypeDef TypedDict usage example
from types_boto3_es.type_defs import DescribeReservedElasticsearchInstancesRequestPaginateTypeDef
def get_value() -> DescribeReservedElasticsearchInstancesRequestPaginateTypeDef:
return {
"ReservedElasticsearchInstanceId": ...,
}
# DescribeReservedElasticsearchInstancesRequestPaginateTypeDef definition
class DescribeReservedElasticsearchInstancesRequestPaginateTypeDef(TypedDict):
ReservedElasticsearchInstanceId: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)GetUpgradeHistoryRequestPaginateTypeDef#
# GetUpgradeHistoryRequestPaginateTypeDef TypedDict usage example
from types_boto3_es.type_defs import GetUpgradeHistoryRequestPaginateTypeDef
def get_value() -> GetUpgradeHistoryRequestPaginateTypeDef:
return {
"DomainName": ...,
}
# GetUpgradeHistoryRequestPaginateTypeDef definition
class GetUpgradeHistoryRequestPaginateTypeDef(TypedDict):
DomainName: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListElasticsearchInstanceTypesRequestPaginateTypeDef#
# ListElasticsearchInstanceTypesRequestPaginateTypeDef TypedDict usage example
from types_boto3_es.type_defs import ListElasticsearchInstanceTypesRequestPaginateTypeDef
def get_value() -> ListElasticsearchInstanceTypesRequestPaginateTypeDef:
return {
"ElasticsearchVersion": ...,
}
# ListElasticsearchInstanceTypesRequestPaginateTypeDef definition
class ListElasticsearchInstanceTypesRequestPaginateTypeDef(TypedDict):
ElasticsearchVersion: str,
DomainName: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListElasticsearchVersionsRequestPaginateTypeDef#
# ListElasticsearchVersionsRequestPaginateTypeDef TypedDict usage example
from types_boto3_es.type_defs import ListElasticsearchVersionsRequestPaginateTypeDef
def get_value() -> ListElasticsearchVersionsRequestPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# ListElasticsearchVersionsRequestPaginateTypeDef definition
class ListElasticsearchVersionsRequestPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListDomainNamesResponseTypeDef#
# ListDomainNamesResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import ListDomainNamesResponseTypeDef
def get_value() -> ListDomainNamesResponseTypeDef:
return {
"DomainNames": ...,
}
# ListDomainNamesResponseTypeDef definition
class ListDomainNamesResponseTypeDef(TypedDict):
DomainNames: List[DomainInfoTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DomainPackageDetailsTypeDef#
# DomainPackageDetailsTypeDef TypedDict usage example
from types_boto3_es.type_defs import DomainPackageDetailsTypeDef
def get_value() -> DomainPackageDetailsTypeDef:
return {
"PackageID": ...,
}
# DomainPackageDetailsTypeDef definition
class DomainPackageDetailsTypeDef(TypedDict):
PackageID: NotRequired[str],
PackageName: NotRequired[str],
PackageType: NotRequired[PackageTypeType], # (1)
LastUpdated: NotRequired[datetime],
DomainName: NotRequired[str],
DomainPackageStatus: NotRequired[DomainPackageStatusType], # (2)
PackageVersion: NotRequired[str],
ReferencePath: NotRequired[str],
ErrorDetails: NotRequired[ErrorDetailsTypeDef], # (3)PackageDetailsTypeDef#
# PackageDetailsTypeDef TypedDict usage example
from types_boto3_es.type_defs import PackageDetailsTypeDef
def get_value() -> PackageDetailsTypeDef:
return {
"PackageID": ...,
}
# PackageDetailsTypeDef definition
class PackageDetailsTypeDef(TypedDict):
PackageID: NotRequired[str],
PackageName: NotRequired[str],
PackageType: NotRequired[PackageTypeType], # (1)
PackageDescription: NotRequired[str],
PackageStatus: NotRequired[PackageStatusType], # (2)
CreatedAt: NotRequired[datetime],
LastUpdatedAt: NotRequired[datetime],
AvailablePackageVersion: NotRequired[str],
ErrorDetails: NotRequired[ErrorDetailsTypeDef], # (3)- See PackageTypeType
- See PackageStatusType
- See ErrorDetailsTypeDef
ElasticsearchClusterConfigTypeDef#
# ElasticsearchClusterConfigTypeDef TypedDict usage example
from types_boto3_es.type_defs import ElasticsearchClusterConfigTypeDef
def get_value() -> ElasticsearchClusterConfigTypeDef:
return {
"InstanceType": ...,
}
# ElasticsearchClusterConfigTypeDef 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)- See ESPartitionInstanceTypeType
- See ZoneAwarenessConfigTypeDef
- See ESPartitionInstanceTypeType
- See ESWarmPartitionInstanceTypeType
- See ColdStorageOptionsTypeDef
VPCDerivedInfoStatusTypeDef#
# VPCDerivedInfoStatusTypeDef TypedDict usage example
from types_boto3_es.type_defs import VPCDerivedInfoStatusTypeDef
def get_value() -> VPCDerivedInfoStatusTypeDef:
return {
"Options": ...,
}
# VPCDerivedInfoStatusTypeDef definition
class VPCDerivedInfoStatusTypeDef(TypedDict):
Options: VPCDerivedInfoTypeDef, # (1)
Status: OptionStatusTypeDef, # (2)VpcEndpointTypeDef#
# VpcEndpointTypeDef TypedDict usage example
from types_boto3_es.type_defs import VpcEndpointTypeDef
def get_value() -> VpcEndpointTypeDef:
return {
"VpcEndpointId": ...,
}
# VpcEndpointTypeDef definition
class VpcEndpointTypeDef(TypedDict):
VpcEndpointId: NotRequired[str],
VpcEndpointOwner: NotRequired[str],
DomainArn: NotRequired[str],
VpcOptions: NotRequired[VPCDerivedInfoTypeDef], # (1)
Status: NotRequired[VpcEndpointStatusType], # (2)
Endpoint: NotRequired[str],GetPackageVersionHistoryResponseTypeDef#
# GetPackageVersionHistoryResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import GetPackageVersionHistoryResponseTypeDef
def get_value() -> GetPackageVersionHistoryResponseTypeDef:
return {
"PackageID": ...,
}
# GetPackageVersionHistoryResponseTypeDef definition
class GetPackageVersionHistoryResponseTypeDef(TypedDict):
PackageID: str,
PackageVersionHistoryList: List[PackageVersionHistoryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],InboundCrossClusterSearchConnectionTypeDef#
# InboundCrossClusterSearchConnectionTypeDef TypedDict usage example
from types_boto3_es.type_defs import InboundCrossClusterSearchConnectionTypeDef
def get_value() -> InboundCrossClusterSearchConnectionTypeDef:
return {
"SourceDomainInfo": ...,
}
# InboundCrossClusterSearchConnectionTypeDef definition
class InboundCrossClusterSearchConnectionTypeDef(TypedDict):
SourceDomainInfo: NotRequired[DomainInformationTypeDef], # (1)
DestinationDomainInfo: NotRequired[DomainInformationTypeDef], # (1)
CrossClusterSearchConnectionId: NotRequired[str],
ConnectionStatus: NotRequired[InboundCrossClusterSearchConnectionStatusTypeDef], # (3)- See DomainInformationTypeDef
- See DomainInformationTypeDef
- See InboundCrossClusterSearchConnectionStatusTypeDef
InstanceLimitsTypeDef#
# InstanceLimitsTypeDef TypedDict usage example
from types_boto3_es.type_defs import InstanceLimitsTypeDef
def get_value() -> InstanceLimitsTypeDef:
return {
"InstanceCountLimits": ...,
}
# InstanceLimitsTypeDef definition
class InstanceLimitsTypeDef(TypedDict):
InstanceCountLimits: NotRequired[InstanceCountLimitsTypeDef], # (1)ReservedElasticsearchInstanceOfferingTypeDef#
# ReservedElasticsearchInstanceOfferingTypeDef TypedDict usage example
from types_boto3_es.type_defs import ReservedElasticsearchInstanceOfferingTypeDef
def get_value() -> ReservedElasticsearchInstanceOfferingTypeDef:
return {
"ReservedElasticsearchInstanceOfferingId": ...,
}
# ReservedElasticsearchInstanceOfferingTypeDef 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)- See ESPartitionInstanceTypeType
- See ReservedElasticsearchInstancePaymentOptionType
- See RecurringChargeTypeDef
ReservedElasticsearchInstanceTypeDef#
# ReservedElasticsearchInstanceTypeDef TypedDict usage example
from types_boto3_es.type_defs import ReservedElasticsearchInstanceTypeDef
def get_value() -> ReservedElasticsearchInstanceTypeDef:
return {
"ReservationName": ...,
}
# ReservedElasticsearchInstanceTypeDef 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)- See ESPartitionInstanceTypeType
- See ReservedElasticsearchInstancePaymentOptionType
- See RecurringChargeTypeDef
SAMLOptionsInputTypeDef#
# SAMLOptionsInputTypeDef TypedDict usage example
from types_boto3_es.type_defs import SAMLOptionsInputTypeDef
def get_value() -> SAMLOptionsInputTypeDef:
return {
"Enabled": ...,
}
# SAMLOptionsInputTypeDef definition
class SAMLOptionsInputTypeDef(TypedDict):
Enabled: NotRequired[bool],
Idp: NotRequired[SAMLIdpTypeDef], # (1)
MasterUserName: NotRequired[str],
MasterBackendRole: NotRequired[str],
SubjectKey: NotRequired[str],
RolesKey: NotRequired[str],
SessionTimeoutMinutes: NotRequired[int],- See SAMLIdpTypeDef
SAMLOptionsOutputTypeDef#
# SAMLOptionsOutputTypeDef TypedDict usage example
from types_boto3_es.type_defs import SAMLOptionsOutputTypeDef
def get_value() -> SAMLOptionsOutputTypeDef:
return {
"Enabled": ...,
}
# SAMLOptionsOutputTypeDef definition
class SAMLOptionsOutputTypeDef(TypedDict):
Enabled: NotRequired[bool],
Idp: NotRequired[SAMLIdpTypeDef], # (1)
SubjectKey: NotRequired[str],
RolesKey: NotRequired[str],
SessionTimeoutMinutes: NotRequired[int],- See SAMLIdpTypeDef
StorageTypeTypeDef#
# StorageTypeTypeDef TypedDict usage example
from types_boto3_es.type_defs import StorageTypeTypeDef
def get_value() -> StorageTypeTypeDef:
return {
"StorageTypeName": ...,
}
# StorageTypeTypeDef definition
class StorageTypeTypeDef(TypedDict):
StorageTypeName: NotRequired[str],
StorageSubTypeName: NotRequired[str],
StorageTypeLimits: NotRequired[List[StorageTypeLimitTypeDef]], # (1)UpgradeHistoryTypeDef#
# UpgradeHistoryTypeDef TypedDict usage example
from types_boto3_es.type_defs import UpgradeHistoryTypeDef
def get_value() -> UpgradeHistoryTypeDef:
return {
"UpgradeName": ...,
}
# UpgradeHistoryTypeDef definition
class UpgradeHistoryTypeDef(TypedDict):
UpgradeName: NotRequired[str],
StartTimestamp: NotRequired[datetime],
UpgradeStatus: NotRequired[UpgradeStatusType], # (1)
StepsList: NotRequired[List[UpgradeStepItemTypeDef]], # (2)AutoTuneTypeDef#
# AutoTuneTypeDef TypedDict usage example
from types_boto3_es.type_defs import AutoTuneTypeDef
def get_value() -> AutoTuneTypeDef:
return {
"AutoTuneType": ...,
}
# AutoTuneTypeDef definition
class AutoTuneTypeDef(TypedDict):
AutoTuneType: NotRequired[AutoTuneTypeType], # (1)
AutoTuneDetails: NotRequired[AutoTuneDetailsTypeDef], # (2)AutoTuneOptionsExtraTypeDef#
# AutoTuneOptionsExtraTypeDef TypedDict usage example
from types_boto3_es.type_defs import AutoTuneOptionsExtraTypeDef
def get_value() -> AutoTuneOptionsExtraTypeDef:
return {
"DesiredState": ...,
}
# AutoTuneOptionsExtraTypeDef definition
class AutoTuneOptionsExtraTypeDef(TypedDict):
DesiredState: NotRequired[AutoTuneDesiredStateType], # (1)
RollbackOnDisable: NotRequired[RollbackOnDisableType], # (2)
MaintenanceSchedules: NotRequired[List[AutoTuneMaintenanceScheduleOutputTypeDef]], # (3)AutoTuneOptionsTypeDef#
# AutoTuneOptionsTypeDef TypedDict usage example
from types_boto3_es.type_defs import AutoTuneOptionsTypeDef
def get_value() -> AutoTuneOptionsTypeDef:
return {
"DesiredState": ...,
}
# AutoTuneOptionsTypeDef definition
class AutoTuneOptionsTypeDef(TypedDict):
DesiredState: NotRequired[AutoTuneDesiredStateType], # (1)
RollbackOnDisable: NotRequired[RollbackOnDisableType], # (2)
MaintenanceSchedules: NotRequired[Sequence[AutoTuneMaintenanceScheduleTypeDef]], # (3)DescribeDomainChangeProgressResponseTypeDef#
# DescribeDomainChangeProgressResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import DescribeDomainChangeProgressResponseTypeDef
def get_value() -> DescribeDomainChangeProgressResponseTypeDef:
return {
"ChangeProgressStatus": ...,
}
# DescribeDomainChangeProgressResponseTypeDef definition
class DescribeDomainChangeProgressResponseTypeDef(TypedDict):
ChangeProgressStatus: ChangeProgressStatusDetailsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DeleteOutboundCrossClusterSearchConnectionResponseTypeDef#
# DeleteOutboundCrossClusterSearchConnectionResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import DeleteOutboundCrossClusterSearchConnectionResponseTypeDef
def get_value() -> DeleteOutboundCrossClusterSearchConnectionResponseTypeDef:
return {
"CrossClusterSearchConnection": ...,
}
# DeleteOutboundCrossClusterSearchConnectionResponseTypeDef definition
class DeleteOutboundCrossClusterSearchConnectionResponseTypeDef(TypedDict):
CrossClusterSearchConnection: OutboundCrossClusterSearchConnectionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DescribeOutboundCrossClusterSearchConnectionsResponseTypeDef#
# DescribeOutboundCrossClusterSearchConnectionsResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import DescribeOutboundCrossClusterSearchConnectionsResponseTypeDef
def get_value() -> DescribeOutboundCrossClusterSearchConnectionsResponseTypeDef:
return {
"CrossClusterSearchConnections": ...,
}
# DescribeOutboundCrossClusterSearchConnectionsResponseTypeDef definition
class DescribeOutboundCrossClusterSearchConnectionsResponseTypeDef(TypedDict):
CrossClusterSearchConnections: List[OutboundCrossClusterSearchConnectionTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],AssociatePackageResponseTypeDef#
# AssociatePackageResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import AssociatePackageResponseTypeDef
def get_value() -> AssociatePackageResponseTypeDef:
return {
"DomainPackageDetails": ...,
}
# AssociatePackageResponseTypeDef definition
class AssociatePackageResponseTypeDef(TypedDict):
DomainPackageDetails: DomainPackageDetailsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DissociatePackageResponseTypeDef#
# DissociatePackageResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import DissociatePackageResponseTypeDef
def get_value() -> DissociatePackageResponseTypeDef:
return {
"DomainPackageDetails": ...,
}
# DissociatePackageResponseTypeDef definition
class DissociatePackageResponseTypeDef(TypedDict):
DomainPackageDetails: DomainPackageDetailsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListDomainsForPackageResponseTypeDef#
# ListDomainsForPackageResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import ListDomainsForPackageResponseTypeDef
def get_value() -> ListDomainsForPackageResponseTypeDef:
return {
"DomainPackageDetailsList": ...,
}
# ListDomainsForPackageResponseTypeDef definition
class ListDomainsForPackageResponseTypeDef(TypedDict):
DomainPackageDetailsList: List[DomainPackageDetailsTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],ListPackagesForDomainResponseTypeDef#
# ListPackagesForDomainResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import ListPackagesForDomainResponseTypeDef
def get_value() -> ListPackagesForDomainResponseTypeDef:
return {
"DomainPackageDetailsList": ...,
}
# ListPackagesForDomainResponseTypeDef definition
class ListPackagesForDomainResponseTypeDef(TypedDict):
DomainPackageDetailsList: List[DomainPackageDetailsTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],CreatePackageResponseTypeDef#
# CreatePackageResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import CreatePackageResponseTypeDef
def get_value() -> CreatePackageResponseTypeDef:
return {
"PackageDetails": ...,
}
# CreatePackageResponseTypeDef definition
class CreatePackageResponseTypeDef(TypedDict):
PackageDetails: PackageDetailsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DeletePackageResponseTypeDef#
# DeletePackageResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import DeletePackageResponseTypeDef
def get_value() -> DeletePackageResponseTypeDef:
return {
"PackageDetails": ...,
}
# DeletePackageResponseTypeDef definition
class DeletePackageResponseTypeDef(TypedDict):
PackageDetails: PackageDetailsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DescribePackagesResponseTypeDef#
# DescribePackagesResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import DescribePackagesResponseTypeDef
def get_value() -> DescribePackagesResponseTypeDef:
return {
"PackageDetailsList": ...,
}
# DescribePackagesResponseTypeDef definition
class DescribePackagesResponseTypeDef(TypedDict):
PackageDetailsList: List[PackageDetailsTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],UpdatePackageResponseTypeDef#
# UpdatePackageResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import UpdatePackageResponseTypeDef
def get_value() -> UpdatePackageResponseTypeDef:
return {
"PackageDetails": ...,
}
# UpdatePackageResponseTypeDef definition
class UpdatePackageResponseTypeDef(TypedDict):
PackageDetails: PackageDetailsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ElasticsearchClusterConfigStatusTypeDef#
# ElasticsearchClusterConfigStatusTypeDef TypedDict usage example
from types_boto3_es.type_defs import ElasticsearchClusterConfigStatusTypeDef
def get_value() -> ElasticsearchClusterConfigStatusTypeDef:
return {
"Options": ...,
}
# ElasticsearchClusterConfigStatusTypeDef definition
class ElasticsearchClusterConfigStatusTypeDef(TypedDict):
Options: ElasticsearchClusterConfigTypeDef, # (1)
Status: OptionStatusTypeDef, # (2)CreateVpcEndpointResponseTypeDef#
# CreateVpcEndpointResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import CreateVpcEndpointResponseTypeDef
def get_value() -> CreateVpcEndpointResponseTypeDef:
return {
"VpcEndpoint": ...,
}
# CreateVpcEndpointResponseTypeDef definition
class CreateVpcEndpointResponseTypeDef(TypedDict):
VpcEndpoint: VpcEndpointTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DescribeVpcEndpointsResponseTypeDef#
# DescribeVpcEndpointsResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import DescribeVpcEndpointsResponseTypeDef
def get_value() -> DescribeVpcEndpointsResponseTypeDef:
return {
"VpcEndpoints": ...,
}
# DescribeVpcEndpointsResponseTypeDef definition
class DescribeVpcEndpointsResponseTypeDef(TypedDict):
VpcEndpoints: List[VpcEndpointTypeDef], # (1)
VpcEndpointErrors: List[VpcEndpointErrorTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)UpdateVpcEndpointResponseTypeDef#
# UpdateVpcEndpointResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import UpdateVpcEndpointResponseTypeDef
def get_value() -> UpdateVpcEndpointResponseTypeDef:
return {
"VpcEndpoint": ...,
}
# UpdateVpcEndpointResponseTypeDef definition
class UpdateVpcEndpointResponseTypeDef(TypedDict):
VpcEndpoint: VpcEndpointTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)AcceptInboundCrossClusterSearchConnectionResponseTypeDef#
# AcceptInboundCrossClusterSearchConnectionResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import AcceptInboundCrossClusterSearchConnectionResponseTypeDef
def get_value() -> AcceptInboundCrossClusterSearchConnectionResponseTypeDef:
return {
"CrossClusterSearchConnection": ...,
}
# AcceptInboundCrossClusterSearchConnectionResponseTypeDef definition
class AcceptInboundCrossClusterSearchConnectionResponseTypeDef(TypedDict):
CrossClusterSearchConnection: InboundCrossClusterSearchConnectionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DeleteInboundCrossClusterSearchConnectionResponseTypeDef#
# DeleteInboundCrossClusterSearchConnectionResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import DeleteInboundCrossClusterSearchConnectionResponseTypeDef
def get_value() -> DeleteInboundCrossClusterSearchConnectionResponseTypeDef:
return {
"CrossClusterSearchConnection": ...,
}
# DeleteInboundCrossClusterSearchConnectionResponseTypeDef definition
class DeleteInboundCrossClusterSearchConnectionResponseTypeDef(TypedDict):
CrossClusterSearchConnection: InboundCrossClusterSearchConnectionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DescribeInboundCrossClusterSearchConnectionsResponseTypeDef#
# DescribeInboundCrossClusterSearchConnectionsResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import DescribeInboundCrossClusterSearchConnectionsResponseTypeDef
def get_value() -> DescribeInboundCrossClusterSearchConnectionsResponseTypeDef:
return {
"CrossClusterSearchConnections": ...,
}
# DescribeInboundCrossClusterSearchConnectionsResponseTypeDef definition
class DescribeInboundCrossClusterSearchConnectionsResponseTypeDef(TypedDict):
CrossClusterSearchConnections: List[InboundCrossClusterSearchConnectionTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],RejectInboundCrossClusterSearchConnectionResponseTypeDef#
# RejectInboundCrossClusterSearchConnectionResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import RejectInboundCrossClusterSearchConnectionResponseTypeDef
def get_value() -> RejectInboundCrossClusterSearchConnectionResponseTypeDef:
return {
"CrossClusterSearchConnection": ...,
}
# RejectInboundCrossClusterSearchConnectionResponseTypeDef definition
class RejectInboundCrossClusterSearchConnectionResponseTypeDef(TypedDict):
CrossClusterSearchConnection: InboundCrossClusterSearchConnectionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DescribeReservedElasticsearchInstanceOfferingsResponseTypeDef#
# DescribeReservedElasticsearchInstanceOfferingsResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import DescribeReservedElasticsearchInstanceOfferingsResponseTypeDef
def get_value() -> DescribeReservedElasticsearchInstanceOfferingsResponseTypeDef:
return {
"NextToken": ...,
}
# DescribeReservedElasticsearchInstanceOfferingsResponseTypeDef definition
class DescribeReservedElasticsearchInstanceOfferingsResponseTypeDef(TypedDict):
ReservedElasticsearchInstanceOfferings: List[ReservedElasticsearchInstanceOfferingTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],DescribeReservedElasticsearchInstancesResponseTypeDef#
# DescribeReservedElasticsearchInstancesResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import DescribeReservedElasticsearchInstancesResponseTypeDef
def get_value() -> DescribeReservedElasticsearchInstancesResponseTypeDef:
return {
"NextToken": ...,
}
# DescribeReservedElasticsearchInstancesResponseTypeDef definition
class DescribeReservedElasticsearchInstancesResponseTypeDef(TypedDict):
ReservedElasticsearchInstances: List[ReservedElasticsearchInstanceTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],AdvancedSecurityOptionsInputTypeDef#
# AdvancedSecurityOptionsInputTypeDef TypedDict usage example
from types_boto3_es.type_defs import AdvancedSecurityOptionsInputTypeDef
def get_value() -> AdvancedSecurityOptionsInputTypeDef:
return {
"Enabled": ...,
}
# AdvancedSecurityOptionsInputTypeDef definition
class AdvancedSecurityOptionsInputTypeDef(TypedDict):
Enabled: NotRequired[bool],
InternalUserDatabaseEnabled: NotRequired[bool],
MasterUserOptions: NotRequired[MasterUserOptionsTypeDef], # (1)
SAMLOptions: NotRequired[SAMLOptionsInputTypeDef], # (2)
AnonymousAuthEnabled: NotRequired[bool],AdvancedSecurityOptionsTypeDef#
# AdvancedSecurityOptionsTypeDef TypedDict usage example
from types_boto3_es.type_defs import AdvancedSecurityOptionsTypeDef
def get_value() -> AdvancedSecurityOptionsTypeDef:
return {
"Enabled": ...,
}
# AdvancedSecurityOptionsTypeDef definition
class AdvancedSecurityOptionsTypeDef(TypedDict):
Enabled: NotRequired[bool],
InternalUserDatabaseEnabled: NotRequired[bool],
SAMLOptions: NotRequired[SAMLOptionsOutputTypeDef], # (1)
AnonymousAuthDisableDate: NotRequired[datetime],
AnonymousAuthEnabled: NotRequired[bool],LimitsTypeDef#
# LimitsTypeDef TypedDict usage example
from types_boto3_es.type_defs import LimitsTypeDef
def get_value() -> LimitsTypeDef:
return {
"StorageTypes": ...,
}
# LimitsTypeDef definition
class LimitsTypeDef(TypedDict):
StorageTypes: NotRequired[List[StorageTypeTypeDef]], # (1)
InstanceLimits: NotRequired[InstanceLimitsTypeDef], # (2)
AdditionalLimits: NotRequired[List[AdditionalLimitTypeDef]], # (3)GetUpgradeHistoryResponseTypeDef#
# GetUpgradeHistoryResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import GetUpgradeHistoryResponseTypeDef
def get_value() -> GetUpgradeHistoryResponseTypeDef:
return {
"UpgradeHistories": ...,
}
# GetUpgradeHistoryResponseTypeDef definition
class GetUpgradeHistoryResponseTypeDef(TypedDict):
UpgradeHistories: List[UpgradeHistoryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],DescribeDomainAutoTunesResponseTypeDef#
# DescribeDomainAutoTunesResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import DescribeDomainAutoTunesResponseTypeDef
def get_value() -> DescribeDomainAutoTunesResponseTypeDef:
return {
"AutoTunes": ...,
}
# DescribeDomainAutoTunesResponseTypeDef definition
class DescribeDomainAutoTunesResponseTypeDef(TypedDict):
AutoTunes: List[AutoTuneTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],AutoTuneOptionsStatusTypeDef#
# AutoTuneOptionsStatusTypeDef TypedDict usage example
from types_boto3_es.type_defs import AutoTuneOptionsStatusTypeDef
def get_value() -> AutoTuneOptionsStatusTypeDef:
return {
"Options": ...,
}
# AutoTuneOptionsStatusTypeDef definition
class AutoTuneOptionsStatusTypeDef(TypedDict):
Options: NotRequired[AutoTuneOptionsExtraTypeDef], # (1)
Status: NotRequired[AutoTuneStatusTypeDef], # (2)AutoTuneOptionsInputTypeDef#
# AutoTuneOptionsInputTypeDef TypedDict usage example
from types_boto3_es.type_defs import AutoTuneOptionsInputTypeDef
def get_value() -> AutoTuneOptionsInputTypeDef:
return {
"DesiredState": ...,
}
# AutoTuneOptionsInputTypeDef definition
class AutoTuneOptionsInputTypeDef(TypedDict):
DesiredState: NotRequired[AutoTuneDesiredStateType], # (1)
MaintenanceSchedules: NotRequired[Sequence[AutoTuneMaintenanceScheduleUnionTypeDef]], # (2)- See AutoTuneDesiredStateType
- See AutoTuneMaintenanceScheduleTypeDef AutoTuneMaintenanceScheduleOutputTypeDef
AdvancedSecurityOptionsStatusTypeDef#
# AdvancedSecurityOptionsStatusTypeDef TypedDict usage example
from types_boto3_es.type_defs import AdvancedSecurityOptionsStatusTypeDef
def get_value() -> AdvancedSecurityOptionsStatusTypeDef:
return {
"Options": ...,
}
# AdvancedSecurityOptionsStatusTypeDef definition
class AdvancedSecurityOptionsStatusTypeDef(TypedDict):
Options: AdvancedSecurityOptionsTypeDef, # (1)
Status: OptionStatusTypeDef, # (2)ElasticsearchDomainStatusTypeDef#
# ElasticsearchDomainStatusTypeDef TypedDict usage example
from types_boto3_es.type_defs import ElasticsearchDomainStatusTypeDef
def get_value() -> ElasticsearchDomainStatusTypeDef:
return {
"DomainId": ...,
}
# ElasticsearchDomainStatusTypeDef definition
class ElasticsearchDomainStatusTypeDef(TypedDict):
DomainId: str,
DomainName: str,
ARN: str,
ElasticsearchClusterConfig: ElasticsearchClusterConfigTypeDef, # (1)
Created: NotRequired[bool],
Deleted: NotRequired[bool],
Endpoint: NotRequired[str],
Endpoints: NotRequired[Dict[str, str]],
Processing: NotRequired[bool],
UpgradeProcessing: NotRequired[bool],
ElasticsearchVersion: NotRequired[str],
EBSOptions: NotRequired[EBSOptionsTypeDef], # (2)
AccessPolicies: NotRequired[str],
SnapshotOptions: NotRequired[SnapshotOptionsTypeDef], # (3)
VPCOptions: NotRequired[VPCDerivedInfoTypeDef], # (4)
CognitoOptions: NotRequired[CognitoOptionsTypeDef], # (5)
EncryptionAtRestOptions: NotRequired[EncryptionAtRestOptionsTypeDef], # (6)
NodeToNodeEncryptionOptions: NotRequired[NodeToNodeEncryptionOptionsTypeDef], # (7)
AdvancedOptions: NotRequired[Dict[str, str]],
LogPublishingOptions: NotRequired[Dict[LogTypeType, LogPublishingOptionTypeDef]], # (8)
ServiceSoftwareOptions: NotRequired[ServiceSoftwareOptionsTypeDef], # (9)
DomainEndpointOptions: NotRequired[DomainEndpointOptionsTypeDef], # (10)
AdvancedSecurityOptions: NotRequired[AdvancedSecurityOptionsTypeDef], # (11)
AutoTuneOptions: NotRequired[AutoTuneOptionsOutputTypeDef], # (12)
ChangeProgressDetails: NotRequired[ChangeProgressDetailsTypeDef], # (13)
DomainProcessingStatus: NotRequired[DomainProcessingStatusTypeType], # (14)
ModifyingProperties: NotRequired[List[ModifyingPropertiesTypeDef]], # (15)- See ElasticsearchClusterConfigTypeDef
- See EBSOptionsTypeDef
- See SnapshotOptionsTypeDef
- See VPCDerivedInfoTypeDef
- See CognitoOptionsTypeDef
- See EncryptionAtRestOptionsTypeDef
- See NodeToNodeEncryptionOptionsTypeDef
- See LogTypeType LogPublishingOptionTypeDef
- See ServiceSoftwareOptionsTypeDef
- See DomainEndpointOptionsTypeDef
- See AdvancedSecurityOptionsTypeDef
- See AutoTuneOptionsOutputTypeDef
- See ChangeProgressDetailsTypeDef
- See DomainProcessingStatusTypeType
- See ModifyingPropertiesTypeDef
DescribeElasticsearchInstanceTypeLimitsResponseTypeDef#
# DescribeElasticsearchInstanceTypeLimitsResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import DescribeElasticsearchInstanceTypeLimitsResponseTypeDef
def get_value() -> DescribeElasticsearchInstanceTypeLimitsResponseTypeDef:
return {
"LimitsByRole": ...,
}
# DescribeElasticsearchInstanceTypeLimitsResponseTypeDef definition
class DescribeElasticsearchInstanceTypeLimitsResponseTypeDef(TypedDict):
LimitsByRole: Dict[str, LimitsTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See LimitsTypeDef
- See ResponseMetadataTypeDef
CreateElasticsearchDomainRequestTypeDef#
# CreateElasticsearchDomainRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import CreateElasticsearchDomainRequestTypeDef
def get_value() -> CreateElasticsearchDomainRequestTypeDef:
return {
"DomainName": ...,
}
# CreateElasticsearchDomainRequestTypeDef definition
class CreateElasticsearchDomainRequestTypeDef(TypedDict):
DomainName: str,
ElasticsearchVersion: NotRequired[str],
ElasticsearchClusterConfig: NotRequired[ElasticsearchClusterConfigTypeDef], # (1)
EBSOptions: NotRequired[EBSOptionsTypeDef], # (2)
AccessPolicies: NotRequired[str],
SnapshotOptions: NotRequired[SnapshotOptionsTypeDef], # (3)
VPCOptions: NotRequired[VPCOptionsTypeDef], # (4)
CognitoOptions: NotRequired[CognitoOptionsTypeDef], # (5)
EncryptionAtRestOptions: NotRequired[EncryptionAtRestOptionsTypeDef], # (6)
NodeToNodeEncryptionOptions: NotRequired[NodeToNodeEncryptionOptionsTypeDef], # (7)
AdvancedOptions: NotRequired[Mapping[str, str]],
LogPublishingOptions: NotRequired[Mapping[LogTypeType, LogPublishingOptionTypeDef]], # (8)
DomainEndpointOptions: NotRequired[DomainEndpointOptionsTypeDef], # (9)
AdvancedSecurityOptions: NotRequired[AdvancedSecurityOptionsInputTypeDef], # (10)
AutoTuneOptions: NotRequired[AutoTuneOptionsInputTypeDef], # (11)
TagList: NotRequired[Sequence[TagTypeDef]], # (12)- See ElasticsearchClusterConfigTypeDef
- See EBSOptionsTypeDef
- See SnapshotOptionsTypeDef
- See VPCOptionsTypeDef
- See CognitoOptionsTypeDef
- See EncryptionAtRestOptionsTypeDef
- See NodeToNodeEncryptionOptionsTypeDef
- See LogTypeType LogPublishingOptionTypeDef
- See DomainEndpointOptionsTypeDef
- See AdvancedSecurityOptionsInputTypeDef
- See AutoTuneOptionsInputTypeDef
- See TagTypeDef
UpdateElasticsearchDomainConfigRequestTypeDef#
# UpdateElasticsearchDomainConfigRequestTypeDef TypedDict usage example
from types_boto3_es.type_defs import UpdateElasticsearchDomainConfigRequestTypeDef
def get_value() -> UpdateElasticsearchDomainConfigRequestTypeDef:
return {
"DomainName": ...,
}
# UpdateElasticsearchDomainConfigRequestTypeDef definition
class UpdateElasticsearchDomainConfigRequestTypeDef(TypedDict):
DomainName: str,
ElasticsearchClusterConfig: NotRequired[ElasticsearchClusterConfigTypeDef], # (1)
EBSOptions: NotRequired[EBSOptionsTypeDef], # (2)
SnapshotOptions: NotRequired[SnapshotOptionsTypeDef], # (3)
VPCOptions: NotRequired[VPCOptionsTypeDef], # (4)
CognitoOptions: NotRequired[CognitoOptionsTypeDef], # (5)
AdvancedOptions: NotRequired[Mapping[str, str]],
AccessPolicies: NotRequired[str],
LogPublishingOptions: NotRequired[Mapping[LogTypeType, LogPublishingOptionTypeDef]], # (6)
DomainEndpointOptions: NotRequired[DomainEndpointOptionsTypeDef], # (7)
AdvancedSecurityOptions: NotRequired[AdvancedSecurityOptionsInputTypeDef], # (8)
NodeToNodeEncryptionOptions: NotRequired[NodeToNodeEncryptionOptionsTypeDef], # (9)
EncryptionAtRestOptions: NotRequired[EncryptionAtRestOptionsTypeDef], # (10)
AutoTuneOptions: NotRequired[AutoTuneOptionsUnionTypeDef], # (11)
DryRun: NotRequired[bool],- See ElasticsearchClusterConfigTypeDef
- See EBSOptionsTypeDef
- See SnapshotOptionsTypeDef
- See VPCOptionsTypeDef
- See CognitoOptionsTypeDef
- See LogTypeType LogPublishingOptionTypeDef
- See DomainEndpointOptionsTypeDef
- See AdvancedSecurityOptionsInputTypeDef
- See NodeToNodeEncryptionOptionsTypeDef
- See EncryptionAtRestOptionsTypeDef
- See AutoTuneOptionsTypeDef AutoTuneOptionsExtraTypeDef
ElasticsearchDomainConfigTypeDef#
# ElasticsearchDomainConfigTypeDef TypedDict usage example
from types_boto3_es.type_defs import ElasticsearchDomainConfigTypeDef
def get_value() -> ElasticsearchDomainConfigTypeDef:
return {
"ElasticsearchVersion": ...,
}
# ElasticsearchDomainConfigTypeDef definition
class ElasticsearchDomainConfigTypeDef(TypedDict):
ElasticsearchVersion: NotRequired[ElasticsearchVersionStatusTypeDef], # (1)
ElasticsearchClusterConfig: NotRequired[ElasticsearchClusterConfigStatusTypeDef], # (2)
EBSOptions: NotRequired[EBSOptionsStatusTypeDef], # (3)
AccessPolicies: NotRequired[AccessPoliciesStatusTypeDef], # (4)
SnapshotOptions: NotRequired[SnapshotOptionsStatusTypeDef], # (5)
VPCOptions: NotRequired[VPCDerivedInfoStatusTypeDef], # (6)
CognitoOptions: NotRequired[CognitoOptionsStatusTypeDef], # (7)
EncryptionAtRestOptions: NotRequired[EncryptionAtRestOptionsStatusTypeDef], # (8)
NodeToNodeEncryptionOptions: NotRequired[NodeToNodeEncryptionOptionsStatusTypeDef], # (9)
AdvancedOptions: NotRequired[AdvancedOptionsStatusTypeDef], # (10)
LogPublishingOptions: NotRequired[LogPublishingOptionsStatusTypeDef], # (11)
DomainEndpointOptions: NotRequired[DomainEndpointOptionsStatusTypeDef], # (12)
AdvancedSecurityOptions: NotRequired[AdvancedSecurityOptionsStatusTypeDef], # (13)
AutoTuneOptions: NotRequired[AutoTuneOptionsStatusTypeDef], # (14)
ChangeProgressDetails: NotRequired[ChangeProgressDetailsTypeDef], # (15)
ModifyingProperties: NotRequired[List[ModifyingPropertiesTypeDef]], # (16)- See ElasticsearchVersionStatusTypeDef
- See ElasticsearchClusterConfigStatusTypeDef
- See EBSOptionsStatusTypeDef
- See AccessPoliciesStatusTypeDef
- See SnapshotOptionsStatusTypeDef
- See VPCDerivedInfoStatusTypeDef
- See CognitoOptionsStatusTypeDef
- See EncryptionAtRestOptionsStatusTypeDef
- See NodeToNodeEncryptionOptionsStatusTypeDef
- See AdvancedOptionsStatusTypeDef
- See LogPublishingOptionsStatusTypeDef
- See DomainEndpointOptionsStatusTypeDef
- See AdvancedSecurityOptionsStatusTypeDef
- See AutoTuneOptionsStatusTypeDef
- See ChangeProgressDetailsTypeDef
- See ModifyingPropertiesTypeDef
CreateElasticsearchDomainResponseTypeDef#
# CreateElasticsearchDomainResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import CreateElasticsearchDomainResponseTypeDef
def get_value() -> CreateElasticsearchDomainResponseTypeDef:
return {
"DomainStatus": ...,
}
# CreateElasticsearchDomainResponseTypeDef definition
class CreateElasticsearchDomainResponseTypeDef(TypedDict):
DomainStatus: ElasticsearchDomainStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DeleteElasticsearchDomainResponseTypeDef#
# DeleteElasticsearchDomainResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import DeleteElasticsearchDomainResponseTypeDef
def get_value() -> DeleteElasticsearchDomainResponseTypeDef:
return {
"DomainStatus": ...,
}
# DeleteElasticsearchDomainResponseTypeDef definition
class DeleteElasticsearchDomainResponseTypeDef(TypedDict):
DomainStatus: ElasticsearchDomainStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DescribeElasticsearchDomainResponseTypeDef#
# DescribeElasticsearchDomainResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import DescribeElasticsearchDomainResponseTypeDef
def get_value() -> DescribeElasticsearchDomainResponseTypeDef:
return {
"DomainStatus": ...,
}
# DescribeElasticsearchDomainResponseTypeDef definition
class DescribeElasticsearchDomainResponseTypeDef(TypedDict):
DomainStatus: ElasticsearchDomainStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DescribeElasticsearchDomainsResponseTypeDef#
# DescribeElasticsearchDomainsResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import DescribeElasticsearchDomainsResponseTypeDef
def get_value() -> DescribeElasticsearchDomainsResponseTypeDef:
return {
"DomainStatusList": ...,
}
# DescribeElasticsearchDomainsResponseTypeDef definition
class DescribeElasticsearchDomainsResponseTypeDef(TypedDict):
DomainStatusList: List[ElasticsearchDomainStatusTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DescribeElasticsearchDomainConfigResponseTypeDef#
# DescribeElasticsearchDomainConfigResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import DescribeElasticsearchDomainConfigResponseTypeDef
def get_value() -> DescribeElasticsearchDomainConfigResponseTypeDef:
return {
"DomainConfig": ...,
}
# DescribeElasticsearchDomainConfigResponseTypeDef definition
class DescribeElasticsearchDomainConfigResponseTypeDef(TypedDict):
DomainConfig: ElasticsearchDomainConfigTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)UpdateElasticsearchDomainConfigResponseTypeDef#
# UpdateElasticsearchDomainConfigResponseTypeDef TypedDict usage example
from types_boto3_es.type_defs import UpdateElasticsearchDomainConfigResponseTypeDef
def get_value() -> UpdateElasticsearchDomainConfigResponseTypeDef:
return {
"DomainConfig": ...,
}
# UpdateElasticsearchDomainConfigResponseTypeDef definition
class UpdateElasticsearchDomainConfigResponseTypeDef(TypedDict):
DomainConfig: ElasticsearchDomainConfigTypeDef, # (1)
DryRunResults: DryRunResultsTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)