Skip to content

Cloudsearch Classes

AccessPoliciesStatusTypeDef

Options

  • Type:
  • Required: Yes

Status

  • Type:
  • Required: Yes

AnalysisOptionsTypeDef

Synonyms

  • Type: typing.Optional[str]

Stopwords

  • Type: typing.Optional[str]

StemmingDictionary

  • Type: typing.Optional[str]

JapaneseTokenizationDictionary

  • Type: typing.Optional[str]

AlgorithmicStemming

  • Type: typing.Optional[typing.Literal['full', 'light', 'minimal', 'none']]

AnalysisSchemeStatusTypeDef

Options

  • Type:
  • Required: Yes

Status

  • Type:
  • Required: Yes

AnalysisSchemeTypeDef

AnalysisSchemeName

  • Type:
  • Required: Yes

AnalysisSchemeLanguage

  • Type: typing.Literal['ar', 'bg', 'ca', 'cs', 'da', 'de', 'el', 'en', 'es', 'eu', 'fa', 'fi', 'fr', 'ga', 'gl', 'he', 'hi', 'hu', 'hy', 'id', 'it', 'ja', 'ko', 'lv', 'mul', 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'th', 'tr', 'zh-Hans', 'zh-Hant']
  • Required: Yes

AnalysisOptions

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cloudsearch_classes.AnalysisOptionsTypeDef]

AvailabilityOptionsStatusTypeDef

Options

  • Type:
  • Required: Yes

Status

  • Type:
  • Required: Yes

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

BuildSuggestersRequestRequestTypeDef

DomainName

  • Type:
  • Required: Yes

BuildSuggestersResponseTypeDef

