Skip to content

Type definitions#

Index > CloudSearch > Type definitions

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

OptionStatusTypeDef#

# OptionStatusTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import OptionStatusTypeDef


def get_value() -> OptionStatusTypeDef:
    return {
        "CreationDate": ...,
    }


# OptionStatusTypeDef definition

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

AnalysisOptionsTypeDef#

# AnalysisOptionsTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import AnalysisOptionsTypeDef


def get_value() -> AnalysisOptionsTypeDef:
    return {
        "Synonyms": ...,
    }


# AnalysisOptionsTypeDef definition

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

BuildSuggestersRequestTypeDef#

# BuildSuggestersRequestTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import BuildSuggestersRequestTypeDef


def get_value() -> BuildSuggestersRequestTypeDef:
    return {
        "DomainName": ...,
    }


# BuildSuggestersRequestTypeDef definition

class BuildSuggestersRequestTypeDef(TypedDict):
    DomainName: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef TypedDict usage example

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

CreateDomainRequestTypeDef#

# CreateDomainRequestTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import CreateDomainRequestTypeDef


def get_value() -> CreateDomainRequestTypeDef:
    return {
        "DomainName": ...,
    }


# CreateDomainRequestTypeDef definition

class CreateDomainRequestTypeDef(TypedDict):
    DomainName: str,

DateArrayOptionsTypeDef#

# DateArrayOptionsTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DateArrayOptionsTypeDef


def get_value() -> DateArrayOptionsTypeDef:
    return {
        "DefaultValue": ...,
    }


# DateArrayOptionsTypeDef definition

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

DateOptionsTypeDef#

# DateOptionsTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DateOptionsTypeDef


def get_value() -> DateOptionsTypeDef:
    return {
        "DefaultValue": ...,
    }


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

from types_boto3_cloudsearch.type_defs import ExpressionTypeDef


def get_value() -> ExpressionTypeDef:
    return {
        "ExpressionName": ...,
    }


# ExpressionTypeDef definition

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

DeleteAnalysisSchemeRequestTypeDef#

# DeleteAnalysisSchemeRequestTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DeleteAnalysisSchemeRequestTypeDef


def get_value() -> DeleteAnalysisSchemeRequestTypeDef:
    return {
        "DomainName": ...,
    }


# DeleteAnalysisSchemeRequestTypeDef definition

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

DeleteDomainRequestTypeDef#

# DeleteDomainRequestTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DeleteDomainRequestTypeDef


def get_value() -> DeleteDomainRequestTypeDef:
    return {
        "DomainName": ...,
    }


# DeleteDomainRequestTypeDef definition

class DeleteDomainRequestTypeDef(TypedDict):
    DomainName: str,

DeleteExpressionRequestTypeDef#

# DeleteExpressionRequestTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DeleteExpressionRequestTypeDef


def get_value() -> DeleteExpressionRequestTypeDef:
    return {
        "DomainName": ...,
    }


# DeleteExpressionRequestTypeDef definition

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

DeleteIndexFieldRequestTypeDef#

# DeleteIndexFieldRequestTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DeleteIndexFieldRequestTypeDef


def get_value() -> DeleteIndexFieldRequestTypeDef:
    return {
        "DomainName": ...,
    }


# DeleteIndexFieldRequestTypeDef definition

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

DeleteSuggesterRequestTypeDef#

# DeleteSuggesterRequestTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DeleteSuggesterRequestTypeDef


def get_value() -> DeleteSuggesterRequestTypeDef:
    return {
        "DomainName": ...,
    }


# DeleteSuggesterRequestTypeDef definition

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

DescribeAnalysisSchemesRequestTypeDef#

# DescribeAnalysisSchemesRequestTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DescribeAnalysisSchemesRequestTypeDef


def get_value() -> DescribeAnalysisSchemesRequestTypeDef:
    return {
        "DomainName": ...,
    }


# DescribeAnalysisSchemesRequestTypeDef definition

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

DescribeAvailabilityOptionsRequestTypeDef#

# DescribeAvailabilityOptionsRequestTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DescribeAvailabilityOptionsRequestTypeDef


def get_value() -> DescribeAvailabilityOptionsRequestTypeDef:
    return {
        "DomainName": ...,
    }


# DescribeAvailabilityOptionsRequestTypeDef definition

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

DescribeDomainEndpointOptionsRequestTypeDef#

# DescribeDomainEndpointOptionsRequestTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DescribeDomainEndpointOptionsRequestTypeDef


def get_value() -> DescribeDomainEndpointOptionsRequestTypeDef:
    return {
        "DomainName": ...,
    }


# DescribeDomainEndpointOptionsRequestTypeDef definition

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

DescribeDomainsRequestTypeDef#

# DescribeDomainsRequestTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DescribeDomainsRequestTypeDef


def get_value() -> DescribeDomainsRequestTypeDef:
    return {
        "DomainNames": ...,
    }


# DescribeDomainsRequestTypeDef definition

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

DescribeExpressionsRequestTypeDef#

# DescribeExpressionsRequestTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DescribeExpressionsRequestTypeDef


def get_value() -> DescribeExpressionsRequestTypeDef:
    return {
        "DomainName": ...,
    }


# DescribeExpressionsRequestTypeDef definition

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

DescribeIndexFieldsRequestTypeDef#

# DescribeIndexFieldsRequestTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DescribeIndexFieldsRequestTypeDef


def get_value() -> DescribeIndexFieldsRequestTypeDef:
    return {
        "DomainName": ...,
    }


# DescribeIndexFieldsRequestTypeDef definition

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

DescribeScalingParametersRequestTypeDef#

# DescribeScalingParametersRequestTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DescribeScalingParametersRequestTypeDef


def get_value() -> DescribeScalingParametersRequestTypeDef:
    return {
        "DomainName": ...,
    }


# DescribeScalingParametersRequestTypeDef definition

class DescribeScalingParametersRequestTypeDef(TypedDict):
    DomainName: str,

DescribeServiceAccessPoliciesRequestTypeDef#

# DescribeServiceAccessPoliciesRequestTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DescribeServiceAccessPoliciesRequestTypeDef


def get_value() -> DescribeServiceAccessPoliciesRequestTypeDef:
    return {
        "DomainName": ...,
    }


# DescribeServiceAccessPoliciesRequestTypeDef definition

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

DescribeSuggestersRequestTypeDef#

# DescribeSuggestersRequestTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DescribeSuggestersRequestTypeDef


def get_value() -> DescribeSuggestersRequestTypeDef:
    return {
        "DomainName": ...,
    }


# DescribeSuggestersRequestTypeDef definition

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

DocumentSuggesterOptionsTypeDef#

# DocumentSuggesterOptionsTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DocumentSuggesterOptionsTypeDef


def get_value() -> DocumentSuggesterOptionsTypeDef:
    return {
        "SourceField": ...,
    }


# DocumentSuggesterOptionsTypeDef definition

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

DomainEndpointOptionsTypeDef#

# DomainEndpointOptionsTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DomainEndpointOptionsTypeDef


def get_value() -> DomainEndpointOptionsTypeDef:
    return {
        "EnforceHTTPS": ...,
    }


# DomainEndpointOptionsTypeDef definition

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

LimitsTypeDef#

# LimitsTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import LimitsTypeDef


def get_value() -> LimitsTypeDef:
    return {
        "MaximumReplicationCount": ...,
    }


# LimitsTypeDef definition

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

ServiceEndpointTypeDef#

# ServiceEndpointTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import ServiceEndpointTypeDef


def get_value() -> ServiceEndpointTypeDef:
    return {
        "Endpoint": ...,
    }


# ServiceEndpointTypeDef definition

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

DoubleArrayOptionsTypeDef#

# DoubleArrayOptionsTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DoubleArrayOptionsTypeDef


def get_value() -> DoubleArrayOptionsTypeDef:
    return {
        "DefaultValue": ...,
    }


# DoubleArrayOptionsTypeDef definition

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

DoubleOptionsTypeDef#

# DoubleOptionsTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DoubleOptionsTypeDef


def get_value() -> DoubleOptionsTypeDef:
    return {
        "DefaultValue": ...,
    }


# DoubleOptionsTypeDef definition

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

IndexDocumentsRequestTypeDef#

# IndexDocumentsRequestTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import IndexDocumentsRequestTypeDef


def get_value() -> IndexDocumentsRequestTypeDef:
    return {
        "DomainName": ...,
    }


# IndexDocumentsRequestTypeDef definition

class IndexDocumentsRequestTypeDef(TypedDict):
    DomainName: str,

IntArrayOptionsTypeDef#

# IntArrayOptionsTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import IntArrayOptionsTypeDef


