Skip to content

Type definitions#

Index > CloudSearch > Type definitions

Auto-generated documentation for CloudSearch type annotations stubs module mypy-boto3-cloudsearch.

OptionStatusTypeDef#

# OptionStatusTypeDef definition

class OptionStatusTypeDef(TypedDict):
    CreationDate: datetime,
    UpdateDate: datetime,
    State: OptionStateType,  # (1)
    UpdateVersion: NotRequired[int],
    PendingDeletion: NotRequired[bool],
  1. See OptionStateType

AnalysisOptionsTypeDef#

# AnalysisOptionsTypeDef definition

class AnalysisOptionsTypeDef(TypedDict):
    Synonyms: NotRequired[str],
    Stopwords: NotRequired[str],
    StemmingDictionary: NotRequired[str],
    JapaneseTokenizationDictionary: NotRequired[str],
    AlgorithmicStemming: NotRequired[AlgorithmicStemmingType],  # (1)
  1. See AlgorithmicStemmingType

BuildSuggestersRequestRequestTypeDef#

# BuildSuggestersRequestRequestTypeDef definition

class BuildSuggestersRequestRequestTypeDef(TypedDict):
    DomainName: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

CreateDomainRequestRequestTypeDef#

# CreateDomainRequestRequestTypeDef definition

class CreateDomainRequestRequestTypeDef(TypedDict):
    DomainName: str,

DateArrayOptionsTypeDef#

# DateArrayOptionsTypeDef definition

class DateArrayOptionsTypeDef(TypedDict):
    DefaultValue: NotRequired[str],
    SourceFields: NotRequired[str],
    FacetEnabled: NotRequired[bool],
    SearchEnabled: NotRequired[bool],
    ReturnEnabled: NotRequired[bool],

DateOptionsTypeDef#

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

class ExpressionTypeDef(TypedDict):
    ExpressionName: str,
    ExpressionValue: str,

DeleteAnalysisSchemeRequestRequestTypeDef#

# DeleteAnalysisSchemeRequestRequestTypeDef definition

class DeleteAnalysisSchemeRequestRequestTypeDef(TypedDict):
    DomainName: str,
    AnalysisSchemeName: str,

DeleteDomainRequestRequestTypeDef#

# DeleteDomainRequestRequestTypeDef definition

class DeleteDomainRequestRequestTypeDef(TypedDict):
    DomainName: str,

DeleteExpressionRequestRequestTypeDef#

# DeleteExpressionRequestRequestTypeDef definition

class DeleteExpressionRequestRequestTypeDef(TypedDict):
    DomainName: str,
    ExpressionName: str,

DeleteIndexFieldRequestRequestTypeDef#

# DeleteIndexFieldRequestRequestTypeDef definition

class DeleteIndexFieldRequestRequestTypeDef(TypedDict):
    DomainName: str,
    IndexFieldName: str,

DeleteSuggesterRequestRequestTypeDef#

# DeleteSuggesterRequestRequestTypeDef definition

class DeleteSuggesterRequestRequestTypeDef(TypedDict):
    DomainName: str,
    SuggesterName: str,

DescribeAnalysisSchemesRequestRequestTypeDef#

# DescribeAnalysisSchemesRequestRequestTypeDef definition

class DescribeAnalysisSchemesRequestRequestTypeDef(TypedDict):
    DomainName: str,
    AnalysisSchemeNames: NotRequired[Sequence[str]],
    Deployed: NotRequired[bool],

DescribeAvailabilityOptionsRequestRequestTypeDef#

# DescribeAvailabilityOptionsRequestRequestTypeDef definition

class DescribeAvailabilityOptionsRequestRequestTypeDef(TypedDict):
    DomainName: str,
    Deployed: NotRequired[bool],

DescribeDomainEndpointOptionsRequestRequestTypeDef#

# DescribeDomainEndpointOptionsRequestRequestTypeDef definition

class DescribeDomainEndpointOptionsRequestRequestTypeDef(TypedDict):
    DomainName: str,
    Deployed: NotRequired[bool],

DescribeDomainsRequestRequestTypeDef#

# DescribeDomainsRequestRequestTypeDef definition

class DescribeDomainsRequestRequestTypeDef(TypedDict):
    DomainNames: NotRequired[Sequence[str]],

DescribeExpressionsRequestRequestTypeDef#

# DescribeExpressionsRequestRequestTypeDef definition

class DescribeExpressionsRequestRequestTypeDef(TypedDict):
    DomainName: str,
    ExpressionNames: NotRequired[Sequence[str]],
    Deployed: NotRequired[bool],

DescribeIndexFieldsRequestRequestTypeDef#

# DescribeIndexFieldsRequestRequestTypeDef definition

class DescribeIndexFieldsRequestRequestTypeDef(TypedDict):
    DomainName: str,
    FieldNames: NotRequired[Sequence[str]],
    Deployed: NotRequired[bool],