FieldNames

  • Type: typing.List[str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateDomainRequestRequestTypeDef

DomainName

  • Type:
  • Required: Yes

CreateDomainResponseTypeDef

DomainStatus

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DateArrayOptionsTypeDef

DefaultValue

  • Type: typing.Optional[str]

SourceFields

  • Type: typing.Optional[str]

FacetEnabled

  • Type: typing.Optional[bool]

SearchEnabled

  • Type: typing.Optional[bool]

ReturnEnabled

  • Type: typing.Optional[bool]

DateOptionsTypeDef

DefaultValue

  • Type: typing.Optional[str]

SourceField

  • Type: typing.Optional[str]

FacetEnabled

  • Type: typing.Optional[bool]

SearchEnabled

  • Type: typing.Optional[bool]

ReturnEnabled

  • Type: typing.Optional[bool]

SortEnabled

  • Type: typing.Optional[bool]

DefineAnalysisSchemeRequestRequestTypeDef

DomainName

  • Type:
  • Required: Yes

AnalysisScheme

  • Type:
  • Required: Yes

DefineAnalysisSchemeResponseTypeDef

AnalysisScheme

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DefineExpressionRequestRequestTypeDef

DomainName

  • Type:
  • Required: Yes

Expression

  • Type:
  • Required: Yes

DefineExpressionResponseTypeDef

Expression

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DefineIndexFieldRequestRequestTypeDef

DomainName

  • Type:
  • Required: Yes

IndexField

  • Type:
  • Required: Yes

DefineIndexFieldResponseTypeDef

IndexField

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DefineSuggesterRequestRequestTypeDef

DomainName

  • Type:
  • Required: Yes

Suggester

  • Type:
  • Required: Yes

DefineSuggesterResponseTypeDef

Suggester

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteAnalysisSchemeRequestRequestTypeDef

DomainName

  • Type:
  • Required: Yes

AnalysisSchemeName

  • Type:
  • Required: Yes

DeleteAnalysisSchemeResponseTypeDef

AnalysisScheme

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteDomainRequestRequestTypeDef

DomainName

  • Type:
  • Required: Yes

DeleteDomainResponseTypeDef

DomainStatus

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteExpressionRequestRequestTypeDef

DomainName

  • Type:
  • Required: Yes

ExpressionName

  • Type:
  • Required: Yes

DeleteExpressionResponseTypeDef

Expression

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteIndexFieldRequestRequestTypeDef

DomainName

  • Type:
  • Required: Yes

IndexFieldName

  • Type:
  • Required: Yes

DeleteIndexFieldResponseTypeDef

IndexField

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteSuggesterRequestRequestTypeDef

DomainName

  • Type:
  • Required: Yes

SuggesterName

  • Type:
  • Required: Yes

DeleteSuggesterResponseTypeDef

Suggester

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeAnalysisSchemesRequestRequestTypeDef

DomainName

  • Type:
  • Required: Yes

AnalysisSchemeNames

  • Type: typing.Optional[typing.Sequence[str]]

Deployed

  • Type: typing.Optional[bool]

DescribeAnalysisSchemesResponseTypeDef

AnalysisSchemes

  • Type: typing.List[aws_resource_validator.pydantic_models.cloudsearch_classes.AnalysisSchemeStatusTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeAvailabilityOptionsRequestRequestTypeDef

DomainName

  • Type:
  • Required: Yes

Deployed

  • Type: typing.Optional[bool]

DescribeAvailabilityOptionsResponseTypeDef

AvailabilityOptions

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeDomainEndpointOptionsRequestRequestTypeDef

DomainName

  • Type:
  • Required: Yes

Deployed

  • Type: typing.Optional[bool]

DescribeDomainEndpointOptionsResponseTypeDef

DomainEndpointOptions

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeDomainsRequestRequestTypeDef

DomainNames

  • Type: typing.Optional[typing.Sequence[str]]

DescribeDomainsResponseTypeDef

DomainStatusList

  • Type: typing.List[aws_resource_validator.pydantic_models.cloudsearch_classes.DomainStatusTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeExpressionsRequestRequestTypeDef

DomainName

  • Type:
  • Required: Yes

ExpressionNames

  • Type: typing.Optional[typing.Sequence[str]]

Deployed

  • Type: typing.Optional[bool]

DescribeExpressionsResponseTypeDef

Expressions

  • Type: typing.List[aws_resource_validator.pydantic_models.cloudsearch_classes.ExpressionStatusTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeIndexFieldsRequestRequestTypeDef

DomainName

  • Type:
  • Required: Yes

FieldNames

  • Type: typing.Optional[typing.Sequence[str]]

Deployed

  • Type: typing.Optional[bool]

DescribeIndexFieldsResponseTypeDef

IndexFields

  • Type: typing.List[aws_resource_validator.pydantic_models.cloudsearch_classes.IndexFieldStatusTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeScalingParametersRequestRequestTypeDef

DomainName

  • Type:
  • Required: Yes

DescribeScalingParametersResponseTypeDef

ScalingParameters

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeServiceAccessPoliciesRequestRequestTypeDef

DomainName

  • Type:
  • Required: Yes

Deployed

  • Type: typing.Optional[bool]

DescribeServiceAccessPoliciesResponseTypeDef

AccessPolicies

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeSuggestersRequestRequestTypeDef

DomainName

  • Type:
  • Required: Yes

SuggesterNames

  • Type: typing.Optional[typing.Sequence[str]]

Deployed

  • Type: typing.Optional[bool]

DescribeSuggestersResponseTypeDef

Suggesters

  • Type: typing.List[aws_resource_validator.pydantic_models.cloudsearch_classes.SuggesterStatusTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DocumentSuggesterOptionsTypeDef

SourceField

  • Type:
  • Required: Yes

FuzzyMatching

  • Type: typing.Optional[typing.Literal['high', 'low', 'none']]

SortExpression

  • Type: typing.Optional[str]

DomainEndpointOptionsStatusTypeDef

Options

  • Type:
  • Required: Yes

Status

  • Type:
  • Required: Yes

DomainEndpointOptionsTypeDef

EnforceHTTPS

  • Type: typing.Optional[bool]

TLSSecurityPolicy

  • Type: typing.Optional[typing.Literal['Policy-Min-TLS-1-0-2019-07', 'Policy-Min-TLS-1-2-2019-07']]

DomainStatusTypeDef

DomainId

  • Type:
  • Required: Yes

DomainName

  • Type:
  • Required: Yes

RequiresIndexDocuments

  • Type:
  • Required: Yes

ARN

  • Type: typing.Optional[str]

Created

  • Type: typing.Optional[bool]

Deleted

  • Type: typing.Optional[bool]

DocService

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cloudsearch_classes.ServiceEndpointTypeDef]

SearchService

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cloudsearch_classes.ServiceEndpointTypeDef]

Processing

  • Type: typing.Optional[bool]

SearchInstanceType

  • Type: typing.Optional[str]

SearchPartitionCount

  • Type: typing.Optional[int]

SearchInstanceCount

  • Type: typing.Optional[int]

Limits

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cloudsearch_classes.LimitsTypeDef]

DoubleArrayOptionsTypeDef

DefaultValue

  • Type: typing.Optional[float]

SourceFields

  • Type: typing.Optional[str]

FacetEnabled

  • Type: typing.Optional[bool]

SearchEnabled

  • Type: typing.Optional[bool]

ReturnEnabled

  • Type: typing.Optional[bool]

DoubleOptionsTypeDef

DefaultValue

  • Type: typing.Optional[float]

SourceField

  • Type: typing.Optional[str]

FacetEnabled

  • Type: typing.Optional[bool]

SearchEnabled

  • Type: typing.Optional[bool]

ReturnEnabled

  • Type: typing.Optional[bool]

SortEnabled

  • Type: typing.Optional[bool]

ExpressionStatusTypeDef

Options

  • Type:
  • Required: Yes

Status

  • Type:
  • Required: Yes

ExpressionTypeDef

ExpressionName

  • Type:
  • Required: Yes

ExpressionValue

  • Type:
  • Required: Yes

IndexDocumentsRequestRequestTypeDef

DomainName

  • Type:
  • Required: Yes

IndexDocumentsResponseTypeDef

FieldNames

  • Type: typing.List[str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

IndexFieldStatusTypeDef

Options

  • Type:
  • Required: Yes

Status

  • Type:
  • Required: Yes

IndexFieldTypeDef

IndexFieldName

  • Type:
  • Required: Yes

IndexFieldType

  • Type: typing.Literal['date', 'date-array', 'double', 'double-array', 'int', 'int-array', 'latlon', 'literal', 'literal-array', 'text', 'text-array']
  • Required: Yes

IntOptions

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cloudsearch_classes.IntOptionsTypeDef]

DoubleOptions

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cloudsearch_classes.DoubleOptionsTypeDef]

LiteralOptions

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cloudsearch_classes.LiteralOptionsTypeDef]

TextOptions

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cloudsearch_classes.TextOptionsTypeDef]