def get_value() -> IntArrayOptionsTypeDef:
    return {
        "DefaultValue": ...,
    }


# IntArrayOptionsTypeDef definition

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

IntOptionsTypeDef#

# IntOptionsTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import IntOptionsTypeDef


def get_value() -> IntOptionsTypeDef:
    return {
        "DefaultValue": ...,
    }


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

from types_boto3_cloudsearch.type_defs import LatLonOptionsTypeDef


def get_value() -> LatLonOptionsTypeDef:
    return {
        "DefaultValue": ...,
    }


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

from types_boto3_cloudsearch.type_defs import LiteralArrayOptionsTypeDef


def get_value() -> LiteralArrayOptionsTypeDef:
    return {
        "DefaultValue": ...,
    }


# LiteralArrayOptionsTypeDef definition

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

LiteralOptionsTypeDef#

# LiteralOptionsTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import LiteralOptionsTypeDef


def get_value() -> LiteralOptionsTypeDef:
    return {
        "DefaultValue": ...,
    }


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

from types_boto3_cloudsearch.type_defs import TextArrayOptionsTypeDef


def get_value() -> TextArrayOptionsTypeDef:
    return {
        "DefaultValue": ...,
    }


# TextArrayOptionsTypeDef definition

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

TextOptionsTypeDef#

# TextOptionsTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import TextOptionsTypeDef


def get_value() -> TextOptionsTypeDef:
    return {
        "DefaultValue": ...,
    }


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

from types_boto3_cloudsearch.type_defs import ScalingParametersTypeDef


def get_value() -> ScalingParametersTypeDef:
    return {
        "DesiredInstanceType": ...,
    }


# ScalingParametersTypeDef definition

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

UpdateAvailabilityOptionsRequestTypeDef#

# UpdateAvailabilityOptionsRequestTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import UpdateAvailabilityOptionsRequestTypeDef


def get_value() -> UpdateAvailabilityOptionsRequestTypeDef:
    return {
        "DomainName": ...,
    }


# UpdateAvailabilityOptionsRequestTypeDef definition

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

UpdateServiceAccessPoliciesRequestTypeDef#

# UpdateServiceAccessPoliciesRequestTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import UpdateServiceAccessPoliciesRequestTypeDef


def get_value() -> UpdateServiceAccessPoliciesRequestTypeDef:
    return {
        "DomainName": ...,
    }


# UpdateServiceAccessPoliciesRequestTypeDef definition

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

AccessPoliciesStatusTypeDef#

# AccessPoliciesStatusTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import AccessPoliciesStatusTypeDef


def get_value() -> AccessPoliciesStatusTypeDef:
    return {
        "Options": ...,
    }


# AccessPoliciesStatusTypeDef definition

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

AvailabilityOptionsStatusTypeDef#

# AvailabilityOptionsStatusTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import AvailabilityOptionsStatusTypeDef


def get_value() -> AvailabilityOptionsStatusTypeDef:
    return {
        "Options": ...,
    }


# AvailabilityOptionsStatusTypeDef definition

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

AnalysisSchemeTypeDef#

# AnalysisSchemeTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import AnalysisSchemeTypeDef


def get_value() -> AnalysisSchemeTypeDef:
    return {
        "AnalysisSchemeName": ...,
    }


# AnalysisSchemeTypeDef definition

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

BuildSuggestersResponseTypeDef#

# BuildSuggestersResponseTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import BuildSuggestersResponseTypeDef


def get_value() -> BuildSuggestersResponseTypeDef:
    return {
        "FieldNames": ...,
    }


# BuildSuggestersResponseTypeDef definition

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

IndexDocumentsResponseTypeDef#

# IndexDocumentsResponseTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import IndexDocumentsResponseTypeDef


def get_value() -> IndexDocumentsResponseTypeDef:
    return {
        "FieldNames": ...,
    }


# IndexDocumentsResponseTypeDef definition

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

ListDomainNamesResponseTypeDef#

# ListDomainNamesResponseTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import ListDomainNamesResponseTypeDef


def get_value() -> ListDomainNamesResponseTypeDef:
    return {
        "DomainNames": ...,
    }


# ListDomainNamesResponseTypeDef definition

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

DefineExpressionRequestTypeDef#

# DefineExpressionRequestTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DefineExpressionRequestTypeDef


def get_value() -> DefineExpressionRequestTypeDef:
    return {
        "DomainName": ...,
    }