DescribeScalingParametersRequestRequestTypeDef#

# DescribeScalingParametersRequestRequestTypeDef definition

class DescribeScalingParametersRequestRequestTypeDef(TypedDict):
    DomainName: str,

DescribeServiceAccessPoliciesRequestRequestTypeDef#

# DescribeServiceAccessPoliciesRequestRequestTypeDef definition

class DescribeServiceAccessPoliciesRequestRequestTypeDef(TypedDict):
    DomainName: str,
    Deployed: NotRequired[bool],

DescribeSuggestersRequestRequestTypeDef#

# DescribeSuggestersRequestRequestTypeDef definition

class DescribeSuggestersRequestRequestTypeDef(TypedDict):
    DomainName: str,
    SuggesterNames: NotRequired[Sequence[str]],
    Deployed: NotRequired[bool],

DocumentSuggesterOptionsTypeDef#

# DocumentSuggesterOptionsTypeDef definition

class DocumentSuggesterOptionsTypeDef(TypedDict):
    SourceField: str,
    FuzzyMatching: NotRequired[SuggesterFuzzyMatchingType],  # (1)
    SortExpression: NotRequired[str],
  1. See SuggesterFuzzyMatchingType

DomainEndpointOptionsTypeDef#

# DomainEndpointOptionsTypeDef definition

class DomainEndpointOptionsTypeDef(TypedDict):
    EnforceHTTPS: NotRequired[bool],
    TLSSecurityPolicy: NotRequired[TLSSecurityPolicyType],  # (1)
  1. See TLSSecurityPolicyType

LimitsTypeDef#

# LimitsTypeDef definition

class LimitsTypeDef(TypedDict):
    MaximumReplicationCount: int,
    MaximumPartitionCount: int,

ServiceEndpointTypeDef#

# ServiceEndpointTypeDef definition

class ServiceEndpointTypeDef(TypedDict):
    Endpoint: NotRequired[str],

DoubleArrayOptionsTypeDef#

# DoubleArrayOptionsTypeDef definition

class DoubleArrayOptionsTypeDef(TypedDict):
    DefaultValue: NotRequired[float],
    SourceFields: NotRequired[str],
    FacetEnabled: NotRequired[bool],
    SearchEnabled: NotRequired[bool],
    ReturnEnabled: NotRequired[bool],

DoubleOptionsTypeDef#

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

class IndexDocumentsRequestRequestTypeDef(TypedDict):
    DomainName: str,

IntArrayOptionsTypeDef#

# IntArrayOptionsTypeDef definition

class IntArrayOptionsTypeDef(TypedDict):
    DefaultValue: NotRequired[int],
    SourceFields: NotRequired[str],
    FacetEnabled: NotRequired[bool],
    SearchEnabled: NotRequired[bool],
    ReturnEnabled: NotRequired[bool],

IntOptionsTypeDef#

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

class LatLonOptionsTypeDef(TypedDict):
    DefaultValue: NotRequired[str],
    SourceField: NotRequired[str],
    FacetEnabled: NotRequired[bool],
    SearchEnabled: NotRequired[bool],
    ReturnEnabled: NotRequired[bool],
    SortEnabled: NotRequired[bool],

LiteralArrayOptionsTypeDef#

# LiteralArrayOptionsTypeDef definition

class LiteralArrayOptionsTypeDef(TypedDict):
    DefaultValue: NotRequired[str],
    SourceFields: NotRequired[str],
    FacetEnabled: NotRequired[bool],
    SearchEnabled: NotRequired[bool],
    ReturnEnabled: NotRequired[bool],

LiteralOptionsTypeDef#

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

class TextArrayOptionsTypeDef(TypedDict):
    DefaultValue: NotRequired[str],
    SourceFields: NotRequired[str],
    ReturnEnabled: NotRequired[bool],
    HighlightEnabled: NotRequired[bool],
    AnalysisScheme: NotRequired[str],

TextOptionsTypeDef#

# TextOptionsTypeDef definition

class TextOptionsTypeDef(TypedDict):
    DefaultValue: NotRequired[str],
    SourceField: NotRequired[str],
    ReturnEnabled: NotRequired[bool],
    SortEnabled: NotRequired[bool],
    HighlightEnabled: NotRequired[bool],
    AnalysisScheme: NotRequired[str],

ScalingParametersTypeDef#

# ScalingParametersTypeDef definition

class ScalingParametersTypeDef(TypedDict):
    DesiredInstanceType: NotRequired[PartitionInstanceTypeType],  # (1)
    DesiredReplicationCount: NotRequired[int],
    DesiredPartitionCount: NotRequired[int],
  1. See PartitionInstanceTypeType

UpdateAvailabilityOptionsRequestRequestTypeDef#

# UpdateAvailabilityOptionsRequestRequestTypeDef definition

