Typed dictionaries#
Index > CloudSearch > Typed dictionaries
Auto-generated documentation for CloudSearch type annotations stubs module mypy-boto3-cloudsearch.
OptionStatusTypeDef#
# OptionStatusTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import OptionStatusTypeDef
def get_value() -> OptionStatusTypeDef:
return {
"CreationDate": ...,
"UpdateDate": ...,
"State": ...,
}
# OptionStatusTypeDef definition
class OptionStatusTypeDef(TypedDict):
CreationDate: datetime,
UpdateDate: datetime,
State: OptionStateType, # (1)
UpdateVersion: NotRequired[int],
PendingDeletion: NotRequired[bool],
- See OptionStateType
AnalysisOptionsTypeDef#
# AnalysisOptionsTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import AnalysisOptionsTypeDef
def get_value() -> AnalysisOptionsTypeDef:
return {
"Synonyms": ...,
}
# AnalysisOptionsTypeDef definition
class AnalysisOptionsTypeDef(TypedDict):
Synonyms: NotRequired[str],
Stopwords: NotRequired[str],
StemmingDictionary: NotRequired[str],
JapaneseTokenizationDictionary: NotRequired[str],
AlgorithmicStemming: NotRequired[AlgorithmicStemmingType], # (1)
BuildSuggestersRequestRequestTypeDef#
# BuildSuggestersRequestRequestTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import BuildSuggestersRequestRequestTypeDef
def get_value() -> BuildSuggestersRequestRequestTypeDef:
return {
"DomainName": ...,
}
# BuildSuggestersRequestRequestTypeDef definition
class BuildSuggestersRequestRequestTypeDef(TypedDict):
DomainName: str,
BuildSuggestersResponseTypeDef#
# BuildSuggestersResponseTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import BuildSuggestersResponseTypeDef
def get_value() -> BuildSuggestersResponseTypeDef:
return {
"FieldNames": ...,
"ResponseMetadata": ...,
}
# BuildSuggestersResponseTypeDef definition
class BuildSuggestersResponseTypeDef(TypedDict):
FieldNames: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateDomainRequestRequestTypeDef#
# CreateDomainRequestRequestTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import CreateDomainRequestRequestTypeDef
def get_value() -> CreateDomainRequestRequestTypeDef:
return {
"DomainName": ...,
}
# CreateDomainRequestRequestTypeDef definition
class CreateDomainRequestRequestTypeDef(TypedDict):
DomainName: str,
DateArrayOptionsTypeDef#
# DateArrayOptionsTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DateArrayOptionsTypeDef
def get_value() -> DateArrayOptionsTypeDef:
return {
"DefaultValue": ...,
}
# DateArrayOptionsTypeDef definition
class DateArrayOptionsTypeDef(TypedDict):
DefaultValue: NotRequired[str],
SourceFields: NotRequired[str],
FacetEnabled: NotRequired[bool],
SearchEnabled: NotRequired[bool],
ReturnEnabled: NotRequired[bool],
DateOptionsTypeDef#
# DateOptionsTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DateOptionsTypeDef
def get_value() -> DateOptionsTypeDef:
return {
"DefaultValue": ...,
}
# DateOptionsTypeDef definition
class DateOptionsTypeDef(TypedDict):
DefaultValue: NotRequired[str],
SourceField: NotRequired[str],
FacetEnabled: NotRequired[bool],
SearchEnabled: NotRequired[bool],
ReturnEnabled: NotRequired[bool],
SortEnabled: NotRequired[bool],
ExpressionTypeDef#
# ExpressionTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import ExpressionTypeDef
def get_value() -> ExpressionTypeDef:
return {
"ExpressionName": ...,
"ExpressionValue": ...,
}
# ExpressionTypeDef definition
class ExpressionTypeDef(TypedDict):
ExpressionName: str,
ExpressionValue: str,
DeleteAnalysisSchemeRequestRequestTypeDef#
# DeleteAnalysisSchemeRequestRequestTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DeleteAnalysisSchemeRequestRequestTypeDef
def get_value() -> DeleteAnalysisSchemeRequestRequestTypeDef:
return {
"DomainName": ...,
"AnalysisSchemeName": ...,
}
# DeleteAnalysisSchemeRequestRequestTypeDef definition
class DeleteAnalysisSchemeRequestRequestTypeDef(TypedDict):
DomainName: str,
AnalysisSchemeName: str,
DeleteDomainRequestRequestTypeDef#
# DeleteDomainRequestRequestTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DeleteDomainRequestRequestTypeDef
def get_value() -> DeleteDomainRequestRequestTypeDef:
return {
"DomainName": ...,
}
# DeleteDomainRequestRequestTypeDef definition
class DeleteDomainRequestRequestTypeDef(TypedDict):
DomainName: str,
DeleteExpressionRequestRequestTypeDef#
# DeleteExpressionRequestRequestTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DeleteExpressionRequestRequestTypeDef
def get_value() -> DeleteExpressionRequestRequestTypeDef:
return {
"DomainName": ...,
"ExpressionName": ...,
}
# DeleteExpressionRequestRequestTypeDef definition
class DeleteExpressionRequestRequestTypeDef(TypedDict):
DomainName: str,
ExpressionName: str,
DeleteIndexFieldRequestRequestTypeDef#
# DeleteIndexFieldRequestRequestTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DeleteIndexFieldRequestRequestTypeDef
def get_value() -> DeleteIndexFieldRequestRequestTypeDef:
return {
"DomainName": ...,
"IndexFieldName": ...,
}
# DeleteIndexFieldRequestRequestTypeDef definition
class DeleteIndexFieldRequestRequestTypeDef(TypedDict):
DomainName: str,
IndexFieldName: str,
DeleteSuggesterRequestRequestTypeDef#
# DeleteSuggesterRequestRequestTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DeleteSuggesterRequestRequestTypeDef
def get_value() -> DeleteSuggesterRequestRequestTypeDef:
return {
"DomainName": ...,
"SuggesterName": ...,
}
# DeleteSuggesterRequestRequestTypeDef definition
class DeleteSuggesterRequestRequestTypeDef(TypedDict):
DomainName: str,
SuggesterName: str,
DescribeAnalysisSchemesRequestRequestTypeDef#
# DescribeAnalysisSchemesRequestRequestTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DescribeAnalysisSchemesRequestRequestTypeDef
def get_value() -> DescribeAnalysisSchemesRequestRequestTypeDef:
return {
"DomainName": ...,
}
# DescribeAnalysisSchemesRequestRequestTypeDef definition
class DescribeAnalysisSchemesRequestRequestTypeDef(TypedDict):
DomainName: str,
AnalysisSchemeNames: NotRequired[Sequence[str]],
Deployed: NotRequired[bool],
DescribeAvailabilityOptionsRequestRequestTypeDef#
# DescribeAvailabilityOptionsRequestRequestTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DescribeAvailabilityOptionsRequestRequestTypeDef
def get_value() -> DescribeAvailabilityOptionsRequestRequestTypeDef:
return {
"DomainName": ...,
}
# DescribeAvailabilityOptionsRequestRequestTypeDef definition
class DescribeAvailabilityOptionsRequestRequestTypeDef(TypedDict):
DomainName: str,
Deployed: NotRequired[bool],
DescribeDomainEndpointOptionsRequestRequestTypeDef#
# DescribeDomainEndpointOptionsRequestRequestTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DescribeDomainEndpointOptionsRequestRequestTypeDef
def get_value() -> DescribeDomainEndpointOptionsRequestRequestTypeDef:
return {
"DomainName": ...,
}
# DescribeDomainEndpointOptionsRequestRequestTypeDef definition
class DescribeDomainEndpointOptionsRequestRequestTypeDef(TypedDict):
DomainName: str,
Deployed: NotRequired[bool],
DescribeDomainsRequestRequestTypeDef#
# DescribeDomainsRequestRequestTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DescribeDomainsRequestRequestTypeDef
def get_value() -> DescribeDomainsRequestRequestTypeDef:
return {
"DomainNames": ...,
}
# DescribeDomainsRequestRequestTypeDef definition
class DescribeDomainsRequestRequestTypeDef(TypedDict):
DomainNames: NotRequired[Sequence[str]],
DescribeExpressionsRequestRequestTypeDef#
# DescribeExpressionsRequestRequestTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DescribeExpressionsRequestRequestTypeDef
def get_value() -> DescribeExpressionsRequestRequestTypeDef:
return {
"DomainName": ...,
}
# DescribeExpressionsRequestRequestTypeDef definition
class DescribeExpressionsRequestRequestTypeDef(TypedDict):
DomainName: str,
ExpressionNames: NotRequired[Sequence[str]],
Deployed: NotRequired[bool],
DescribeIndexFieldsRequestRequestTypeDef#
# DescribeIndexFieldsRequestRequestTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DescribeIndexFieldsRequestRequestTypeDef
def get_value() -> DescribeIndexFieldsRequestRequestTypeDef:
return {
"DomainName": ...,
}
# DescribeIndexFieldsRequestRequestTypeDef definition
class DescribeIndexFieldsRequestRequestTypeDef(TypedDict):
DomainName: str,
FieldNames: NotRequired[Sequence[str]],
Deployed: NotRequired[bool],
DescribeScalingParametersRequestRequestTypeDef#
# DescribeScalingParametersRequestRequestTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DescribeScalingParametersRequestRequestTypeDef
def get_value() -> DescribeScalingParametersRequestRequestTypeDef:
return {
"DomainName": ...,
}
# DescribeScalingParametersRequestRequestTypeDef definition
class DescribeScalingParametersRequestRequestTypeDef(TypedDict):
DomainName: str,
DescribeServiceAccessPoliciesRequestRequestTypeDef#
# DescribeServiceAccessPoliciesRequestRequestTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DescribeServiceAccessPoliciesRequestRequestTypeDef
def get_value() -> DescribeServiceAccessPoliciesRequestRequestTypeDef:
return {
"DomainName": ...,
}
# DescribeServiceAccessPoliciesRequestRequestTypeDef definition
class DescribeServiceAccessPoliciesRequestRequestTypeDef(TypedDict):
DomainName: str,
Deployed: NotRequired[bool],
DescribeSuggestersRequestRequestTypeDef#
# DescribeSuggestersRequestRequestTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DescribeSuggestersRequestRequestTypeDef
def get_value() -> DescribeSuggestersRequestRequestTypeDef:
return {
"DomainName": ...,
}
# DescribeSuggestersRequestRequestTypeDef definition
class DescribeSuggestersRequestRequestTypeDef(TypedDict):
DomainName: str,
SuggesterNames: NotRequired[Sequence[str]],
Deployed: NotRequired[bool],
DocumentSuggesterOptionsTypeDef#
# DocumentSuggesterOptionsTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DocumentSuggesterOptionsTypeDef
def get_value() -> DocumentSuggesterOptionsTypeDef:
return {
"SourceField": ...,
}
# DocumentSuggesterOptionsTypeDef definition
class DocumentSuggesterOptionsTypeDef(TypedDict):
SourceField: str,
FuzzyMatching: NotRequired[SuggesterFuzzyMatchingType], # (1)
SortExpression: NotRequired[str],
DomainEndpointOptionsTypeDef#
# DomainEndpointOptionsTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DomainEndpointOptionsTypeDef
def get_value() -> DomainEndpointOptionsTypeDef:
return {
"EnforceHTTPS": ...,
}
# DomainEndpointOptionsTypeDef definition
class DomainEndpointOptionsTypeDef(TypedDict):
EnforceHTTPS: NotRequired[bool],
TLSSecurityPolicy: NotRequired[TLSSecurityPolicyType], # (1)
LimitsTypeDef#
# LimitsTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import LimitsTypeDef
def get_value() -> LimitsTypeDef:
return {
"MaximumReplicationCount": ...,
"MaximumPartitionCount": ...,
}
# LimitsTypeDef definition
class LimitsTypeDef(TypedDict):
MaximumReplicationCount: int,
MaximumPartitionCount: int,
ServiceEndpointTypeDef#
# ServiceEndpointTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import ServiceEndpointTypeDef
def get_value() -> ServiceEndpointTypeDef:
return {
"Endpoint": ...,
}
# ServiceEndpointTypeDef definition
class ServiceEndpointTypeDef(TypedDict):
Endpoint: NotRequired[str],
DoubleArrayOptionsTypeDef#
# DoubleArrayOptionsTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DoubleArrayOptionsTypeDef
def get_value() -> DoubleArrayOptionsTypeDef:
return {
"DefaultValue": ...,
}
# DoubleArrayOptionsTypeDef definition
class DoubleArrayOptionsTypeDef(TypedDict):
DefaultValue: NotRequired[float],
SourceFields: NotRequired[str],
FacetEnabled: NotRequired[bool],
SearchEnabled: NotRequired[bool],
ReturnEnabled: NotRequired[bool],
DoubleOptionsTypeDef#
# DoubleOptionsTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DoubleOptionsTypeDef
def get_value() -> DoubleOptionsTypeDef:
return {
"DefaultValue": ...,
}
# DoubleOptionsTypeDef definition
class DoubleOptionsTypeDef(TypedDict):
DefaultValue: NotRequired[float],
SourceField: NotRequired[str],
FacetEnabled: NotRequired[bool],
SearchEnabled: NotRequired[bool],
ReturnEnabled: NotRequired[bool],
SortEnabled: NotRequired[bool],
IndexDocumentsRequestRequestTypeDef#
# IndexDocumentsRequestRequestTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import IndexDocumentsRequestRequestTypeDef
def get_value() -> IndexDocumentsRequestRequestTypeDef:
return {
"DomainName": ...,
}
# IndexDocumentsRequestRequestTypeDef definition
class IndexDocumentsRequestRequestTypeDef(TypedDict):
DomainName: str,
IndexDocumentsResponseTypeDef#
# IndexDocumentsResponseTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import IndexDocumentsResponseTypeDef
def get_value() -> IndexDocumentsResponseTypeDef:
return {
"FieldNames": ...,
"ResponseMetadata": ...,
}
# IndexDocumentsResponseTypeDef definition
class IndexDocumentsResponseTypeDef(TypedDict):
FieldNames: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
IntArrayOptionsTypeDef#
# IntArrayOptionsTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import IntArrayOptionsTypeDef
def get_value() -> IntArrayOptionsTypeDef:
return {
"DefaultValue": ...,
}
# IntArrayOptionsTypeDef definition
class IntArrayOptionsTypeDef(TypedDict):
DefaultValue: NotRequired[int],
SourceFields: NotRequired[str],
FacetEnabled: NotRequired[bool],
SearchEnabled: NotRequired[bool],
ReturnEnabled: NotRequired[bool],
IntOptionsTypeDef#
# IntOptionsTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import IntOptionsTypeDef
def get_value() -> IntOptionsTypeDef:
return {
"DefaultValue": ...,
}
# IntOptionsTypeDef definition
class IntOptionsTypeDef(TypedDict):
DefaultValue: NotRequired[int],
SourceField: NotRequired[str],
FacetEnabled: NotRequired[bool],
SearchEnabled: NotRequired[bool],
ReturnEnabled: NotRequired[bool],
SortEnabled: NotRequired[bool],
LatLonOptionsTypeDef#
# LatLonOptionsTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import LatLonOptionsTypeDef
def get_value() -> LatLonOptionsTypeDef:
return {
"DefaultValue": ...,
}
# LatLonOptionsTypeDef definition
class LatLonOptionsTypeDef(TypedDict):
DefaultValue: NotRequired[str],
SourceField: NotRequired[str],
FacetEnabled: NotRequired[bool],
SearchEnabled: NotRequired[bool],
ReturnEnabled: NotRequired[bool],
SortEnabled: NotRequired[bool],
LiteralArrayOptionsTypeDef#
# LiteralArrayOptionsTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import LiteralArrayOptionsTypeDef
def get_value() -> LiteralArrayOptionsTypeDef:
return {
"DefaultValue": ...,
}
# LiteralArrayOptionsTypeDef definition
class LiteralArrayOptionsTypeDef(TypedDict):
DefaultValue: NotRequired[str],
SourceFields: NotRequired[str],
FacetEnabled: NotRequired[bool],
SearchEnabled: NotRequired[bool],
ReturnEnabled: NotRequired[bool],
LiteralOptionsTypeDef#
# LiteralOptionsTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import LiteralOptionsTypeDef
def get_value() -> LiteralOptionsTypeDef:
return {
"DefaultValue": ...,
}
# LiteralOptionsTypeDef definition
class LiteralOptionsTypeDef(TypedDict):
DefaultValue: NotRequired[str],
SourceField: NotRequired[str],
FacetEnabled: NotRequired[bool],
SearchEnabled: NotRequired[bool],
ReturnEnabled: NotRequired[bool],
SortEnabled: NotRequired[bool],
TextArrayOptionsTypeDef#
# TextArrayOptionsTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import TextArrayOptionsTypeDef
def get_value() -> TextArrayOptionsTypeDef:
return {
"DefaultValue": ...,
}
# TextArrayOptionsTypeDef definition
class TextArrayOptionsTypeDef(TypedDict):
DefaultValue: NotRequired[str],
SourceFields: NotRequired[str],
ReturnEnabled: NotRequired[bool],
HighlightEnabled: NotRequired[bool],
AnalysisScheme: NotRequired[str],
TextOptionsTypeDef#
# TextOptionsTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import TextOptionsTypeDef
def get_value() -> TextOptionsTypeDef:
return {
"DefaultValue": ...,
}
# TextOptionsTypeDef definition
class TextOptionsTypeDef(TypedDict):
DefaultValue: NotRequired[str],
SourceField: NotRequired[str],
ReturnEnabled: NotRequired[bool],
SortEnabled: NotRequired[bool],
HighlightEnabled: NotRequired[bool],
AnalysisScheme: NotRequired[str],
ListDomainNamesResponseTypeDef#
# ListDomainNamesResponseTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import ListDomainNamesResponseTypeDef
def get_value() -> ListDomainNamesResponseTypeDef:
return {
"DomainNames": ...,
"ResponseMetadata": ...,
}
# ListDomainNamesResponseTypeDef definition
class ListDomainNamesResponseTypeDef(TypedDict):
DomainNames: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
ScalingParametersTypeDef#
# ScalingParametersTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import ScalingParametersTypeDef
def get_value() -> ScalingParametersTypeDef:
return {
"DesiredInstanceType": ...,
}
# ScalingParametersTypeDef definition
class ScalingParametersTypeDef(TypedDict):
DesiredInstanceType: NotRequired[PartitionInstanceTypeType], # (1)
DesiredReplicationCount: NotRequired[int],
DesiredPartitionCount: NotRequired[int],
UpdateAvailabilityOptionsRequestRequestTypeDef#
# UpdateAvailabilityOptionsRequestRequestTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import UpdateAvailabilityOptionsRequestRequestTypeDef
def get_value() -> UpdateAvailabilityOptionsRequestRequestTypeDef:
return {
"DomainName": ...,
"MultiAZ": ...,
}
# UpdateAvailabilityOptionsRequestRequestTypeDef definition
class UpdateAvailabilityOptionsRequestRequestTypeDef(TypedDict):
DomainName: str,
MultiAZ: bool,
UpdateServiceAccessPoliciesRequestRequestTypeDef#
# UpdateServiceAccessPoliciesRequestRequestTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import UpdateServiceAccessPoliciesRequestRequestTypeDef
def get_value() -> UpdateServiceAccessPoliciesRequestRequestTypeDef:
return {
"DomainName": ...,
"AccessPolicies": ...,
}
# UpdateServiceAccessPoliciesRequestRequestTypeDef definition
class UpdateServiceAccessPoliciesRequestRequestTypeDef(TypedDict):
DomainName: str,
AccessPolicies: str,
AccessPoliciesStatusTypeDef#
# AccessPoliciesStatusTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import AccessPoliciesStatusTypeDef
def get_value() -> AccessPoliciesStatusTypeDef:
return {
"Options": ...,
"Status": ...,
}
# AccessPoliciesStatusTypeDef definition
class AccessPoliciesStatusTypeDef(TypedDict):
Options: str,
Status: OptionStatusTypeDef, # (1)
AvailabilityOptionsStatusTypeDef#
# AvailabilityOptionsStatusTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import AvailabilityOptionsStatusTypeDef
def get_value() -> AvailabilityOptionsStatusTypeDef:
return {
"Options": ...,
"Status": ...,
}
# AvailabilityOptionsStatusTypeDef definition
class AvailabilityOptionsStatusTypeDef(TypedDict):
Options: bool,
Status: OptionStatusTypeDef, # (1)
AnalysisSchemeTypeDef#
# AnalysisSchemeTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import AnalysisSchemeTypeDef
def get_value() -> AnalysisSchemeTypeDef:
return {
"AnalysisSchemeName": ...,
"AnalysisSchemeLanguage": ...,
}
# AnalysisSchemeTypeDef definition
class AnalysisSchemeTypeDef(TypedDict):
AnalysisSchemeName: str,
AnalysisSchemeLanguage: AnalysisSchemeLanguageType, # (1)
AnalysisOptions: NotRequired[AnalysisOptionsTypeDef], # (2)
DefineExpressionRequestRequestTypeDef#
# DefineExpressionRequestRequestTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DefineExpressionRequestRequestTypeDef
def get_value() -> DefineExpressionRequestRequestTypeDef:
return {
"DomainName": ...,
"Expression": ...,
}
# DefineExpressionRequestRequestTypeDef definition
class DefineExpressionRequestRequestTypeDef(TypedDict):
DomainName: str,
Expression: ExpressionTypeDef, # (1)
ExpressionStatusTypeDef#
# ExpressionStatusTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import ExpressionStatusTypeDef
def get_value() -> ExpressionStatusTypeDef:
return {
"Options": ...,
"Status": ...,
}
# ExpressionStatusTypeDef definition
class ExpressionStatusTypeDef(TypedDict):
Options: ExpressionTypeDef, # (1)
Status: OptionStatusTypeDef, # (2)
- See ExpressionTypeDef
- See OptionStatusTypeDef
SuggesterTypeDef#
# SuggesterTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import SuggesterTypeDef
def get_value() -> SuggesterTypeDef:
return {
"SuggesterName": ...,
"DocumentSuggesterOptions": ...,
}
# SuggesterTypeDef definition
class SuggesterTypeDef(TypedDict):
SuggesterName: str,
DocumentSuggesterOptions: DocumentSuggesterOptionsTypeDef, # (1)
DomainEndpointOptionsStatusTypeDef#
# DomainEndpointOptionsStatusTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DomainEndpointOptionsStatusTypeDef
def get_value() -> DomainEndpointOptionsStatusTypeDef:
return {
"Options": ...,
"Status": ...,
}
# DomainEndpointOptionsStatusTypeDef definition
class DomainEndpointOptionsStatusTypeDef(TypedDict):
Options: DomainEndpointOptionsTypeDef, # (1)
Status: OptionStatusTypeDef, # (2)
UpdateDomainEndpointOptionsRequestRequestTypeDef#
# UpdateDomainEndpointOptionsRequestRequestTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import UpdateDomainEndpointOptionsRequestRequestTypeDef
def get_value() -> UpdateDomainEndpointOptionsRequestRequestTypeDef:
return {
"DomainName": ...,
"DomainEndpointOptions": ...,
}
# UpdateDomainEndpointOptionsRequestRequestTypeDef definition
class UpdateDomainEndpointOptionsRequestRequestTypeDef(TypedDict):
DomainName: str,
DomainEndpointOptions: DomainEndpointOptionsTypeDef, # (1)
DomainStatusTypeDef#
# DomainStatusTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DomainStatusTypeDef
def get_value() -> DomainStatusTypeDef:
return {
"DomainId": ...,
"DomainName": ...,
"RequiresIndexDocuments": ...,
}
# DomainStatusTypeDef definition
class DomainStatusTypeDef(TypedDict):
DomainId: str,
DomainName: str,
RequiresIndexDocuments: bool,
ARN: NotRequired[str],
Created: NotRequired[bool],
Deleted: NotRequired[bool],
DocService: NotRequired[ServiceEndpointTypeDef], # (1)
SearchService: NotRequired[ServiceEndpointTypeDef], # (1)
Processing: NotRequired[bool],
SearchInstanceType: NotRequired[str],
SearchPartitionCount: NotRequired[int],
SearchInstanceCount: NotRequired[int],
Limits: NotRequired[LimitsTypeDef], # (3)
IndexFieldTypeDef#
# IndexFieldTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import IndexFieldTypeDef
def get_value() -> IndexFieldTypeDef:
return {
"IndexFieldName": ...,
"IndexFieldType": ...,
}
# IndexFieldTypeDef definition
class IndexFieldTypeDef(TypedDict):
IndexFieldName: str,
IndexFieldType: IndexFieldTypeType, # (1)
IntOptions: NotRequired[IntOptionsTypeDef], # (2)
DoubleOptions: NotRequired[DoubleOptionsTypeDef], # (3)
LiteralOptions: NotRequired[LiteralOptionsTypeDef], # (4)
TextOptions: NotRequired[TextOptionsTypeDef], # (5)
DateOptions: NotRequired[DateOptionsTypeDef], # (6)
LatLonOptions: NotRequired[LatLonOptionsTypeDef], # (7)
IntArrayOptions: NotRequired[IntArrayOptionsTypeDef], # (8)
DoubleArrayOptions: NotRequired[DoubleArrayOptionsTypeDef], # (9)
LiteralArrayOptions: NotRequired[LiteralArrayOptionsTypeDef], # (10)
TextArrayOptions: NotRequired[TextArrayOptionsTypeDef], # (11)
DateArrayOptions: NotRequired[DateArrayOptionsTypeDef], # (12)
- See IndexFieldTypeType
- See IntOptionsTypeDef
- See DoubleOptionsTypeDef
- See LiteralOptionsTypeDef
- See TextOptionsTypeDef
- See DateOptionsTypeDef
- See LatLonOptionsTypeDef
- See IntArrayOptionsTypeDef
- See DoubleArrayOptionsTypeDef
- See LiteralArrayOptionsTypeDef
- See TextArrayOptionsTypeDef
- See DateArrayOptionsTypeDef
ScalingParametersStatusTypeDef#
# ScalingParametersStatusTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import ScalingParametersStatusTypeDef
def get_value() -> ScalingParametersStatusTypeDef:
return {
"Options": ...,
"Status": ...,
}
# ScalingParametersStatusTypeDef definition
class ScalingParametersStatusTypeDef(TypedDict):
Options: ScalingParametersTypeDef, # (1)
Status: OptionStatusTypeDef, # (2)
UpdateScalingParametersRequestRequestTypeDef#
# UpdateScalingParametersRequestRequestTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import UpdateScalingParametersRequestRequestTypeDef
def get_value() -> UpdateScalingParametersRequestRequestTypeDef:
return {
"DomainName": ...,
"ScalingParameters": ...,
}
# UpdateScalingParametersRequestRequestTypeDef definition
class UpdateScalingParametersRequestRequestTypeDef(TypedDict):
DomainName: str,
ScalingParameters: ScalingParametersTypeDef, # (1)
DescribeServiceAccessPoliciesResponseTypeDef#
# DescribeServiceAccessPoliciesResponseTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DescribeServiceAccessPoliciesResponseTypeDef
def get_value() -> DescribeServiceAccessPoliciesResponseTypeDef:
return {
"AccessPolicies": ...,
"ResponseMetadata": ...,
}
# DescribeServiceAccessPoliciesResponseTypeDef definition
class DescribeServiceAccessPoliciesResponseTypeDef(TypedDict):
AccessPolicies: AccessPoliciesStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateServiceAccessPoliciesResponseTypeDef#
# UpdateServiceAccessPoliciesResponseTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import UpdateServiceAccessPoliciesResponseTypeDef
def get_value() -> UpdateServiceAccessPoliciesResponseTypeDef:
return {
"AccessPolicies": ...,
"ResponseMetadata": ...,
}
# UpdateServiceAccessPoliciesResponseTypeDef definition
class UpdateServiceAccessPoliciesResponseTypeDef(TypedDict):
AccessPolicies: AccessPoliciesStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeAvailabilityOptionsResponseTypeDef#
# DescribeAvailabilityOptionsResponseTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DescribeAvailabilityOptionsResponseTypeDef
def get_value() -> DescribeAvailabilityOptionsResponseTypeDef:
return {
"AvailabilityOptions": ...,
"ResponseMetadata": ...,
}
# DescribeAvailabilityOptionsResponseTypeDef definition
class DescribeAvailabilityOptionsResponseTypeDef(TypedDict):
AvailabilityOptions: AvailabilityOptionsStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateAvailabilityOptionsResponseTypeDef#
# UpdateAvailabilityOptionsResponseTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import UpdateAvailabilityOptionsResponseTypeDef
def get_value() -> UpdateAvailabilityOptionsResponseTypeDef:
return {
"AvailabilityOptions": ...,
"ResponseMetadata": ...,
}
# UpdateAvailabilityOptionsResponseTypeDef definition
class UpdateAvailabilityOptionsResponseTypeDef(TypedDict):
AvailabilityOptions: AvailabilityOptionsStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
AnalysisSchemeStatusTypeDef#
# AnalysisSchemeStatusTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import AnalysisSchemeStatusTypeDef
def get_value() -> AnalysisSchemeStatusTypeDef:
return {
"Options": ...,
"Status": ...,
}
# AnalysisSchemeStatusTypeDef definition
class AnalysisSchemeStatusTypeDef(TypedDict):
Options: AnalysisSchemeTypeDef, # (1)
Status: OptionStatusTypeDef, # (2)
DefineAnalysisSchemeRequestRequestTypeDef#
# DefineAnalysisSchemeRequestRequestTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DefineAnalysisSchemeRequestRequestTypeDef
def get_value() -> DefineAnalysisSchemeRequestRequestTypeDef:
return {
"DomainName": ...,
"AnalysisScheme": ...,
}
# DefineAnalysisSchemeRequestRequestTypeDef definition
class DefineAnalysisSchemeRequestRequestTypeDef(TypedDict):
DomainName: str,
AnalysisScheme: AnalysisSchemeTypeDef, # (1)
DefineExpressionResponseTypeDef#
# DefineExpressionResponseTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DefineExpressionResponseTypeDef
def get_value() -> DefineExpressionResponseTypeDef:
return {
"Expression": ...,
"ResponseMetadata": ...,
}
# DefineExpressionResponseTypeDef definition
class DefineExpressionResponseTypeDef(TypedDict):
Expression: ExpressionStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteExpressionResponseTypeDef#
# DeleteExpressionResponseTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DeleteExpressionResponseTypeDef
def get_value() -> DeleteExpressionResponseTypeDef:
return {
"Expression": ...,
"ResponseMetadata": ...,
}
# DeleteExpressionResponseTypeDef definition
class DeleteExpressionResponseTypeDef(TypedDict):
Expression: ExpressionStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeExpressionsResponseTypeDef#
# DescribeExpressionsResponseTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DescribeExpressionsResponseTypeDef
def get_value() -> DescribeExpressionsResponseTypeDef:
return {
"Expressions": ...,
"ResponseMetadata": ...,
}
# DescribeExpressionsResponseTypeDef definition
class DescribeExpressionsResponseTypeDef(TypedDict):
Expressions: List[ExpressionStatusTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DefineSuggesterRequestRequestTypeDef#
# DefineSuggesterRequestRequestTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DefineSuggesterRequestRequestTypeDef
def get_value() -> DefineSuggesterRequestRequestTypeDef:
return {
"DomainName": ...,
"Suggester": ...,
}
# DefineSuggesterRequestRequestTypeDef definition
class DefineSuggesterRequestRequestTypeDef(TypedDict):
DomainName: str,
Suggester: SuggesterTypeDef, # (1)
- See SuggesterTypeDef
SuggesterStatusTypeDef#
# SuggesterStatusTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import SuggesterStatusTypeDef
def get_value() -> SuggesterStatusTypeDef:
return {
"Options": ...,
"Status": ...,
}
# SuggesterStatusTypeDef definition
class SuggesterStatusTypeDef(TypedDict):
Options: SuggesterTypeDef, # (1)
Status: OptionStatusTypeDef, # (2)
- See SuggesterTypeDef
- See OptionStatusTypeDef
DescribeDomainEndpointOptionsResponseTypeDef#
# DescribeDomainEndpointOptionsResponseTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DescribeDomainEndpointOptionsResponseTypeDef
def get_value() -> DescribeDomainEndpointOptionsResponseTypeDef:
return {
"DomainEndpointOptions": ...,
"ResponseMetadata": ...,
}
# DescribeDomainEndpointOptionsResponseTypeDef definition
class DescribeDomainEndpointOptionsResponseTypeDef(TypedDict):
DomainEndpointOptions: DomainEndpointOptionsStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateDomainEndpointOptionsResponseTypeDef#
# UpdateDomainEndpointOptionsResponseTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import UpdateDomainEndpointOptionsResponseTypeDef
def get_value() -> UpdateDomainEndpointOptionsResponseTypeDef:
return {
"DomainEndpointOptions": ...,
"ResponseMetadata": ...,
}
# UpdateDomainEndpointOptionsResponseTypeDef definition
class UpdateDomainEndpointOptionsResponseTypeDef(TypedDict):
DomainEndpointOptions: DomainEndpointOptionsStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateDomainResponseTypeDef#
# CreateDomainResponseTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import CreateDomainResponseTypeDef
def get_value() -> CreateDomainResponseTypeDef:
return {
"DomainStatus": ...,
"ResponseMetadata": ...,
}
# CreateDomainResponseTypeDef definition
class CreateDomainResponseTypeDef(TypedDict):
DomainStatus: DomainStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteDomainResponseTypeDef#
# DeleteDomainResponseTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DeleteDomainResponseTypeDef
def get_value() -> DeleteDomainResponseTypeDef:
return {
"DomainStatus": ...,
"ResponseMetadata": ...,
}
# DeleteDomainResponseTypeDef definition
class DeleteDomainResponseTypeDef(TypedDict):
DomainStatus: DomainStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeDomainsResponseTypeDef#
# DescribeDomainsResponseTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DescribeDomainsResponseTypeDef
def get_value() -> DescribeDomainsResponseTypeDef:
return {
"DomainStatusList": ...,
"ResponseMetadata": ...,
}
# DescribeDomainsResponseTypeDef definition
class DescribeDomainsResponseTypeDef(TypedDict):
DomainStatusList: List[DomainStatusTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DefineIndexFieldRequestRequestTypeDef#
# DefineIndexFieldRequestRequestTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DefineIndexFieldRequestRequestTypeDef
def get_value() -> DefineIndexFieldRequestRequestTypeDef:
return {
"DomainName": ...,
"IndexField": ...,
}
# DefineIndexFieldRequestRequestTypeDef definition
class DefineIndexFieldRequestRequestTypeDef(TypedDict):
DomainName: str,
IndexField: IndexFieldTypeDef, # (1)
IndexFieldStatusTypeDef#
# IndexFieldStatusTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import IndexFieldStatusTypeDef
def get_value() -> IndexFieldStatusTypeDef:
return {
"Options": ...,
"Status": ...,
}
# IndexFieldStatusTypeDef definition
class IndexFieldStatusTypeDef(TypedDict):
Options: IndexFieldTypeDef, # (1)
Status: OptionStatusTypeDef, # (2)
- See IndexFieldTypeDef
- See OptionStatusTypeDef
DescribeScalingParametersResponseTypeDef#
# DescribeScalingParametersResponseTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DescribeScalingParametersResponseTypeDef
def get_value() -> DescribeScalingParametersResponseTypeDef:
return {
"ScalingParameters": ...,
"ResponseMetadata": ...,
}
# DescribeScalingParametersResponseTypeDef definition
class DescribeScalingParametersResponseTypeDef(TypedDict):
ScalingParameters: ScalingParametersStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateScalingParametersResponseTypeDef#
# UpdateScalingParametersResponseTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import UpdateScalingParametersResponseTypeDef
def get_value() -> UpdateScalingParametersResponseTypeDef:
return {
"ScalingParameters": ...,
"ResponseMetadata": ...,
}
# UpdateScalingParametersResponseTypeDef definition
class UpdateScalingParametersResponseTypeDef(TypedDict):
ScalingParameters: ScalingParametersStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DefineAnalysisSchemeResponseTypeDef#
# DefineAnalysisSchemeResponseTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DefineAnalysisSchemeResponseTypeDef
def get_value() -> DefineAnalysisSchemeResponseTypeDef:
return {
"AnalysisScheme": ...,
"ResponseMetadata": ...,
}
# DefineAnalysisSchemeResponseTypeDef definition
class DefineAnalysisSchemeResponseTypeDef(TypedDict):
AnalysisScheme: AnalysisSchemeStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteAnalysisSchemeResponseTypeDef#
# DeleteAnalysisSchemeResponseTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DeleteAnalysisSchemeResponseTypeDef
def get_value() -> DeleteAnalysisSchemeResponseTypeDef:
return {
"AnalysisScheme": ...,
"ResponseMetadata": ...,
}
# DeleteAnalysisSchemeResponseTypeDef definition
class DeleteAnalysisSchemeResponseTypeDef(TypedDict):
AnalysisScheme: AnalysisSchemeStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeAnalysisSchemesResponseTypeDef#
# DescribeAnalysisSchemesResponseTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DescribeAnalysisSchemesResponseTypeDef
def get_value() -> DescribeAnalysisSchemesResponseTypeDef:
return {
"AnalysisSchemes": ...,
"ResponseMetadata": ...,
}
# DescribeAnalysisSchemesResponseTypeDef definition
class DescribeAnalysisSchemesResponseTypeDef(TypedDict):
AnalysisSchemes: List[AnalysisSchemeStatusTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DefineSuggesterResponseTypeDef#
# DefineSuggesterResponseTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DefineSuggesterResponseTypeDef
def get_value() -> DefineSuggesterResponseTypeDef:
return {
"Suggester": ...,
"ResponseMetadata": ...,
}
# DefineSuggesterResponseTypeDef definition
class DefineSuggesterResponseTypeDef(TypedDict):
Suggester: SuggesterStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteSuggesterResponseTypeDef#
# DeleteSuggesterResponseTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DeleteSuggesterResponseTypeDef
def get_value() -> DeleteSuggesterResponseTypeDef:
return {
"Suggester": ...,
"ResponseMetadata": ...,
}
# DeleteSuggesterResponseTypeDef definition
class DeleteSuggesterResponseTypeDef(TypedDict):
Suggester: SuggesterStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeSuggestersResponseTypeDef#
# DescribeSuggestersResponseTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DescribeSuggestersResponseTypeDef
def get_value() -> DescribeSuggestersResponseTypeDef:
return {
"Suggesters": ...,
"ResponseMetadata": ...,
}
# DescribeSuggestersResponseTypeDef definition
class DescribeSuggestersResponseTypeDef(TypedDict):
Suggesters: List[SuggesterStatusTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DefineIndexFieldResponseTypeDef#
# DefineIndexFieldResponseTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DefineIndexFieldResponseTypeDef
def get_value() -> DefineIndexFieldResponseTypeDef:
return {
"IndexField": ...,
"ResponseMetadata": ...,
}
# DefineIndexFieldResponseTypeDef definition
class DefineIndexFieldResponseTypeDef(TypedDict):
IndexField: IndexFieldStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteIndexFieldResponseTypeDef#
# DeleteIndexFieldResponseTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DeleteIndexFieldResponseTypeDef
def get_value() -> DeleteIndexFieldResponseTypeDef:
return {
"IndexField": ...,
"ResponseMetadata": ...,
}
# DeleteIndexFieldResponseTypeDef definition
class DeleteIndexFieldResponseTypeDef(TypedDict):
IndexField: IndexFieldStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeIndexFieldsResponseTypeDef#
# DescribeIndexFieldsResponseTypeDef usage example
from mypy_boto3_cloudsearch.type_defs import DescribeIndexFieldsResponseTypeDef
def get_value() -> DescribeIndexFieldsResponseTypeDef:
return {
"IndexFields": ...,
"ResponseMetadata": ...,
}
# DescribeIndexFieldsResponseTypeDef definition
class DescribeIndexFieldsResponseTypeDef(TypedDict):
IndexFields: List[IndexFieldStatusTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)