# DefineExpressionRequestTypeDef definition

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

ExpressionStatusTypeDef#

# ExpressionStatusTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import ExpressionStatusTypeDef


def get_value() -> ExpressionStatusTypeDef:
    return {
        "Options": ...,
    }


# ExpressionStatusTypeDef definition

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

SuggesterTypeDef#

# SuggesterTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import SuggesterTypeDef


def get_value() -> SuggesterTypeDef:
    return {
        "SuggesterName": ...,
    }


# SuggesterTypeDef definition

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

DomainEndpointOptionsStatusTypeDef#

# DomainEndpointOptionsStatusTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DomainEndpointOptionsStatusTypeDef


def get_value() -> DomainEndpointOptionsStatusTypeDef:
    return {
        "Options": ...,
    }


# DomainEndpointOptionsStatusTypeDef definition

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

UpdateDomainEndpointOptionsRequestTypeDef#

# UpdateDomainEndpointOptionsRequestTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import UpdateDomainEndpointOptionsRequestTypeDef


def get_value() -> UpdateDomainEndpointOptionsRequestTypeDef:
    return {
        "DomainName": ...,
    }


# UpdateDomainEndpointOptionsRequestTypeDef definition

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

DomainStatusTypeDef#

# DomainStatusTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DomainStatusTypeDef


def get_value() -> DomainStatusTypeDef:
    return {
        "DomainId": ...,
    }


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

from types_boto3_cloudsearch.type_defs import IndexFieldTypeDef


def get_value() -> IndexFieldTypeDef:
    return {
        "IndexFieldName": ...,
    }


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

from types_boto3_cloudsearch.type_defs import ScalingParametersStatusTypeDef


def get_value() -> ScalingParametersStatusTypeDef:
    return {
        "Options": ...,
    }


# ScalingParametersStatusTypeDef definition

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

UpdateScalingParametersRequestTypeDef#

# UpdateScalingParametersRequestTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import UpdateScalingParametersRequestTypeDef


def get_value() -> UpdateScalingParametersRequestTypeDef:
    return {
        "DomainName": ...,
    }


# UpdateScalingParametersRequestTypeDef definition

class UpdateScalingParametersRequestTypeDef(TypedDict):
    DomainName: str,
    ScalingParameters: ScalingParametersTypeDef,  # (1)
  1. See ScalingParametersTypeDef

DescribeServiceAccessPoliciesResponseTypeDef#

# DescribeServiceAccessPoliciesResponseTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DescribeServiceAccessPoliciesResponseTypeDef


def get_value() -> DescribeServiceAccessPoliciesResponseTypeDef:
    return {
        "AccessPolicies": ...,
    }


# DescribeServiceAccessPoliciesResponseTypeDef definition

class DescribeServiceAccessPoliciesResponseTypeDef(TypedDict):
    AccessPolicies: AccessPoliciesStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AccessPoliciesStatusTypeDef
  2. See ResponseMetadataTypeDef

UpdateServiceAccessPoliciesResponseTypeDef#

# UpdateServiceAccessPoliciesResponseTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import UpdateServiceAccessPoliciesResponseTypeDef


def get_value() -> UpdateServiceAccessPoliciesResponseTypeDef:
    return {
        "AccessPolicies": ...,
    }


# UpdateServiceAccessPoliciesResponseTypeDef definition

class UpdateServiceAccessPoliciesResponseTypeDef(TypedDict):
    AccessPolicies: AccessPoliciesStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AccessPoliciesStatusTypeDef
  2. See ResponseMetadataTypeDef

DescribeAvailabilityOptionsResponseTypeDef#

# DescribeAvailabilityOptionsResponseTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DescribeAvailabilityOptionsResponseTypeDef


def get_value() -> DescribeAvailabilityOptionsResponseTypeDef:
    return {
        "AvailabilityOptions": ...,
    }


# DescribeAvailabilityOptionsResponseTypeDef definition

class DescribeAvailabilityOptionsResponseTypeDef(TypedDict):
    AvailabilityOptions: AvailabilityOptionsStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AvailabilityOptionsStatusTypeDef
  2. See ResponseMetadataTypeDef

UpdateAvailabilityOptionsResponseTypeDef#

# UpdateAvailabilityOptionsResponseTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import UpdateAvailabilityOptionsResponseTypeDef


def get_value() -> UpdateAvailabilityOptionsResponseTypeDef:
    return {
        "AvailabilityOptions": ...,
    }


# UpdateAvailabilityOptionsResponseTypeDef definition

class UpdateAvailabilityOptionsResponseTypeDef(TypedDict):
    AvailabilityOptions: AvailabilityOptionsStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AvailabilityOptionsStatusTypeDef
  2. See ResponseMetadataTypeDef

AnalysisSchemeStatusTypeDef#

# AnalysisSchemeStatusTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import AnalysisSchemeStatusTypeDef


def get_value() -> AnalysisSchemeStatusTypeDef:
    return {
        "Options": ...,
    }


# AnalysisSchemeStatusTypeDef definition

class AnalysisSchemeStatusTypeDef(TypedDict):
    Options: AnalysisSchemeTypeDef,  # (1)
    Status: OptionStatusTypeDef,  # (2)
  1. See AnalysisSchemeTypeDef
  2. See OptionStatusTypeDef

DefineAnalysisSchemeRequestTypeDef#

# DefineAnalysisSchemeRequestTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DefineAnalysisSchemeRequestTypeDef


def get_value() -> DefineAnalysisSchemeRequestTypeDef:
    return {
        "DomainName": ...,
    }


# DefineAnalysisSchemeRequestTypeDef definition

class DefineAnalysisSchemeRequestTypeDef(TypedDict):
    DomainName: str,
    AnalysisScheme: AnalysisSchemeTypeDef,  # (1)
  1. See AnalysisSchemeTypeDef

DefineExpressionResponseTypeDef#

# DefineExpressionResponseTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DefineExpressionResponseTypeDef


def get_value() -> DefineExpressionResponseTypeDef:
    return {
        "Expression": ...,
    }


# DefineExpressionResponseTypeDef definition

class DefineExpressionResponseTypeDef(TypedDict):
    Expression: ExpressionStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ExpressionStatusTypeDef
  2. See ResponseMetadataTypeDef

DeleteExpressionResponseTypeDef#

# DeleteExpressionResponseTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DeleteExpressionResponseTypeDef


def get_value() -> DeleteExpressionResponseTypeDef:
    return {
        "Expression": ...,
    }


# DeleteExpressionResponseTypeDef definition

class DeleteExpressionResponseTypeDef(TypedDict):
    Expression: ExpressionStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ExpressionStatusTypeDef
  2. See ResponseMetadataTypeDef

DescribeExpressionsResponseTypeDef#

# DescribeExpressionsResponseTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DescribeExpressionsResponseTypeDef


def get_value() -> DescribeExpressionsResponseTypeDef:
    return {
        "Expressions": ...,
    }


# DescribeExpressionsResponseTypeDef definition

