Skip to content

Typed dictionaries

Index > CloudSearch > Typed dictionaries

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

OptionStatusTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import OptionStatusTypeDef

def get_value() -> OptionStatusTypeDef:
    return {
        "CreationDate": ...,
        "UpdateDate": ...,
        "State": ...,
    }
Definition
class OptionStatusTypeDef(TypedDict):
    CreationDate: datetime,
    UpdateDate: datetime,
    State: OptionStateType,  # (1)
    UpdateVersion: NotRequired[int],
    PendingDeletion: NotRequired[bool],
  1. See OptionStateType

AnalysisOptionsTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import AnalysisOptionsTypeDef

def get_value() -> AnalysisOptionsTypeDef:
    return {
        "Synonyms": ...,
    }
Definition
class AnalysisOptionsTypeDef(TypedDict):
    Synonyms: NotRequired[str],
    Stopwords: NotRequired[str],
    StemmingDictionary: NotRequired[str],
    JapaneseTokenizationDictionary: NotRequired[str],
    AlgorithmicStemming: NotRequired[AlgorithmicStemmingType],  # (1)
  1. See AlgorithmicStemmingType

BuildSuggestersRequestRequestTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import BuildSuggestersRequestRequestTypeDef

def get_value() -> BuildSuggestersRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
Definition
class BuildSuggestersRequestRequestTypeDef(TypedDict):
    DomainName: str,

ResponseMetadataTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
Definition
class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

CreateDomainRequestRequestTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import CreateDomainRequestRequestTypeDef

def get_value() -> CreateDomainRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
Definition
class CreateDomainRequestRequestTypeDef(TypedDict):
    DomainName: str,

DateArrayOptionsTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DateArrayOptionsTypeDef

def get_value() -> DateArrayOptionsTypeDef:
    return {
        "DefaultValue": ...,
    }
Definition
class DateArrayOptionsTypeDef(TypedDict):
    DefaultValue: NotRequired[str],
    SourceFields: NotRequired[str],
    FacetEnabled: NotRequired[bool],
    SearchEnabled: NotRequired[bool],
    ReturnEnabled: NotRequired[bool],

DateOptionsTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DateOptionsTypeDef

def get_value() -> DateOptionsTypeDef:
    return {
        "DefaultValue": ...,
    }
Definition
class DateOptionsTypeDef(TypedDict):
    DefaultValue: NotRequired[str],
    SourceField: NotRequired[str],
    FacetEnabled: NotRequired[bool],
    SearchEnabled: NotRequired[bool],
    ReturnEnabled: NotRequired[bool],
    SortEnabled: NotRequired[bool],

ExpressionTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import ExpressionTypeDef

def get_value() -> ExpressionTypeDef:
    return {
        "ExpressionName": ...,
        "ExpressionValue": ...,
    }
Definition
class ExpressionTypeDef(TypedDict):
    ExpressionName: str,
    ExpressionValue: str,

DeleteAnalysisSchemeRequestRequestTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DeleteAnalysisSchemeRequestRequestTypeDef

def get_value() -> DeleteAnalysisSchemeRequestRequestTypeDef:
    return {
        "DomainName": ...,
        "AnalysisSchemeName": ...,
    }
Definition
class DeleteAnalysisSchemeRequestRequestTypeDef(TypedDict):
    DomainName: str,
    AnalysisSchemeName: str,

DeleteDomainRequestRequestTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DeleteDomainRequestRequestTypeDef

def get_value() -> DeleteDomainRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
Definition
class DeleteDomainRequestRequestTypeDef(TypedDict):
    DomainName: str,

DeleteExpressionRequestRequestTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DeleteExpressionRequestRequestTypeDef

def get_value() -> DeleteExpressionRequestRequestTypeDef:
    return {
        "DomainName": ...,
        "ExpressionName": ...,
    }
Definition
class DeleteExpressionRequestRequestTypeDef(TypedDict):
    DomainName: str,
    ExpressionName: str,

DeleteIndexFieldRequestRequestTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DeleteIndexFieldRequestRequestTypeDef

def get_value() -> DeleteIndexFieldRequestRequestTypeDef:
    return {
        "DomainName": ...,
        "IndexFieldName": ...,
    }
Definition
class DeleteIndexFieldRequestRequestTypeDef(TypedDict):
    DomainName: str,
    IndexFieldName: str,

DeleteSuggesterRequestRequestTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DeleteSuggesterRequestRequestTypeDef

def get_value() -> DeleteSuggesterRequestRequestTypeDef:
    return {
        "DomainName": ...,
        "SuggesterName": ...,
    }
Definition
class DeleteSuggesterRequestRequestTypeDef(TypedDict):
    DomainName: str,
    SuggesterName: str,

DescribeAnalysisSchemesRequestRequestTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DescribeAnalysisSchemesRequestRequestTypeDef

def get_value() -> DescribeAnalysisSchemesRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
Definition
class DescribeAnalysisSchemesRequestRequestTypeDef(TypedDict):
    DomainName: str,
    AnalysisSchemeNames: NotRequired[Sequence[str]],
    Deployed: NotRequired[bool],

DescribeAvailabilityOptionsRequestRequestTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DescribeAvailabilityOptionsRequestRequestTypeDef

def get_value() -> DescribeAvailabilityOptionsRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
Definition
class DescribeAvailabilityOptionsRequestRequestTypeDef(TypedDict):
    DomainName: str,
    Deployed: NotRequired[bool],

DescribeDomainEndpointOptionsRequestRequestTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DescribeDomainEndpointOptionsRequestRequestTypeDef

def get_value() -> DescribeDomainEndpointOptionsRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
Definition
class DescribeDomainEndpointOptionsRequestRequestTypeDef(TypedDict):
    DomainName: str,
    Deployed: NotRequired[bool],

DescribeDomainsRequestRequestTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DescribeDomainsRequestRequestTypeDef

def get_value() -> DescribeDomainsRequestRequestTypeDef:
    return {
        "DomainNames": ...,
    }
Definition
class DescribeDomainsRequestRequestTypeDef(TypedDict):
    DomainNames: NotRequired[Sequence[str]],

DescribeExpressionsRequestRequestTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DescribeExpressionsRequestRequestTypeDef

def get_value() -> DescribeExpressionsRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
Definition
class DescribeExpressionsRequestRequestTypeDef(TypedDict):
    DomainName: str,
    ExpressionNames: NotRequired[Sequence[str]],
    Deployed: NotRequired[bool],

DescribeIndexFieldsRequestRequestTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DescribeIndexFieldsRequestRequestTypeDef

def get_value() -> DescribeIndexFieldsRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
Definition
class DescribeIndexFieldsRequestRequestTypeDef(TypedDict):
    DomainName: str,
    FieldNames: NotRequired[Sequence[str]],
    Deployed: NotRequired[bool],

DescribeScalingParametersRequestRequestTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DescribeScalingParametersRequestRequestTypeDef

def get_value() -> DescribeScalingParametersRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
Definition
class DescribeScalingParametersRequestRequestTypeDef(TypedDict):
    DomainName: str,

DescribeServiceAccessPoliciesRequestRequestTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DescribeServiceAccessPoliciesRequestRequestTypeDef

def get_value() -> DescribeServiceAccessPoliciesRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
Definition
class DescribeServiceAccessPoliciesRequestRequestTypeDef(TypedDict):
    DomainName: str,
    Deployed: NotRequired[bool],

DescribeSuggestersRequestRequestTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DescribeSuggestersRequestRequestTypeDef

def get_value() -> DescribeSuggestersRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
Definition
class DescribeSuggestersRequestRequestTypeDef(TypedDict):
    DomainName: str,
    SuggesterNames: NotRequired[Sequence[str]],
    Deployed: NotRequired[bool],

DocumentSuggesterOptionsTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DocumentSuggesterOptionsTypeDef

def get_value() -> DocumentSuggesterOptionsTypeDef:
    return {
        "SourceField": ...,
    }
Definition
class DocumentSuggesterOptionsTypeDef(TypedDict):
    SourceField: str,
    FuzzyMatching: NotRequired[SuggesterFuzzyMatchingType],  # (1)
    SortExpression: NotRequired[str],
  1. See SuggesterFuzzyMatchingType

DomainEndpointOptionsTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DomainEndpointOptionsTypeDef

def get_value() -> DomainEndpointOptionsTypeDef:
    return {
        "EnforceHTTPS": ...,
    }
Definition
class DomainEndpointOptionsTypeDef(TypedDict):
    EnforceHTTPS: NotRequired[bool],
    TLSSecurityPolicy: NotRequired[TLSSecurityPolicyType],  # (1)
  1. See TLSSecurityPolicyType

LimitsTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import LimitsTypeDef

def get_value() -> LimitsTypeDef:
    return {
        "MaximumReplicationCount": ...,
        "MaximumPartitionCount": ...,
    }
Definition
class LimitsTypeDef(TypedDict):
    MaximumReplicationCount: int,
    MaximumPartitionCount: int,

ServiceEndpointTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import ServiceEndpointTypeDef

def get_value() -> ServiceEndpointTypeDef:
    return {
        "Endpoint": ...,
    }
Definition
class ServiceEndpointTypeDef(TypedDict):
    Endpoint: NotRequired[str],

DoubleArrayOptionsTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DoubleArrayOptionsTypeDef

def get_value() -> DoubleArrayOptionsTypeDef:
    return {
        "DefaultValue": ...,
    }
Definition
class DoubleArrayOptionsTypeDef(TypedDict):
    DefaultValue: NotRequired[float],
    SourceFields: NotRequired[str],
    FacetEnabled: NotRequired[bool],
    SearchEnabled: NotRequired[bool],
    ReturnEnabled: NotRequired[bool],

DoubleOptionsTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DoubleOptionsTypeDef

def get_value() -> DoubleOptionsTypeDef:
    return {
        "DefaultValue": ...,
    }
Definition
class DoubleOptionsTypeDef(TypedDict):
    DefaultValue: NotRequired[float],
    SourceField: NotRequired[str],
    FacetEnabled: NotRequired[bool],
    SearchEnabled: NotRequired[bool],
    ReturnEnabled: NotRequired[bool],
    SortEnabled: NotRequired[bool],

IndexDocumentsRequestRequestTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import IndexDocumentsRequestRequestTypeDef

def get_value() -> IndexDocumentsRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
Definition
class IndexDocumentsRequestRequestTypeDef(TypedDict):
    DomainName: str,

IntArrayOptionsTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import IntArrayOptionsTypeDef

def get_value() -> IntArrayOptionsTypeDef:
    return {
        "DefaultValue": ...,
    }
Definition
class IntArrayOptionsTypeDef(TypedDict):
    DefaultValue: NotRequired[int],
    SourceFields: NotRequired[str],
    FacetEnabled: NotRequired[bool],
    SearchEnabled: NotRequired[bool],
    ReturnEnabled: NotRequired[bool],

IntOptionsTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import IntOptionsTypeDef

def get_value() -> IntOptionsTypeDef:
    return {
        "DefaultValue": ...,
    }
Definition
class IntOptionsTypeDef(TypedDict):
    DefaultValue: NotRequired[int],
    SourceField: NotRequired[str],
    FacetEnabled: NotRequired[bool],
    SearchEnabled: NotRequired[bool],
    ReturnEnabled: NotRequired[bool],
    SortEnabled: NotRequired[bool],

LatLonOptionsTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import LatLonOptionsTypeDef

def get_value() -> LatLonOptionsTypeDef:
    return {
        "DefaultValue": ...,
    }
Definition
class LatLonOptionsTypeDef(TypedDict):
    DefaultValue: NotRequired[str],
    SourceField: NotRequired[str],
    FacetEnabled: NotRequired[bool],
    SearchEnabled: NotRequired[bool],
    ReturnEnabled: NotRequired[bool],
    SortEnabled: NotRequired[bool],

LiteralArrayOptionsTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import LiteralArrayOptionsTypeDef

def get_value() -> LiteralArrayOptionsTypeDef:
    return {
        "DefaultValue": ...,
    }
Definition
class LiteralArrayOptionsTypeDef(TypedDict):
    DefaultValue: NotRequired[str],
    SourceFields: NotRequired[str],
    FacetEnabled: NotRequired[bool],
    SearchEnabled: NotRequired[bool],
    ReturnEnabled: NotRequired[bool],

LiteralOptionsTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import LiteralOptionsTypeDef

def get_value() -> LiteralOptionsTypeDef:
    return {
        "DefaultValue": ...,
    }
Definition
class LiteralOptionsTypeDef(TypedDict):
    DefaultValue: NotRequired[str],
    SourceField: NotRequired[str],
    FacetEnabled: NotRequired[bool],
    SearchEnabled: NotRequired[bool],
    ReturnEnabled: NotRequired[bool],
    SortEnabled: NotRequired[bool],

TextArrayOptionsTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import TextArrayOptionsTypeDef

def get_value() -> TextArrayOptionsTypeDef:
    return {
        "DefaultValue": ...,
    }
Definition
class TextArrayOptionsTypeDef(TypedDict):
    DefaultValue: NotRequired[str],
    SourceFields: NotRequired[str],
    ReturnEnabled: NotRequired[bool],
    HighlightEnabled: NotRequired[bool],
    AnalysisScheme: NotRequired[str],

TextOptionsTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import TextOptionsTypeDef

def get_value() -> TextOptionsTypeDef:
    return {
        "DefaultValue": ...,
    }
Definition
class TextOptionsTypeDef(TypedDict):
    DefaultValue: NotRequired[str],
    SourceField: NotRequired[str],
    ReturnEnabled: NotRequired[bool],
    SortEnabled: NotRequired[bool],
    HighlightEnabled: NotRequired[bool],
    AnalysisScheme: NotRequired[str],

ScalingParametersTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import ScalingParametersTypeDef

def get_value() -> ScalingParametersTypeDef:
    return {
        "DesiredInstanceType": ...,
    }
Definition
class ScalingParametersTypeDef(TypedDict):
    DesiredInstanceType: NotRequired[PartitionInstanceTypeType],  # (1)
    DesiredReplicationCount: NotRequired[int],
    DesiredPartitionCount: NotRequired[int],
  1. See PartitionInstanceTypeType

UpdateAvailabilityOptionsRequestRequestTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import UpdateAvailabilityOptionsRequestRequestTypeDef

def get_value() -> UpdateAvailabilityOptionsRequestRequestTypeDef:
    return {
        "DomainName": ...,
        "MultiAZ": ...,
    }
Definition
class UpdateAvailabilityOptionsRequestRequestTypeDef(TypedDict):
    DomainName: str,
    MultiAZ: bool,

UpdateServiceAccessPoliciesRequestRequestTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import UpdateServiceAccessPoliciesRequestRequestTypeDef

def get_value() -> UpdateServiceAccessPoliciesRequestRequestTypeDef:
    return {
        "DomainName": ...,
        "AccessPolicies": ...,
    }
Definition
class UpdateServiceAccessPoliciesRequestRequestTypeDef(TypedDict):
    DomainName: str,
    AccessPolicies: str,

AccessPoliciesStatusTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import AccessPoliciesStatusTypeDef

def get_value() -> AccessPoliciesStatusTypeDef:
    return {
        "Options": ...,
        "Status": ...,
    }
Definition
class AccessPoliciesStatusTypeDef(TypedDict):
    Options: str,
    Status: OptionStatusTypeDef,  # (1)
  1. See OptionStatusTypeDef

AvailabilityOptionsStatusTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import AvailabilityOptionsStatusTypeDef

def get_value() -> AvailabilityOptionsStatusTypeDef:
    return {
        "Options": ...,
        "Status": ...,
    }
Definition
class AvailabilityOptionsStatusTypeDef(TypedDict):
    Options: bool,
    Status: OptionStatusTypeDef,  # (1)
  1. See OptionStatusTypeDef

AnalysisSchemeTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import AnalysisSchemeTypeDef

def get_value() -> AnalysisSchemeTypeDef:
    return {
        "AnalysisSchemeName": ...,
        "AnalysisSchemeLanguage": ...,
    }
Definition
class AnalysisSchemeTypeDef(TypedDict):
    AnalysisSchemeName: str,
    AnalysisSchemeLanguage: AnalysisSchemeLanguageType,  # (1)
    AnalysisOptions: NotRequired[AnalysisOptionsTypeDef],  # (2)
  1. See AnalysisSchemeLanguageType
  2. See AnalysisOptionsTypeDef

BuildSuggestersResponseTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import BuildSuggestersResponseTypeDef

def get_value() -> BuildSuggestersResponseTypeDef:
    return {
        "FieldNames": ...,
        "ResponseMetadata": ...,
    }
Definition
class BuildSuggestersResponseTypeDef(TypedDict):
    FieldNames: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

IndexDocumentsResponseTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import IndexDocumentsResponseTypeDef

def get_value() -> IndexDocumentsResponseTypeDef:
    return {
        "FieldNames": ...,
        "ResponseMetadata": ...,
    }
Definition
class IndexDocumentsResponseTypeDef(TypedDict):
    FieldNames: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListDomainNamesResponseTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import ListDomainNamesResponseTypeDef

def get_value() -> ListDomainNamesResponseTypeDef:
    return {
        "DomainNames": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListDomainNamesResponseTypeDef(TypedDict):
    DomainNames: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DefineExpressionRequestRequestTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DefineExpressionRequestRequestTypeDef

def get_value() -> DefineExpressionRequestRequestTypeDef:
    return {
        "DomainName": ...,
        "Expression": ...,
    }
Definition
class DefineExpressionRequestRequestTypeDef(TypedDict):
    DomainName: str,
    Expression: ExpressionTypeDef,  # (1)
  1. See ExpressionTypeDef

ExpressionStatusTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import ExpressionStatusTypeDef

def get_value() -> ExpressionStatusTypeDef:
    return {
        "Options": ...,
        "Status": ...,
    }
Definition
class ExpressionStatusTypeDef(TypedDict):
    Options: ExpressionTypeDef,  # (1)
    Status: OptionStatusTypeDef,  # (2)
  1. See ExpressionTypeDef
  2. See OptionStatusTypeDef

SuggesterTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import SuggesterTypeDef

def get_value() -> SuggesterTypeDef:
    return {
        "SuggesterName": ...,
        "DocumentSuggesterOptions": ...,
    }
Definition
class SuggesterTypeDef(TypedDict):
    SuggesterName: str,
    DocumentSuggesterOptions: DocumentSuggesterOptionsTypeDef,  # (1)
  1. See DocumentSuggesterOptionsTypeDef

DomainEndpointOptionsStatusTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DomainEndpointOptionsStatusTypeDef

def get_value() -> DomainEndpointOptionsStatusTypeDef:
    return {
        "Options": ...,
        "Status": ...,
    }
Definition
class DomainEndpointOptionsStatusTypeDef(TypedDict):
    Options: DomainEndpointOptionsTypeDef,  # (1)
    Status: OptionStatusTypeDef,  # (2)
  1. See DomainEndpointOptionsTypeDef
  2. See OptionStatusTypeDef

UpdateDomainEndpointOptionsRequestRequestTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import UpdateDomainEndpointOptionsRequestRequestTypeDef

def get_value() -> UpdateDomainEndpointOptionsRequestRequestTypeDef:
    return {
        "DomainName": ...,
        "DomainEndpointOptions": ...,
    }
Definition
class UpdateDomainEndpointOptionsRequestRequestTypeDef(TypedDict):
    DomainName: str,
    DomainEndpointOptions: DomainEndpointOptionsTypeDef,  # (1)
  1. See DomainEndpointOptionsTypeDef

DomainStatusTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DomainStatusTypeDef

def get_value() -> DomainStatusTypeDef:
    return {
        "DomainId": ...,
        "DomainName": ...,
        "RequiresIndexDocuments": ...,
    }
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

Usage Example
from mypy_boto3_cloudsearch.type_defs import IndexFieldTypeDef

def get_value() -> IndexFieldTypeDef:
    return {
        "IndexFieldName": ...,
        "IndexFieldType": ...,
    }
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

Usage Example
from mypy_boto3_cloudsearch.type_defs import ScalingParametersStatusTypeDef

def get_value() -> ScalingParametersStatusTypeDef:
    return {
        "Options": ...,
        "Status": ...,
    }
Definition
class ScalingParametersStatusTypeDef(TypedDict):
    Options: ScalingParametersTypeDef,  # (1)
    Status: OptionStatusTypeDef,  # (2)
  1. See ScalingParametersTypeDef
  2. See OptionStatusTypeDef

UpdateScalingParametersRequestRequestTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import UpdateScalingParametersRequestRequestTypeDef

def get_value() -> UpdateScalingParametersRequestRequestTypeDef:
    return {
        "DomainName": ...,
        "ScalingParameters": ...,
    }
Definition
class UpdateScalingParametersRequestRequestTypeDef(TypedDict):
    DomainName: str,
    ScalingParameters: ScalingParametersTypeDef,  # (1)
  1. See ScalingParametersTypeDef

DescribeServiceAccessPoliciesResponseTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DescribeServiceAccessPoliciesResponseTypeDef

def get_value() -> DescribeServiceAccessPoliciesResponseTypeDef:
    return {
        "AccessPolicies": ...,
        "ResponseMetadata": ...,
    }
Definition
class DescribeServiceAccessPoliciesResponseTypeDef(TypedDict):
    AccessPolicies: AccessPoliciesStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AccessPoliciesStatusTypeDef
  2. See ResponseMetadataTypeDef

UpdateServiceAccessPoliciesResponseTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import UpdateServiceAccessPoliciesResponseTypeDef

def get_value() -> UpdateServiceAccessPoliciesResponseTypeDef:
    return {
        "AccessPolicies": ...,
        "ResponseMetadata": ...,
    }
Definition
class UpdateServiceAccessPoliciesResponseTypeDef(TypedDict):
    AccessPolicies: AccessPoliciesStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AccessPoliciesStatusTypeDef
  2. See ResponseMetadataTypeDef

DescribeAvailabilityOptionsResponseTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DescribeAvailabilityOptionsResponseTypeDef

def get_value() -> DescribeAvailabilityOptionsResponseTypeDef:
    return {
        "AvailabilityOptions": ...,
        "ResponseMetadata": ...,
    }
Definition
class DescribeAvailabilityOptionsResponseTypeDef(TypedDict):
    AvailabilityOptions: AvailabilityOptionsStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AvailabilityOptionsStatusTypeDef
  2. See ResponseMetadataTypeDef

UpdateAvailabilityOptionsResponseTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import UpdateAvailabilityOptionsResponseTypeDef

def get_value() -> UpdateAvailabilityOptionsResponseTypeDef:
    return {
        "AvailabilityOptions": ...,
        "ResponseMetadata": ...,
    }
Definition
class UpdateAvailabilityOptionsResponseTypeDef(TypedDict):
    AvailabilityOptions: AvailabilityOptionsStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AvailabilityOptionsStatusTypeDef
  2. See ResponseMetadataTypeDef

AnalysisSchemeStatusTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import AnalysisSchemeStatusTypeDef

def get_value() -> AnalysisSchemeStatusTypeDef:
    return {
        "Options": ...,
        "Status": ...,
    }
Definition
class AnalysisSchemeStatusTypeDef(TypedDict):
    Options: AnalysisSchemeTypeDef,  # (1)
    Status: OptionStatusTypeDef,  # (2)
  1. See AnalysisSchemeTypeDef
  2. See OptionStatusTypeDef

DefineAnalysisSchemeRequestRequestTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DefineAnalysisSchemeRequestRequestTypeDef

def get_value() -> DefineAnalysisSchemeRequestRequestTypeDef:
    return {
        "DomainName": ...,
        "AnalysisScheme": ...,
    }
Definition
class DefineAnalysisSchemeRequestRequestTypeDef(TypedDict):
    DomainName: str,
    AnalysisScheme: AnalysisSchemeTypeDef,  # (1)
  1. See AnalysisSchemeTypeDef

DefineExpressionResponseTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DefineExpressionResponseTypeDef

def get_value() -> DefineExpressionResponseTypeDef:
    return {
        "Expression": ...,
        "ResponseMetadata": ...,
    }
Definition
class DefineExpressionResponseTypeDef(TypedDict):
    Expression: ExpressionStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ExpressionStatusTypeDef
  2. See ResponseMetadataTypeDef

DeleteExpressionResponseTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DeleteExpressionResponseTypeDef

def get_value() -> DeleteExpressionResponseTypeDef:
    return {
        "Expression": ...,
        "ResponseMetadata": ...,
    }
Definition
class DeleteExpressionResponseTypeDef(TypedDict):
    Expression: ExpressionStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ExpressionStatusTypeDef
  2. See ResponseMetadataTypeDef

DescribeExpressionsResponseTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DescribeExpressionsResponseTypeDef

def get_value() -> DescribeExpressionsResponseTypeDef:
    return {
        "Expressions": ...,
        "ResponseMetadata": ...,
    }
Definition
class DescribeExpressionsResponseTypeDef(TypedDict):
    Expressions: List[ExpressionStatusTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ExpressionStatusTypeDef
  2. See ResponseMetadataTypeDef

DefineSuggesterRequestRequestTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DefineSuggesterRequestRequestTypeDef

def get_value() -> DefineSuggesterRequestRequestTypeDef:
    return {
        "DomainName": ...,
        "Suggester": ...,
    }
Definition
class DefineSuggesterRequestRequestTypeDef(TypedDict):
    DomainName: str,
    Suggester: SuggesterTypeDef,  # (1)
  1. See SuggesterTypeDef

SuggesterStatusTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import SuggesterStatusTypeDef

def get_value() -> SuggesterStatusTypeDef:
    return {
        "Options": ...,
        "Status": ...,
    }
Definition
class SuggesterStatusTypeDef(TypedDict):
    Options: SuggesterTypeDef,  # (1)
    Status: OptionStatusTypeDef,  # (2)
  1. See SuggesterTypeDef
  2. See OptionStatusTypeDef

DescribeDomainEndpointOptionsResponseTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DescribeDomainEndpointOptionsResponseTypeDef

def get_value() -> DescribeDomainEndpointOptionsResponseTypeDef:
    return {
        "DomainEndpointOptions": ...,
        "ResponseMetadata": ...,
    }
Definition
class DescribeDomainEndpointOptionsResponseTypeDef(TypedDict):
    DomainEndpointOptions: DomainEndpointOptionsStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainEndpointOptionsStatusTypeDef
  2. See ResponseMetadataTypeDef

UpdateDomainEndpointOptionsResponseTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import UpdateDomainEndpointOptionsResponseTypeDef

def get_value() -> UpdateDomainEndpointOptionsResponseTypeDef:
    return {
        "DomainEndpointOptions": ...,
        "ResponseMetadata": ...,
    }
Definition
class UpdateDomainEndpointOptionsResponseTypeDef(TypedDict):
    DomainEndpointOptions: DomainEndpointOptionsStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainEndpointOptionsStatusTypeDef
  2. See ResponseMetadataTypeDef

CreateDomainResponseTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import CreateDomainResponseTypeDef

def get_value() -> CreateDomainResponseTypeDef:
    return {
        "DomainStatus": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateDomainResponseTypeDef(TypedDict):
    DomainStatus: DomainStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainStatusTypeDef
  2. See ResponseMetadataTypeDef

DeleteDomainResponseTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DeleteDomainResponseTypeDef

def get_value() -> DeleteDomainResponseTypeDef:
    return {
        "DomainStatus": ...,
        "ResponseMetadata": ...,
    }
Definition
class DeleteDomainResponseTypeDef(TypedDict):
    DomainStatus: DomainStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainStatusTypeDef
  2. See ResponseMetadataTypeDef

DescribeDomainsResponseTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DescribeDomainsResponseTypeDef

def get_value() -> DescribeDomainsResponseTypeDef:
    return {
        "DomainStatusList": ...,
        "ResponseMetadata": ...,
    }
Definition
class DescribeDomainsResponseTypeDef(TypedDict):
    DomainStatusList: List[DomainStatusTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainStatusTypeDef
  2. See ResponseMetadataTypeDef

DefineIndexFieldRequestRequestTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DefineIndexFieldRequestRequestTypeDef

def get_value() -> DefineIndexFieldRequestRequestTypeDef:
    return {
        "DomainName": ...,
        "IndexField": ...,
    }
Definition
class DefineIndexFieldRequestRequestTypeDef(TypedDict):
    DomainName: str,
    IndexField: IndexFieldTypeDef,  # (1)
  1. See IndexFieldTypeDef

IndexFieldStatusTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import IndexFieldStatusTypeDef

def get_value() -> IndexFieldStatusTypeDef:
    return {
        "Options": ...,
        "Status": ...,
    }
Definition
class IndexFieldStatusTypeDef(TypedDict):
    Options: IndexFieldTypeDef,  # (1)
    Status: OptionStatusTypeDef,  # (2)
  1. See IndexFieldTypeDef
  2. See OptionStatusTypeDef

DescribeScalingParametersResponseTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DescribeScalingParametersResponseTypeDef

def get_value() -> DescribeScalingParametersResponseTypeDef:
    return {
        "ScalingParameters": ...,
        "ResponseMetadata": ...,
    }
Definition
class DescribeScalingParametersResponseTypeDef(TypedDict):
    ScalingParameters: ScalingParametersStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ScalingParametersStatusTypeDef
  2. See ResponseMetadataTypeDef

UpdateScalingParametersResponseTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import UpdateScalingParametersResponseTypeDef

def get_value() -> UpdateScalingParametersResponseTypeDef:
    return {
        "ScalingParameters": ...,
        "ResponseMetadata": ...,
    }
Definition
class UpdateScalingParametersResponseTypeDef(TypedDict):
    ScalingParameters: ScalingParametersStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ScalingParametersStatusTypeDef
  2. See ResponseMetadataTypeDef

DefineAnalysisSchemeResponseTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DefineAnalysisSchemeResponseTypeDef

def get_value() -> DefineAnalysisSchemeResponseTypeDef:
    return {
        "AnalysisScheme": ...,
        "ResponseMetadata": ...,
    }
Definition
class DefineAnalysisSchemeResponseTypeDef(TypedDict):
    AnalysisScheme: AnalysisSchemeStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AnalysisSchemeStatusTypeDef
  2. See ResponseMetadataTypeDef

DeleteAnalysisSchemeResponseTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DeleteAnalysisSchemeResponseTypeDef

def get_value() -> DeleteAnalysisSchemeResponseTypeDef:
    return {
        "AnalysisScheme": ...,
        "ResponseMetadata": ...,
    }
Definition
class DeleteAnalysisSchemeResponseTypeDef(TypedDict):
    AnalysisScheme: AnalysisSchemeStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AnalysisSchemeStatusTypeDef
  2. See ResponseMetadataTypeDef

DescribeAnalysisSchemesResponseTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DescribeAnalysisSchemesResponseTypeDef

def get_value() -> DescribeAnalysisSchemesResponseTypeDef:
    return {
        "AnalysisSchemes": ...,
        "ResponseMetadata": ...,
    }
Definition
class DescribeAnalysisSchemesResponseTypeDef(TypedDict):
    AnalysisSchemes: List[AnalysisSchemeStatusTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AnalysisSchemeStatusTypeDef
  2. See ResponseMetadataTypeDef

DefineSuggesterResponseTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DefineSuggesterResponseTypeDef

def get_value() -> DefineSuggesterResponseTypeDef:
    return {
        "Suggester": ...,
        "ResponseMetadata": ...,
    }
Definition
class DefineSuggesterResponseTypeDef(TypedDict):
    Suggester: SuggesterStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SuggesterStatusTypeDef
  2. See ResponseMetadataTypeDef

DeleteSuggesterResponseTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DeleteSuggesterResponseTypeDef

def get_value() -> DeleteSuggesterResponseTypeDef:
    return {
        "Suggester": ...,
        "ResponseMetadata": ...,
    }
Definition
class DeleteSuggesterResponseTypeDef(TypedDict):
    Suggester: SuggesterStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SuggesterStatusTypeDef
  2. See ResponseMetadataTypeDef

DescribeSuggestersResponseTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DescribeSuggestersResponseTypeDef

def get_value() -> DescribeSuggestersResponseTypeDef:
    return {
        "Suggesters": ...,
        "ResponseMetadata": ...,
    }
Definition
class DescribeSuggestersResponseTypeDef(TypedDict):
    Suggesters: List[SuggesterStatusTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SuggesterStatusTypeDef
  2. See ResponseMetadataTypeDef

DefineIndexFieldResponseTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DefineIndexFieldResponseTypeDef

def get_value() -> DefineIndexFieldResponseTypeDef:
    return {
        "IndexField": ...,
        "ResponseMetadata": ...,
    }
Definition
class DefineIndexFieldResponseTypeDef(TypedDict):
    IndexField: IndexFieldStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See IndexFieldStatusTypeDef
  2. See ResponseMetadataTypeDef

DeleteIndexFieldResponseTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DeleteIndexFieldResponseTypeDef

def get_value() -> DeleteIndexFieldResponseTypeDef:
    return {
        "IndexField": ...,
        "ResponseMetadata": ...,
    }
Definition
class DeleteIndexFieldResponseTypeDef(TypedDict):
    IndexField: IndexFieldStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See IndexFieldStatusTypeDef
  2. See ResponseMetadataTypeDef

DescribeIndexFieldsResponseTypeDef

Usage Example
from mypy_boto3_cloudsearch.type_defs import DescribeIndexFieldsResponseTypeDef

def get_value() -> DescribeIndexFieldsResponseTypeDef:
    return {
        "IndexFields": ...,
        "ResponseMetadata": ...,
    }
Definition
class DescribeIndexFieldsResponseTypeDef(TypedDict):
    IndexFields: List[IndexFieldStatusTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See IndexFieldStatusTypeDef
  2. See ResponseMetadataTypeDef