Skip to content

Type definitions#

Index > CloudSearchDomain > Type definitions

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

BlobTypeDef#

# BlobTypeDef definition

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

BucketTypeDef#

# BucketTypeDef definition

class BucketTypeDef(TypedDict):
    value: NotRequired[str],
    count: NotRequired[int],

DocumentServiceWarningTypeDef#

# DocumentServiceWarningTypeDef definition

class DocumentServiceWarningTypeDef(TypedDict):
    message: NotRequired[str],

FieldStatsTypeDef#

# 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 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 definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

SearchRequestRequestTypeDef#

# 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],
  1. See QueryParserType

SearchStatusTypeDef#

# SearchStatusTypeDef definition

class SearchStatusTypeDef(TypedDict):
    timems: NotRequired[int],
    rid: NotRequired[str],

SuggestionMatchTypeDef#

# SuggestionMatchTypeDef definition

class SuggestionMatchTypeDef(TypedDict):
    suggestion: NotRequired[str],
    score: NotRequired[int],
    id: NotRequired[str],

SuggestRequestRequestTypeDef#

# SuggestRequestRequestTypeDef definition

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

SuggestStatusTypeDef#

# SuggestStatusTypeDef definition

class SuggestStatusTypeDef(TypedDict):
    timems: NotRequired[int],
    rid: NotRequired[str],

UploadDocumentsRequestRequestTypeDef#

# UploadDocumentsRequestRequestTypeDef definition

class UploadDocumentsRequestRequestTypeDef(TypedDict):
    documents: BlobTypeDef,
    contentType: ContentTypeType,  # (1)
  1. See ContentTypeType

BucketInfoTypeDef#

# BucketInfoTypeDef definition

class BucketInfoTypeDef(TypedDict):
    buckets: NotRequired[list[BucketTypeDef]],  # (1)
  1. See BucketTypeDef

HitsTypeDef#

# HitsTypeDef definition

class HitsTypeDef(TypedDict):
    found: NotRequired[int],
    start: NotRequired[int],
    cursor: NotRequired[str],
    hit: NotRequired[list[HitTypeDef]],  # (1)
  1. See HitTypeDef

UploadDocumentsResponseTypeDef#

# 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 definition

class SuggestModelTypeDef(TypedDict):
    query: NotRequired[str],
    found: NotRequired[int],
    suggestions: NotRequired[list[SuggestionMatchTypeDef]],  # (1)
  1. See SuggestionMatchTypeDef

SearchResponseTypeDef#

# 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 definition

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