class DescribeExpressionsResponseTypeDef(TypedDict):
    Expressions: List[ExpressionStatusTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See List[ExpressionStatusTypeDef]
  2. See ResponseMetadataTypeDef

DefineSuggesterRequestTypeDef#

# DefineSuggesterRequestTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DefineSuggesterRequestTypeDef


def get_value() -> DefineSuggesterRequestTypeDef:
    return {
        "DomainName": ...,
    }


# DefineSuggesterRequestTypeDef definition

class DefineSuggesterRequestTypeDef(TypedDict):
    DomainName: str,
    Suggester: SuggesterTypeDef,  # (1)
  1. See SuggesterTypeDef

SuggesterStatusTypeDef#

# SuggesterStatusTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import SuggesterStatusTypeDef


def get_value() -> SuggesterStatusTypeDef:
    return {
        "Options": ...,
    }


# SuggesterStatusTypeDef definition

class SuggesterStatusTypeDef(TypedDict):
    Options: SuggesterTypeDef,  # (1)
    Status: OptionStatusTypeDef,  # (2)
  1. See SuggesterTypeDef
  2. See OptionStatusTypeDef

DescribeDomainEndpointOptionsResponseTypeDef#

# DescribeDomainEndpointOptionsResponseTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DescribeDomainEndpointOptionsResponseTypeDef


def get_value() -> DescribeDomainEndpointOptionsResponseTypeDef:
    return {
        "DomainEndpointOptions": ...,
    }


# DescribeDomainEndpointOptionsResponseTypeDef definition

class DescribeDomainEndpointOptionsResponseTypeDef(TypedDict):
    DomainEndpointOptions: DomainEndpointOptionsStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainEndpointOptionsStatusTypeDef
  2. See ResponseMetadataTypeDef

UpdateDomainEndpointOptionsResponseTypeDef#

# UpdateDomainEndpointOptionsResponseTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import UpdateDomainEndpointOptionsResponseTypeDef


def get_value() -> UpdateDomainEndpointOptionsResponseTypeDef:
    return {
        "DomainEndpointOptions": ...,
    }


# UpdateDomainEndpointOptionsResponseTypeDef definition

class UpdateDomainEndpointOptionsResponseTypeDef(TypedDict):
    DomainEndpointOptions: DomainEndpointOptionsStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainEndpointOptionsStatusTypeDef
  2. See ResponseMetadataTypeDef

CreateDomainResponseTypeDef#

# CreateDomainResponseTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import CreateDomainResponseTypeDef


def get_value() -> CreateDomainResponseTypeDef:
    return {
        "DomainStatus": ...,
    }


# CreateDomainResponseTypeDef definition

class CreateDomainResponseTypeDef(TypedDict):
    DomainStatus: DomainStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainStatusTypeDef
  2. See ResponseMetadataTypeDef

DeleteDomainResponseTypeDef#

# DeleteDomainResponseTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DeleteDomainResponseTypeDef


def get_value() -> DeleteDomainResponseTypeDef:
    return {
        "DomainStatus": ...,
    }


# DeleteDomainResponseTypeDef definition

class DeleteDomainResponseTypeDef(TypedDict):
    DomainStatus: DomainStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainStatusTypeDef
  2. See ResponseMetadataTypeDef

DescribeDomainsResponseTypeDef#

# DescribeDomainsResponseTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DescribeDomainsResponseTypeDef


def get_value() -> DescribeDomainsResponseTypeDef:
    return {
        "DomainStatusList": ...,
    }


# DescribeDomainsResponseTypeDef definition

class DescribeDomainsResponseTypeDef(TypedDict):
    DomainStatusList: List[DomainStatusTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See List[DomainStatusTypeDef]
  2. See ResponseMetadataTypeDef

DefineIndexFieldRequestTypeDef#

# DefineIndexFieldRequestTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DefineIndexFieldRequestTypeDef


def get_value() -> DefineIndexFieldRequestTypeDef:
    return {
        "DomainName": ...,
    }


# DefineIndexFieldRequestTypeDef definition

class DefineIndexFieldRequestTypeDef(TypedDict):
    DomainName: str,
    IndexField: IndexFieldTypeDef,  # (1)
  1. See IndexFieldTypeDef

IndexFieldStatusTypeDef#

# IndexFieldStatusTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import IndexFieldStatusTypeDef


def get_value() -> IndexFieldStatusTypeDef:
    return {
        "Options": ...,
    }


# IndexFieldStatusTypeDef definition

class IndexFieldStatusTypeDef(TypedDict):
    Options: IndexFieldTypeDef,  # (1)
    Status: OptionStatusTypeDef,  # (2)
  1. See IndexFieldTypeDef
  2. See OptionStatusTypeDef

DescribeScalingParametersResponseTypeDef#

# DescribeScalingParametersResponseTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DescribeScalingParametersResponseTypeDef


def get_value() -> DescribeScalingParametersResponseTypeDef:
    return {
        "ScalingParameters": ...,
    }


# DescribeScalingParametersResponseTypeDef definition

class DescribeScalingParametersResponseTypeDef(TypedDict):
    ScalingParameters: ScalingParametersStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ScalingParametersStatusTypeDef
  2. See ResponseMetadataTypeDef

UpdateScalingParametersResponseTypeDef#

# UpdateScalingParametersResponseTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import UpdateScalingParametersResponseTypeDef


def get_value() -> UpdateScalingParametersResponseTypeDef:
    return {
        "ScalingParameters": ...,
    }


# UpdateScalingParametersResponseTypeDef definition

class UpdateScalingParametersResponseTypeDef(TypedDict):
    ScalingParameters: ScalingParametersStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ScalingParametersStatusTypeDef
  2. See ResponseMetadataTypeDef

DefineAnalysisSchemeResponseTypeDef#

# DefineAnalysisSchemeResponseTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DefineAnalysisSchemeResponseTypeDef


def get_value() -> DefineAnalysisSchemeResponseTypeDef:
    return {
        "AnalysisScheme": ...,
    }


# DefineAnalysisSchemeResponseTypeDef definition

class DefineAnalysisSchemeResponseTypeDef(TypedDict):
    AnalysisScheme: AnalysisSchemeStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AnalysisSchemeStatusTypeDef
  2. See ResponseMetadataTypeDef

DeleteAnalysisSchemeResponseTypeDef#

# DeleteAnalysisSchemeResponseTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DeleteAnalysisSchemeResponseTypeDef


def get_value() -> DeleteAnalysisSchemeResponseTypeDef:
    return {
        "AnalysisScheme": ...,
    }


# DeleteAnalysisSchemeResponseTypeDef definition

class DeleteAnalysisSchemeResponseTypeDef(TypedDict):
    AnalysisScheme: AnalysisSchemeStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AnalysisSchemeStatusTypeDef
  2. See ResponseMetadataTypeDef

DescribeAnalysisSchemesResponseTypeDef#

# DescribeAnalysisSchemesResponseTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DescribeAnalysisSchemesResponseTypeDef


def get_value() -> DescribeAnalysisSchemesResponseTypeDef:
    return {
        "AnalysisSchemes": ...,
    }


# DescribeAnalysisSchemesResponseTypeDef definition

class DescribeAnalysisSchemesResponseTypeDef(TypedDict):
    AnalysisSchemes: List[AnalysisSchemeStatusTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See List[AnalysisSchemeStatusTypeDef]
  2. See ResponseMetadataTypeDef

DefineSuggesterResponseTypeDef#

# DefineSuggesterResponseTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DefineSuggesterResponseTypeDef


def get_value() -> DefineSuggesterResponseTypeDef:
    return {
        "Suggester": ...,
    }


# DefineSuggesterResponseTypeDef definition

class DefineSuggesterResponseTypeDef(TypedDict):
    Suggester: SuggesterStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SuggesterStatusTypeDef
  2. See ResponseMetadataTypeDef

DeleteSuggesterResponseTypeDef#

# DeleteSuggesterResponseTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DeleteSuggesterResponseTypeDef


def get_value() -> DeleteSuggesterResponseTypeDef:
    return {
        "Suggester": ...,
    }


# DeleteSuggesterResponseTypeDef definition

class DeleteSuggesterResponseTypeDef(TypedDict):
    Suggester: SuggesterStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SuggesterStatusTypeDef
  2. See ResponseMetadataTypeDef

DescribeSuggestersResponseTypeDef#

# DescribeSuggestersResponseTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DescribeSuggestersResponseTypeDef


def get_value() -> DescribeSuggestersResponseTypeDef:
    return {
        "Suggesters": ...,
    }


# DescribeSuggestersResponseTypeDef definition

class DescribeSuggestersResponseTypeDef(TypedDict):
    Suggesters: List[SuggesterStatusTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See List[SuggesterStatusTypeDef]
  2. See ResponseMetadataTypeDef

DefineIndexFieldResponseTypeDef#

# DefineIndexFieldResponseTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DefineIndexFieldResponseTypeDef


def get_value() -> DefineIndexFieldResponseTypeDef:
    return {
        "IndexField": ...,
    }


# DefineIndexFieldResponseTypeDef definition

class DefineIndexFieldResponseTypeDef(TypedDict):
    IndexField: IndexFieldStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See IndexFieldStatusTypeDef
  2. See ResponseMetadataTypeDef

DeleteIndexFieldResponseTypeDef#

# DeleteIndexFieldResponseTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DeleteIndexFieldResponseTypeDef


def get_value() -> DeleteIndexFieldResponseTypeDef:
    return {
        "IndexField": ...,
    }


# DeleteIndexFieldResponseTypeDef definition

class DeleteIndexFieldResponseTypeDef(TypedDict):
    IndexField: IndexFieldStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See IndexFieldStatusTypeDef
  2. See ResponseMetadataTypeDef

DescribeIndexFieldsResponseTypeDef#

# DescribeIndexFieldsResponseTypeDef TypedDict usage example

from types_boto3_cloudsearch.type_defs import DescribeIndexFieldsResponseTypeDef


def get_value() -> DescribeIndexFieldsResponseTypeDef:
    return {
        "IndexFields": ...,
    }


# DescribeIndexFieldsResponseTypeDef definition

class DescribeIndexFieldsResponseTypeDef(TypedDict):
    IndexFields: List[IndexFieldStatusTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See List[IndexFieldStatusTypeDef]
  2. See ResponseMetadataTypeDef