DateOptions

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cloudsearch_classes.DateOptionsTypeDef]

LatLonOptions

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cloudsearch_classes.LatLonOptionsTypeDef]

IntArrayOptions

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cloudsearch_classes.IntArrayOptionsTypeDef]

DoubleArrayOptions

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cloudsearch_classes.DoubleArrayOptionsTypeDef]

LiteralArrayOptions

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cloudsearch_classes.LiteralArrayOptionsTypeDef]

TextArrayOptions

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cloudsearch_classes.TextArrayOptionsTypeDef]

DateArrayOptions

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cloudsearch_classes.DateArrayOptionsTypeDef]

IntArrayOptionsTypeDef

DefaultValue

  • Type: typing.Optional[int]

SourceFields

  • Type: typing.Optional[str]

FacetEnabled

  • Type: typing.Optional[bool]

SearchEnabled

  • Type: typing.Optional[bool]

ReturnEnabled

  • Type: typing.Optional[bool]

IntOptionsTypeDef

DefaultValue

  • Type: typing.Optional[int]

SourceField

  • Type: typing.Optional[str]

FacetEnabled

  • Type: typing.Optional[bool]

SearchEnabled

  • Type: typing.Optional[bool]

ReturnEnabled

  • Type: typing.Optional[bool]

SortEnabled

  • Type: typing.Optional[bool]

LatLonOptionsTypeDef

DefaultValue

  • Type: typing.Optional[str]

SourceField

  • Type: typing.Optional[str]

FacetEnabled

  • Type: typing.Optional[bool]

SearchEnabled

  • Type: typing.Optional[bool]

ReturnEnabled

  • Type: typing.Optional[bool]

SortEnabled

  • Type: typing.Optional[bool]

LimitsTypeDef

MaximumReplicationCount

  • Type:
  • Required: Yes

MaximumPartitionCount

  • Type:
  • Required: Yes