class UpdateAvailabilityOptionsRequestRequestTypeDef(TypedDict):
    DomainName: str,
    MultiAZ: bool,

UpdateServiceAccessPoliciesRequestRequestTypeDef#

# UpdateServiceAccessPoliciesRequestRequestTypeDef definition

class UpdateServiceAccessPoliciesRequestRequestTypeDef(TypedDict):
    DomainName: str,
    AccessPolicies: str,

AccessPoliciesStatusTypeDef#

# AccessPoliciesStatusTypeDef definition

class AccessPoliciesStatusTypeDef(TypedDict):
    Options: str,
    Status: OptionStatusTypeDef,  # (1)
  1. See OptionStatusTypeDef

AvailabilityOptionsStatusTypeDef#

# AvailabilityOptionsStatusTypeDef definition

class AvailabilityOptionsStatusTypeDef(TypedDict):
    Options: bool,
    Status: OptionStatusTypeDef,  # (1)
  1. See OptionStatusTypeDef

AnalysisSchemeTypeDef#

# AnalysisSchemeTypeDef definition

class AnalysisSchemeTypeDef(TypedDict):
    AnalysisSchemeName: str,
    AnalysisSchemeLanguage: AnalysisSchemeLanguageType,  # (1)
    AnalysisOptions: NotRequired[AnalysisOptionsTypeDef],  # (2)
  1. See AnalysisSchemeLanguageType
  2. See AnalysisOptionsTypeDef

BuildSuggestersResponseTypeDef#

# BuildSuggestersResponseTypeDef definition

class BuildSuggestersResponseTypeDef(TypedDict):
    FieldNames: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

IndexDocumentsResponseTypeDef#

# IndexDocumentsResponseTypeDef definition

class IndexDocumentsResponseTypeDef(TypedDict):
    FieldNames: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListDomainNamesResponseTypeDef#

# ListDomainNamesResponseTypeDef definition

class ListDomainNamesResponseTypeDef(TypedDict):
    DomainNames: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DefineExpressionRequestRequestTypeDef#

# DefineExpressionRequestRequestTypeDef definition

class DefineExpressionRequestRequestTypeDef(TypedDict):
    DomainName: str,
    Expression: ExpressionTypeDef,  # (1)
  1. See ExpressionTypeDef

ExpressionStatusTypeDef#

# ExpressionStatusTypeDef definition

class ExpressionStatusTypeDef(TypedDict):
    Options: ExpressionTypeDef,  # (1)
    Status: OptionStatusTypeDef,  # (2)
  1. See ExpressionTypeDef
  2. See OptionStatusTypeDef

SuggesterTypeDef#

# SuggesterTypeDef definition

class SuggesterTypeDef(TypedDict):
    SuggesterName: str,
    DocumentSuggesterOptions: DocumentSuggesterOptionsTypeDef,  # (1)
  1. See DocumentSuggesterOptionsTypeDef

DomainEndpointOptionsStatusTypeDef#

# DomainEndpointOptionsStatusTypeDef definition

class DomainEndpointOptionsStatusTypeDef(TypedDict):
    Options: DomainEndpointOptionsTypeDef,  # (1)
    Status: OptionStatusTypeDef,  # (2)
  1. See DomainEndpointOptionsTypeDef
  2. See OptionStatusTypeDef

UpdateDomainEndpointOptionsRequestRequestTypeDef#

# UpdateDomainEndpointOptionsRequestRequestTypeDef definition

class UpdateDomainEndpointOptionsRequestRequestTypeDef(TypedDict):
    DomainName: str,
    DomainEndpointOptions: DomainEndpointOptionsTypeDef,  # (1)
  1. See DomainEndpointOptionsTypeDef

DomainStatusTypeDef#

# 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)
  1. See ServiceEndpointTypeDef
  2. See ServiceEndpointTypeDef
  3. See LimitsTypeDef

IndexFieldTypeDef#

# 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)
  1. See IndexFieldTypeType
  2. See IntOptionsTypeDef
  3. See DoubleOptionsTypeDef
  4. See LiteralOptionsTypeDef
  5. See TextOptionsTypeDef
  6. See DateOptionsTypeDef
  7. See LatLonOptionsTypeDef
  8. See IntArrayOptionsTypeDef
  9. See DoubleArrayOptionsTypeDef
  10. See LiteralArrayOptionsTypeDef
  11. See TextArrayOptionsTypeDef
  12. See DateArrayOptionsTypeDef

ScalingParametersStatusTypeDef#

# ScalingParametersStatusTypeDef definition

class ScalingParametersStatusTypeDef(TypedDict):
    Options: ScalingParametersTypeDef,  # (1)
    Status: OptionStatusTypeDef,  # (2)
  1. See ScalingParametersTypeDef
  2. See OptionStatusTypeDef

UpdateScalingParametersRequestRequestTypeDef#