Skip to content

Cloudsearch Classes

AccessPoliciesStatus

Options

  • Type:
  • Required: Yes

Status

  • Type:
  • Required: Yes

AnalysisOptions

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']]

AnalysisScheme

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:

AnalysisSchemeStatus

Options

  • Type:
  • Required: Yes

Status

  • Type:
  • Required: Yes

AvailabilityOptionsStatus

Options

  • Type:
  • Required: Yes

Status

  • Type:
  • Required: Yes

BaseValidatorModel

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

BuildSuggestersRequest

DomainName

  • Type:
  • Required: Yes

BuildSuggestersResponse

FieldNames

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

ResponseMetadata

  • Type:
  • Required: Yes

CreateDomainRequest

DomainName

  • Type:
  • Required: Yes

CreateDomainResponse

DomainStatus

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DateArrayOptions

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]

DateOptions

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]

DefineAnalysisSchemeRequest

DomainName

  • Type:
  • Required: Yes

AnalysisScheme

  • Type:
  • Required: Yes

DefineAnalysisSchemeResponse

AnalysisScheme

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DefineExpressionRequest

DomainName

  • Type:
  • Required: Yes

Expression

  • Type:
  • Required: Yes

DefineExpressionResponse

Expression

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DefineIndexFieldRequest

DomainName

  • Type:
  • Required: Yes

IndexField

  • Type:
  • Required: Yes

DefineIndexFieldResponse

IndexField

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DefineSuggesterRequest

DomainName

  • Type:
  • Required: Yes

Suggester

  • Type:
  • Required: Yes

DefineSuggesterResponse

Suggester

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteAnalysisSchemeRequest

DomainName

  • Type:
  • Required: Yes

AnalysisSchemeName

  • Type:
  • Required: Yes

DeleteAnalysisSchemeResponse

AnalysisScheme

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteDomainRequest

DomainName

  • Type:
  • Required: Yes

DeleteDomainResponse

DomainStatus

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteExpressionRequest

DomainName

  • Type:
  • Required: Yes

ExpressionName

  • Type:
  • Required: Yes

DeleteExpressionResponse

Expression

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteIndexFieldRequest

DomainName

  • Type:
  • Required: Yes

IndexFieldName

  • Type:
  • Required: Yes

DeleteIndexFieldResponse

IndexField

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteSuggesterRequest

DomainName

  • Type:
  • Required: Yes

SuggesterName

  • Type:
  • Required: Yes

DeleteSuggesterResponse

Suggester

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeAnalysisSchemesRequest

DomainName

  • Type:
  • Required: Yes

AnalysisSchemeNames

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

Deployed

  • Type: typing.Optional[bool]

DescribeAnalysisSchemesResponse

AnalysisSchemes

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

ResponseMetadata

  • Type:
  • Required: Yes

DescribeAvailabilityOptionsRequest

DomainName

  • Type:
  • Required: Yes

Deployed

  • Type: typing.Optional[bool]

DescribeAvailabilityOptionsResponse

AvailabilityOptions

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeDomainEndpointOptionsRequest

DomainName

  • Type:
  • Required: Yes

Deployed

  • Type: typing.Optional[bool]

DescribeDomainEndpointOptionsResponse

DomainEndpointOptions

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeDomainsRequest

DomainNames

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

DescribeDomainsResponse

DomainStatusList

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

ResponseMetadata

  • Type:
  • Required: Yes

DescribeExpressionsRequest

DomainName

  • Type:
  • Required: Yes

ExpressionNames

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

Deployed

  • Type: typing.Optional[bool]

DescribeExpressionsResponse

Expressions

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

ResponseMetadata

  • Type:
  • Required: Yes

DescribeIndexFieldsRequest

DomainName

  • Type:
  • Required: Yes

FieldNames

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

Deployed

  • Type: typing.Optional[bool]

DescribeIndexFieldsResponse

IndexFields

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

ResponseMetadata

  • Type:
  • Required: Yes

DescribeScalingParametersRequest

DomainName

  • Type:
  • Required: Yes

DescribeScalingParametersResponse

ScalingParameters

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeServiceAccessPoliciesRequest

DomainName

  • Type:
  • Required: Yes

Deployed

  • Type: typing.Optional[bool]

DescribeServiceAccessPoliciesResponse

AccessPolicies

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeSuggestersRequest

DomainName

  • Type:
  • Required: Yes

SuggesterNames

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

Deployed

  • Type: typing.Optional[bool]

DescribeSuggestersResponse

Suggesters

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

ResponseMetadata

  • Type:
  • Required: Yes

DocumentSuggesterOptions

SourceField

  • Type:
  • Required: Yes

FuzzyMatching

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

SortExpression

  • Type: typing.Optional[str]

DomainEndpointOptions

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']]

DomainEndpointOptionsStatus

Options

  • Type:
  • Required: Yes

Status

  • Type:
  • Required: Yes

DomainStatus

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.cloudsearch_classes.ServiceEndpoint]

SearchService

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cloudsearch.cloudsearch_classes.ServiceEndpoint]

Processing

  • Type: typing.Optional[bool]

SearchInstanceType

  • Type: typing.Optional[str]

SearchPartitionCount

  • Type: typing.Optional[int]

SearchInstanceCount

  • Type: typing.Optional[int]

Limits

  • Type:

DoubleArrayOptions

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]

DoubleOptions

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]

Expression

ExpressionName

  • Type:
  • Required: Yes

ExpressionValue

  • Type:
  • Required: Yes

ExpressionStatus

Options

  • Type:
  • Required: Yes

Status

  • Type:
  • Required: Yes

IndexDocumentsRequest

DomainName

  • Type:
  • Required: Yes

IndexDocumentsResponse

FieldNames

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

ResponseMetadata

  • Type:
  • Required: Yes

IndexField

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:

DoubleOptions

  • Type:

LiteralOptions

  • Type:

TextOptions

  • Type:

DateOptions

  • Type:

LatLonOptions

  • Type:

IntArrayOptions

  • Type:

DoubleArrayOptions

  • Type:

LiteralArrayOptions

  • Type:

TextArrayOptions

  • Type:

DateArrayOptions

  • Type:

IndexFieldStatus

Options

  • Type:
  • Required: Yes

Status

  • Type:
  • Required: Yes

IntArrayOptions

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]

IntOptions

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]

LatLonOptions

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]

Limits

MaximumReplicationCount

  • Type:
  • Required: Yes

MaximumPartitionCount

  • Type:
  • Required: Yes

ListDomainNamesResponse

DomainNames

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

ResponseMetadata

  • Type:
  • Required: Yes

LiteralArrayOptions

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]

LiteralOptions

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]

OptionStatus

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]

ResponseMetadata

RequestId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

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

RetryAttempts

  • Type:
  • Required: Yes

HostId

  • Type: typing.Optional[str]

ScalingParameters

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]

ScalingParametersStatus

Options

  • Type:
  • Required: Yes

Status

  • Type:
  • Required: Yes

ServiceEndpoint

Endpoint

  • Type: typing.Optional[str]

Suggester

SuggesterName

  • Type:
  • Required: Yes

DocumentSuggesterOptions

  • Type:
  • Required: Yes

SuggesterStatus

Options

  • Type:
  • Required: Yes

Status

  • Type:
  • Required: Yes

TextArrayOptions

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]

TextOptions

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]

UpdateAvailabilityOptionsRequest

DomainName

  • Type:
  • Required: Yes

MultiAZ

  • Type:
  • Required: Yes

UpdateAvailabilityOptionsResponse

AvailabilityOptions

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateDomainEndpointOptionsRequest

DomainName

  • Type:
  • Required: Yes

DomainEndpointOptions

  • Type:
  • Required: Yes

UpdateDomainEndpointOptionsResponse

DomainEndpointOptions

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateScalingParametersRequest

DomainName

  • Type:
  • Required: Yes

ScalingParameters

  • Type:
  • Required: Yes

UpdateScalingParametersResponse

ScalingParameters

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateServiceAccessPoliciesRequest

DomainName

  • Type:
  • Required: Yes

AccessPolicies

  • Type:
  • Required: Yes

UpdateServiceAccessPoliciesResponse

AccessPolicies

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes