Typed dictionaries#
Index > CloudSearchDomain > Typed dictionaries
Auto-generated documentation for CloudSearchDomain type annotations stubs module mypy-boto3-cloudsearchdomain.
BucketTypeDef#
# BucketTypeDef usage example
from mypy_boto3_cloudsearchdomain.type_defs import BucketTypeDef
def get_value() -> BucketTypeDef:
return {
"value": ...,
}
# BucketTypeDef definition
class BucketTypeDef(TypedDict):
value: NotRequired[str],
count: NotRequired[int],
DocumentServiceWarningTypeDef#
# DocumentServiceWarningTypeDef usage example
from mypy_boto3_cloudsearchdomain.type_defs import DocumentServiceWarningTypeDef
def get_value() -> DocumentServiceWarningTypeDef:
return {
"message": ...,
}
# DocumentServiceWarningTypeDef definition
class DocumentServiceWarningTypeDef(TypedDict):
message: NotRequired[str],
FieldStatsTypeDef#
# FieldStatsTypeDef usage example
from mypy_boto3_cloudsearchdomain.type_defs import FieldStatsTypeDef
def get_value() -> FieldStatsTypeDef:
return {
"min": ...,
}
# FieldStatsTypeDef definition
class FieldStatsTypeDef(TypedDict):
min: NotRequired[str],
max: NotRequired[str],
count: NotRequired[int],
missing: NotRequired[int],
sum: NotRequired[float],
sumOfSquares: NotRequired[float],
mean: NotRequired[str],
stddev: NotRequired[float],
HitTypeDef#
# HitTypeDef usage example
from mypy_boto3_cloudsearchdomain.type_defs import HitTypeDef
def get_value() -> HitTypeDef:
return {
"id": ...,
}
# HitTypeDef definition
class HitTypeDef(TypedDict):
id: NotRequired[str],
fields: NotRequired[Dict[str, List[str]]],
exprs: NotRequired[Dict[str, str]],
highlights: NotRequired[Dict[str, str]],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef usage example
from mypy_boto3_cloudsearchdomain.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,
SearchRequestRequestTypeDef#
# SearchRequestRequestTypeDef usage example
from mypy_boto3_cloudsearchdomain.type_defs import SearchRequestRequestTypeDef
def get_value() -> SearchRequestRequestTypeDef:
return {
"query": ...,
}
# SearchRequestRequestTypeDef definition
class SearchRequestRequestTypeDef(TypedDict):
query: str,
cursor: NotRequired[str],
expr: NotRequired[str],
facet: NotRequired[str],
filterQuery: NotRequired[str],
highlight: NotRequired[str],
partial: NotRequired[bool],
queryOptions: NotRequired[str],
queryParser: NotRequired[QueryParserType], # (1)
returnFields: NotRequired[str],
size: NotRequired[int],
sort: NotRequired[str],
start: NotRequired[int],
stats: NotRequired[str],
- See QueryParserType
SearchStatusTypeDef#
# SearchStatusTypeDef usage example
from mypy_boto3_cloudsearchdomain.type_defs import SearchStatusTypeDef
def get_value() -> SearchStatusTypeDef:
return {
"timems": ...,
}
# SearchStatusTypeDef definition
class SearchStatusTypeDef(TypedDict):
timems: NotRequired[int],
rid: NotRequired[str],
SuggestionMatchTypeDef#
# SuggestionMatchTypeDef usage example
from mypy_boto3_cloudsearchdomain.type_defs import SuggestionMatchTypeDef
def get_value() -> SuggestionMatchTypeDef:
return {
"suggestion": ...,
}
# SuggestionMatchTypeDef definition
class SuggestionMatchTypeDef(TypedDict):
suggestion: NotRequired[str],
score: NotRequired[int],
id: NotRequired[str],
SuggestRequestRequestTypeDef#
# SuggestRequestRequestTypeDef usage example
from mypy_boto3_cloudsearchdomain.type_defs import SuggestRequestRequestTypeDef
def get_value() -> SuggestRequestRequestTypeDef:
return {
"query": ...,
"suggester": ...,
}
# SuggestRequestRequestTypeDef definition
class SuggestRequestRequestTypeDef(TypedDict):
query: str,
suggester: str,
size: NotRequired[int],
SuggestStatusTypeDef#
# SuggestStatusTypeDef usage example
from mypy_boto3_cloudsearchdomain.type_defs import SuggestStatusTypeDef
def get_value() -> SuggestStatusTypeDef:
return {
"timems": ...,
}
# SuggestStatusTypeDef definition
class SuggestStatusTypeDef(TypedDict):
timems: NotRequired[int],
rid: NotRequired[str],
UploadDocumentsRequestRequestTypeDef#
# UploadDocumentsRequestRequestTypeDef usage example
from mypy_boto3_cloudsearchdomain.type_defs import UploadDocumentsRequestRequestTypeDef
def get_value() -> UploadDocumentsRequestRequestTypeDef:
return {
"documents": ...,
"contentType": ...,
}
# UploadDocumentsRequestRequestTypeDef definition
class UploadDocumentsRequestRequestTypeDef(TypedDict):
documents: Union[str, bytes, IO[Any], StreamingBody],
contentType: ContentTypeType, # (1)
- See ContentTypeType
BucketInfoTypeDef#
# BucketInfoTypeDef usage example
from mypy_boto3_cloudsearchdomain.type_defs import BucketInfoTypeDef
def get_value() -> BucketInfoTypeDef:
return {
"buckets": ...,
}
# BucketInfoTypeDef definition
class BucketInfoTypeDef(TypedDict):
buckets: NotRequired[List[BucketTypeDef]], # (1)
- See BucketTypeDef
UploadDocumentsResponseTypeDef#
# UploadDocumentsResponseTypeDef usage example
from mypy_boto3_cloudsearchdomain.type_defs import UploadDocumentsResponseTypeDef
def get_value() -> UploadDocumentsResponseTypeDef:
return {
"status": ...,
"adds": ...,
"deletes": ...,
"warnings": ...,
"ResponseMetadata": ...,
}
# UploadDocumentsResponseTypeDef definition
class UploadDocumentsResponseTypeDef(TypedDict):
status: str,
adds: int,
deletes: int,
warnings: List[DocumentServiceWarningTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
HitsTypeDef#
# HitsTypeDef usage example
from mypy_boto3_cloudsearchdomain.type_defs import HitsTypeDef
def get_value() -> HitsTypeDef:
return {
"found": ...,
}
# HitsTypeDef definition
class HitsTypeDef(TypedDict):
found: NotRequired[int],
start: NotRequired[int],
cursor: NotRequired[str],
hit: NotRequired[List[HitTypeDef]], # (1)
- See HitTypeDef
SuggestModelTypeDef#
# SuggestModelTypeDef usage example
from mypy_boto3_cloudsearchdomain.type_defs import SuggestModelTypeDef
def get_value() -> SuggestModelTypeDef:
return {
"query": ...,
}
# SuggestModelTypeDef definition
class SuggestModelTypeDef(TypedDict):
query: NotRequired[str],
found: NotRequired[int],
suggestions: NotRequired[List[SuggestionMatchTypeDef]], # (1)
SearchResponseTypeDef#
# SearchResponseTypeDef usage example
from mypy_boto3_cloudsearchdomain.type_defs import SearchResponseTypeDef
def get_value() -> SearchResponseTypeDef:
return {
"status": ...,
"hits": ...,
"facets": ...,
"stats": ...,
"ResponseMetadata": ...,
}
# SearchResponseTypeDef definition
class SearchResponseTypeDef(TypedDict):
status: SearchStatusTypeDef, # (1)
hits: HitsTypeDef, # (2)
facets: Dict[str, BucketInfoTypeDef], # (3)
stats: Dict[str, FieldStatsTypeDef], # (4)
ResponseMetadata: ResponseMetadataTypeDef, # (5)
- See SearchStatusTypeDef
- See HitsTypeDef
- See BucketInfoTypeDef
- See FieldStatsTypeDef
- See ResponseMetadataTypeDef
SuggestResponseTypeDef#
# SuggestResponseTypeDef usage example
from mypy_boto3_cloudsearchdomain.type_defs import SuggestResponseTypeDef
def get_value() -> SuggestResponseTypeDef:
return {
"status": ...,
"suggest": ...,
"ResponseMetadata": ...,
}
# SuggestResponseTypeDef definition
class SuggestResponseTypeDef(TypedDict):
status: SuggestStatusTypeDef, # (1)
suggest: SuggestModelTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)