ListDomainNamesResponseTypeDef

DomainNames

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

LiteralArrayOptionsTypeDef

DefaultValue

  • Type: typing.Optional[str]

SourceFields

  • Type: typing.Optional[str]

FacetEnabled

  • Type: typing.Optional[bool]

SearchEnabled

  • Type: typing.Optional[bool]

ReturnEnabled

  • Type: typing.Optional[bool]

LiteralOptionsTypeDef

DefaultValue

  • Type: typing.Optional[str]

SourceField

  • Type: typing.Optional[str]

FacetEnabled

  • Type: typing.Optional[bool]

SearchEnabled

  • Type: typing.Optional[bool]

ReturnEnabled

  • Type: typing.Optional[bool]

SortEnabled

  • Type: typing.Optional[bool]

OptionStatusTypeDef

CreationDate

  • Type:
  • Required: Yes

UpdateDate

  • Type:
  • Required: Yes

State

  • Type: typing.Literal['Active', 'FailedToValidate', 'Processing', 'RequiresIndexDocuments']
  • Required: Yes

UpdateVersion

  • Type: typing.Optional[int]

PendingDeletion

  • Type: typing.Optional[bool]

ResponseMetadataTypeDef

RequestId

  • Type:
  • Required: Yes

HostId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

ScalingParametersStatusTypeDef

Options

  • Type:
  • Required: Yes

Status

  • Type:
  • Required: Yes

ScalingParametersTypeDef

DesiredInstanceType

  • Type: typing.Optional[typing.Literal['search.2xlarge', 'search.large', 'search.m1.large', 'search.m1.small', 'search.m2.2xlarge', 'search.m2.xlarge', 'search.m3.2xlarge', 'search.m3.large', 'search.m3.medium', 'search.m3.xlarge', 'search.medium', 'search.previousgeneration.2xlarge', 'search.previousgeneration.large', 'search.previousgeneration.small', 'search.previousgeneration.xlarge', 'search.small', 'search.xlarge']]

DesiredReplicationCount

  • Type: typing.Optional[int]

DesiredPartitionCount

  • Type: typing.Optional[int]

ServiceEndpointTypeDef

Endpoint

  • Type: typing.Optional[str]

SuggesterStatusTypeDef

Options

  • Type:
  • Required: Yes

Status

  • Type:
  • Required: Yes

SuggesterTypeDef

SuggesterName

  • Type:
  • Required: Yes

DocumentSuggesterOptions

  • Type:
  • Required: Yes

TextArrayOptionsTypeDef

DefaultValue

  • Type: typing.Optional[str]

SourceFields

  • Type: typing.Optional[str]

ReturnEnabled

  • Type: typing.Optional[bool]

HighlightEnabled

  • Type: typing.Optional[bool]

AnalysisScheme

  • Type: typing.Optional[str]

TextOptionsTypeDef

DefaultValue

  • Type: typing.Optional[str]

SourceField

  • Type: typing.Optional[str]

ReturnEnabled

  • Type: typing.Optional[bool]

SortEnabled

  • Type: typing.Optional[bool]

HighlightEnabled

  • Type: typing.Optional[bool]

AnalysisScheme

  • Type: typing.Optional[str]

UpdateAvailabilityOptionsRequestRequestTypeDef

DomainName

  • Type:
  • Required: Yes

MultiAZ

  • Type:
  • Required: Yes

UpdateAvailabilityOptionsResponseTypeDef

AvailabilityOptions

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateDomainEndpointOptionsRequestRequestTypeDef

DomainName

  • Type:
  • Required: Yes

DomainEndpointOptions

  • Type:
  • Required: Yes

UpdateDomainEndpointOptionsResponseTypeDef

DomainEndpointOptions

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateScalingParametersRequestRequestTypeDef

DomainName

  • Type:
  • Required: Yes

ScalingParameters

  • Type:
  • Required: Yes

UpdateScalingParametersResponseTypeDef

ScalingParameters

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateServiceAccessPoliciesRequestRequestTypeDef

DomainName

  • Type:
  • Required: Yes

AccessPolicies

  • Type:
  • Required: Yes

UpdateServiceAccessPoliciesResponseTypeDef

AccessPolicies

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes