Type definitions

Index > CloudSearchDomain > Type definitions

Auto-generated documentation for CloudSearchDomain type annotations stubs module mypy-boto3-cloudsearchdomain.

BlobTypeDef

# BlobTypeDef Union usage example

from mypy_boto3_cloudsearchdomain.type_defs import BlobTypeDef


def get_value() -> BlobTypeDef:
    return ...


# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    StreamingBody,
]

BucketTypeDef

# BucketTypeDef TypedDict 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 TypedDict 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 TypedDict 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 TypedDict 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 TypedDict usage example

from mypy_boto3_cloudsearchdomain.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],

SearchRequestTypeDef

# SearchRequestTypeDef TypedDict usage example

from mypy_boto3_cloudsearchdomain.type_defs import SearchRequestTypeDef


def get_value() -> SearchRequestTypeDef:
    return {
        "query": ...,
    }


# SearchRequestTypeDef definition

class SearchRequestTypeDef(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],

1. See QueryParserType

SearchStatusTypeDef

# SearchStatusTypeDef TypedDict 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 TypedDict 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],

SuggestRequestTypeDef

# SuggestRequestTypeDef TypedDict usage example

from mypy_boto3_cloudsearchdomain.type_defs import SuggestRequestTypeDef


def get_value() -> SuggestRequestTypeDef:
    return {
        "query": ...,
    }


# SuggestRequestTypeDef definition

class SuggestRequestTypeDef(TypedDict):
    query: str,
    suggester: str,
    size: NotRequired[int],

SuggestStatusTypeDef

# SuggestStatusTypeDef TypedDict 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],

UploadDocumentsRequestTypeDef

# UploadDocumentsRequestTypeDef TypedDict usage example

from mypy_boto3_cloudsearchdomain.type_defs import UploadDocumentsRequestTypeDef


def get_value() -> UploadDocumentsRequestTypeDef:
    return {
        "documents": ...,
    }


# UploadDocumentsRequestTypeDef definition

class UploadDocumentsRequestTypeDef(TypedDict):
    documents: BlobTypeDef,
    contentType: ContentTypeType,  # (1)

1. See ContentTypeType

BucketInfoTypeDef

# BucketInfoTypeDef TypedDict 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)

1. See BucketTypeDef

HitsTypeDef

# HitsTypeDef TypedDict 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)

1. See HitTypeDef

UploadDocumentsResponseTypeDef

# UploadDocumentsResponseTypeDef TypedDict usage example

from mypy_boto3_cloudsearchdomain.type_defs import UploadDocumentsResponseTypeDef


def get_value() -> UploadDocumentsResponseTypeDef:
    return {
        "status": ...,
    }


# UploadDocumentsResponseTypeDef definition

class UploadDocumentsResponseTypeDef(TypedDict):
    status: str,
    adds: int,
    deletes: int,
    warnings: List[DocumentServiceWarningTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See DocumentServiceWarningTypeDef
2. See ResponseMetadataTypeDef

SuggestModelTypeDef

# SuggestModelTypeDef TypedDict 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)

1. See SuggestionMatchTypeDef

SearchResponseTypeDef

# SearchResponseTypeDef TypedDict usage example

from mypy_boto3_cloudsearchdomain.type_defs import SearchResponseTypeDef


def get_value() -> SearchResponseTypeDef:
    return {
        "status": ...,
    }


# SearchResponseTypeDef definition

class SearchResponseTypeDef(TypedDict):
    status: SearchStatusTypeDef,  # (1)
    hits: HitsTypeDef,  # (2)
    facets: Dict[str, BucketInfoTypeDef],  # (3)
    stats: Dict[str, FieldStatsTypeDef],  # (4)
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)

1. See SearchStatusTypeDef
2. See HitsTypeDef
3. See BucketInfoTypeDef
4. See FieldStatsTypeDef
5. See ResponseMetadataTypeDef

SuggestResponseTypeDef

# SuggestResponseTypeDef TypedDict usage example

from mypy_boto3_cloudsearchdomain.type_defs import SuggestResponseTypeDef


def get_value() -> SuggestResponseTypeDef:
    return {
        "status": ...,
    }


# SuggestResponseTypeDef definition

class SuggestResponseTypeDef(TypedDict):
    status: SuggestStatusTypeDef,  # (1)
    suggest: SuggestModelTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

1. See SuggestStatusTypeDef
2. See SuggestModelTypeDef
3. See ResponseMetadataTypeDef