libZSservicesZSamazonka-cloudsearchZSamazonka-cloudsearch
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CloudSearch.Lens

Description

 
Synopsis

Operations

DescribeAvailabilityOptions

describeAvailabilityOptions_deployed :: Lens' DescribeAvailabilityOptions (Maybe Bool) Source #

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

describeAvailabilityOptionsResponse_availabilityOptions :: Lens' DescribeAvailabilityOptionsResponse (Maybe AvailabilityOptionsStatus) Source #

The availability options configured for the domain. Indicates whether Multi-AZ is enabled for the domain.

DescribeExpressions

describeExpressions_deployed :: Lens' DescribeExpressions (Maybe Bool) Source #

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

describeExpressions_expressionNames :: Lens' DescribeExpressions (Maybe [Text]) Source #

Limits the DescribeExpressions response to the specified expressions. If not specified, all expressions are shown.

describeExpressions_domainName :: Lens' DescribeExpressions Text Source #

The name of the domain you want to describe.

DefineExpression

DescribeScalingParameters

DescribeServiceAccessPolicies

describeServiceAccessPolicies_deployed :: Lens' DescribeServiceAccessPolicies (Maybe Bool) Source #

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

DescribeSuggesters

describeSuggesters_deployed :: Lens' DescribeSuggesters (Maybe Bool) Source #

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

describeSuggesters_suggesterNames :: Lens' DescribeSuggesters (Maybe [Text]) Source #

The suggesters you want to describe.

describeSuggesters_domainName :: Lens' DescribeSuggesters Text Source #

The name of the domain you want to describe.

describeSuggestersResponse_suggesters :: Lens' DescribeSuggestersResponse [SuggesterStatus] Source #

The suggesters configured for the domain specified in the request.

UpdateAvailabilityOptions

updateAvailabilityOptions_multiAZ :: Lens' UpdateAvailabilityOptions Bool Source #

You expand an existing search domain to a second Availability Zone by setting the Multi-AZ option to true. Similarly, you can turn off the Multi-AZ option to downgrade the domain to a single Availability Zone by setting the Multi-AZ option to false.

updateAvailabilityOptionsResponse_availabilityOptions :: Lens' UpdateAvailabilityOptionsResponse (Maybe AvailabilityOptionsStatus) Source #

The newly-configured availability options. Indicates whether Multi-AZ is enabled for the domain.

DeleteExpression

deleteExpression_expressionName :: Lens' DeleteExpression Text Source #

The name of the Expression to delete.

ListDomainNames

listDomainNamesResponse_domainNames :: Lens' ListDomainNamesResponse (Maybe (HashMap Text Text)) Source #

The names of the search domains owned by an account.

DefineSuggester

DescribeDomains

describeDomains_domainNames :: Lens' DescribeDomains (Maybe [Text]) Source #

The names of the domains you want to include in the response.

DeleteAnalysisScheme

deleteAnalysisScheme_analysisSchemeName :: Lens' DeleteAnalysisScheme Text Source #

The name of the analysis scheme you want to delete.

DescribeDomainEndpointOptions

describeDomainEndpointOptions_deployed :: Lens' DescribeDomainEndpointOptions (Maybe Bool) Source #

Whether to retrieve the latest configuration (which might be in a Processing state) or the current, active configuration. Defaults to false.

DescribeAnalysisSchemes

describeAnalysisSchemes_deployed :: Lens' DescribeAnalysisSchemes (Maybe Bool) Source #

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

describeAnalysisSchemes_domainName :: Lens' DescribeAnalysisSchemes Text Source #

The name of the domain you want to describe.

CreateDomain

createDomain_domainName :: Lens' CreateDomain Text Source #

A name for the domain you are creating. Allowed characters are a-z (lower-case letters), 0-9, and hyphen (-). Domain names must start with a letter or number and be at least 3 and no more than 28 characters long.

UpdateDomainEndpointOptions

updateDomainEndpointOptions_domainName :: Lens' UpdateDomainEndpointOptions Text Source #

A string that represents the name of a domain.

updateDomainEndpointOptions_domainEndpointOptions :: Lens' UpdateDomainEndpointOptions DomainEndpointOptions Source #

Whether to require that all requests to the domain arrive over HTTPS. We recommend Policy-Min-TLS-1-2-2019-07 for TLSSecurityPolicy. For compatibility with older clients, the default is Policy-Min-TLS-1-0-2019-07.

DescribeIndexFields

describeIndexFields_deployed :: Lens' DescribeIndexFields (Maybe Bool) Source #

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

describeIndexFields_fieldNames :: Lens' DescribeIndexFields (Maybe [Text]) Source #

A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.

describeIndexFields_domainName :: Lens' DescribeIndexFields Text Source #

The name of the domain you want to describe.

DeleteSuggester

deleteSuggester_suggesterName :: Lens' DeleteSuggester Text Source #

Specifies the name of the suggester you want to delete.

DefineAnalysisScheme

IndexDocuments

indexDocumentsResponse_fieldNames :: Lens' IndexDocumentsResponse (Maybe [Text]) Source #

The names of the fields that are currently being indexed.

DeleteIndexField

deleteIndexField_indexFieldName :: Lens' DeleteIndexField Text Source #

The name of the index field your want to remove from the domain's indexing options.

UpdateServiceAccessPolicies

updateServiceAccessPolicies_accessPolicies :: Lens' UpdateServiceAccessPolicies Text Source #

The access rules you want to configure. These rules replace any existing rules.

UpdateScalingParameters

BuildSuggesters

DeleteDomain

deleteDomain_domainName :: Lens' DeleteDomain Text Source #

The name of the domain you want to permanently delete.

DefineIndexField

defineIndexField_indexField :: Lens' DefineIndexField IndexField Source #

The index field and field options you want to configure.

Types

AccessPoliciesStatus

AnalysisOptions

analysisOptions_algorithmicStemming :: Lens' AnalysisOptions (Maybe AlgorithmicStemming) Source #

The level of algorithmic stemming to perform: none, minimal, light, or full. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide

analysisOptions_stopwords :: Lens' AnalysisOptions (Maybe Text) Source #

A JSON array of terms to ignore during indexing and searching. For example, ["a", "an", "the", "of"]. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported.

analysisOptions_japaneseTokenizationDictionary :: Lens' AnalysisOptions (Maybe Text) Source #

A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton. The Japanese tokenization dictionary enables you to override the default tokenization for selected terms. This is only valid for Japanese language fields.

analysisOptions_synonyms :: Lens' AnalysisOptions (Maybe Text) Source #

A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see Synonyms in the Amazon CloudSearch Developer Guide.

analysisOptions_stemmingDictionary :: Lens' AnalysisOptions (Maybe Text) Source #

A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, {"term1": "stem1", "term2": "stem2", "term3": "stem3"}. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.

AnalysisScheme

AnalysisSchemeStatus

AvailabilityOptionsStatus

availabilityOptionsStatus_options :: Lens' AvailabilityOptionsStatus Bool Source #

The availability options configured for the domain.

DateArrayOptions

dateArrayOptions_sourceFields :: Lens' DateArrayOptions (Maybe Text) Source #

A list of source fields to map to the field.

dateArrayOptions_returnEnabled :: Lens' DateArrayOptions (Maybe Bool) Source #

Whether the contents of the field can be returned in the search results.

dateArrayOptions_facetEnabled :: Lens' DateArrayOptions (Maybe Bool) Source #

Whether facet information can be returned for the field.

dateArrayOptions_searchEnabled :: Lens' DateArrayOptions (Maybe Bool) Source #

Whether the contents of the field are searchable.

dateArrayOptions_defaultValue :: Lens' DateArrayOptions (Maybe Text) Source #

A value to use for the field if the field isn't specified for a document.

DateOptions

dateOptions_returnEnabled :: Lens' DateOptions (Maybe Bool) Source #

Whether the contents of the field can be returned in the search results.

dateOptions_facetEnabled :: Lens' DateOptions (Maybe Bool) Source #

Whether facet information can be returned for the field.

dateOptions_searchEnabled :: Lens' DateOptions (Maybe Bool) Source #

Whether the contents of the field are searchable.

dateOptions_sortEnabled :: Lens' DateOptions (Maybe Bool) Source #

Whether the field can be used to sort the search results.

dateOptions_defaultValue :: Lens' DateOptions (Maybe Text) Source #

A value to use for the field if the field isn't specified for a document.

DocumentSuggesterOptions

documentSuggesterOptions_sortExpression :: Lens' DocumentSuggesterOptions (Maybe Text) Source #

An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the _score value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.

documentSuggesterOptions_fuzzyMatching :: Lens' DocumentSuggesterOptions (Maybe SuggesterFuzzyMatching) Source #

The level of fuzziness allowed when suggesting matches for a string: none, low, or high. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.

documentSuggesterOptions_sourceField :: Lens' DocumentSuggesterOptions Text Source #

The name of the index field you want to use for suggestions.

DomainEndpointOptions

domainEndpointOptions_enforceHTTPS :: Lens' DomainEndpointOptions (Maybe Bool) Source #

Whether the domain is HTTPS only enabled.

DomainEndpointOptionsStatus

domainEndpointOptionsStatus_status :: Lens' DomainEndpointOptionsStatus OptionStatus Source #

The status of the configured domain endpoint options.

DomainStatus

domainStatus_searchInstanceCount :: Lens' DomainStatus (Maybe Natural) Source #

The number of search instances that are available to process search requests.

domainStatus_searchInstanceType :: Lens' DomainStatus (Maybe Text) Source #

The instance type that is being used to process search requests.

domainStatus_docService :: Lens' DomainStatus (Maybe ServiceEndpoint) Source #

The service endpoint for updating documents in a search domain.

domainStatus_created :: Lens' DomainStatus (Maybe Bool) Source #

True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain is called. Newly created search domains are returned from DescribeDomains with a false value for Created until domain creation is complete.

domainStatus_searchService :: Lens' DomainStatus (Maybe ServiceEndpoint) Source #

The service endpoint for requesting search results from a search domain.

domainStatus_searchPartitionCount :: Lens' DomainStatus (Maybe Natural) Source #

The number of partitions across which the search index is spread.

domainStatus_deleted :: Lens' DomainStatus (Maybe Bool) Source #

True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when DeleteDomain is called. Newly deleted search domains are returned from DescribeDomains with a true value for IsDeleted for several minutes until resource cleanup is complete.

domainStatus_processing :: Lens' DomainStatus (Maybe Bool) Source #

True if processing is being done to activate the current domain configuration.

domainStatus_requiresIndexDocuments :: Lens' DomainStatus Bool Source #

True if IndexDocuments needs to be called to activate the current domain configuration.

DoubleArrayOptions

doubleArrayOptions_sourceFields :: Lens' DoubleArrayOptions (Maybe Text) Source #

A list of source fields to map to the field.

doubleArrayOptions_returnEnabled :: Lens' DoubleArrayOptions (Maybe Bool) Source #

Whether the contents of the field can be returned in the search results.

doubleArrayOptions_facetEnabled :: Lens' DoubleArrayOptions (Maybe Bool) Source #

Whether facet information can be returned for the field.

doubleArrayOptions_searchEnabled :: Lens' DoubleArrayOptions (Maybe Bool) Source #

Whether the contents of the field are searchable.

doubleArrayOptions_defaultValue :: Lens' DoubleArrayOptions (Maybe Double) Source #

A value to use for the field if the field isn't specified for a document.

DoubleOptions

doubleOptions_sourceField :: Lens' DoubleOptions (Maybe Text) Source #

The name of the source field to map to the field.

doubleOptions_returnEnabled :: Lens' DoubleOptions (Maybe Bool) Source #

Whether the contents of the field can be returned in the search results.

doubleOptions_facetEnabled :: Lens' DoubleOptions (Maybe Bool) Source #

Whether facet information can be returned for the field.

doubleOptions_searchEnabled :: Lens' DoubleOptions (Maybe Bool) Source #

Whether the contents of the field are searchable.

doubleOptions_sortEnabled :: Lens' DoubleOptions (Maybe Bool) Source #

Whether the field can be used to sort the search results.

doubleOptions_defaultValue :: Lens' DoubleOptions (Maybe Double) Source #

A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.

Expression

ExpressionStatus

expressionStatus_options :: Lens' ExpressionStatus Expression Source #

The expression that is evaluated for sorting while processing a search request.

IndexField

indexField_indexFieldName :: Lens' IndexField Text Source #

A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

IndexFieldStatus

IntArrayOptions

intArrayOptions_sourceFields :: Lens' IntArrayOptions (Maybe Text) Source #

A list of source fields to map to the field.

intArrayOptions_returnEnabled :: Lens' IntArrayOptions (Maybe Bool) Source #

Whether the contents of the field can be returned in the search results.

intArrayOptions_facetEnabled :: Lens' IntArrayOptions (Maybe Bool) Source #

Whether facet information can be returned for the field.

intArrayOptions_searchEnabled :: Lens' IntArrayOptions (Maybe Bool) Source #

Whether the contents of the field are searchable.

intArrayOptions_defaultValue :: Lens' IntArrayOptions (Maybe Integer) Source #

A value to use for the field if the field isn't specified for a document.

IntOptions

intOptions_sourceField :: Lens' IntOptions (Maybe Text) Source #

The name of the source field to map to the field.

intOptions_returnEnabled :: Lens' IntOptions (Maybe Bool) Source #

Whether the contents of the field can be returned in the search results.

intOptions_facetEnabled :: Lens' IntOptions (Maybe Bool) Source #

Whether facet information can be returned for the field.

intOptions_searchEnabled :: Lens' IntOptions (Maybe Bool) Source #

Whether the contents of the field are searchable.

intOptions_sortEnabled :: Lens' IntOptions (Maybe Bool) Source #

Whether the field can be used to sort the search results.

intOptions_defaultValue :: Lens' IntOptions (Maybe Integer) Source #

A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.

LatLonOptions

latLonOptions_returnEnabled :: Lens' LatLonOptions (Maybe Bool) Source #

Whether the contents of the field can be returned in the search results.

latLonOptions_facetEnabled :: Lens' LatLonOptions (Maybe Bool) Source #

Whether facet information can be returned for the field.

latLonOptions_searchEnabled :: Lens' LatLonOptions (Maybe Bool) Source #

Whether the contents of the field are searchable.

latLonOptions_sortEnabled :: Lens' LatLonOptions (Maybe Bool) Source #

Whether the field can be used to sort the search results.

latLonOptions_defaultValue :: Lens' LatLonOptions (Maybe Text) Source #

A value to use for the field if the field isn't specified for a document.

Limits

LiteralArrayOptions

literalArrayOptions_sourceFields :: Lens' LiteralArrayOptions (Maybe Text) Source #

A list of source fields to map to the field.

literalArrayOptions_returnEnabled :: Lens' LiteralArrayOptions (Maybe Bool) Source #

Whether the contents of the field can be returned in the search results.

literalArrayOptions_facetEnabled :: Lens' LiteralArrayOptions (Maybe Bool) Source #

Whether facet information can be returned for the field.

literalArrayOptions_searchEnabled :: Lens' LiteralArrayOptions (Maybe Bool) Source #

Whether the contents of the field are searchable.

literalArrayOptions_defaultValue :: Lens' LiteralArrayOptions (Maybe Text) Source #

A value to use for the field if the field isn't specified for a document.

LiteralOptions

literalOptions_returnEnabled :: Lens' LiteralOptions (Maybe Bool) Source #

Whether the contents of the field can be returned in the search results.

literalOptions_facetEnabled :: Lens' LiteralOptions (Maybe Bool) Source #

Whether facet information can be returned for the field.

literalOptions_searchEnabled :: Lens' LiteralOptions (Maybe Bool) Source #

Whether the contents of the field are searchable.

literalOptions_sortEnabled :: Lens' LiteralOptions (Maybe Bool) Source #

Whether the field can be used to sort the search results.

literalOptions_defaultValue :: Lens' LiteralOptions (Maybe Text) Source #

A value to use for the field if the field isn't specified for a document.

OptionStatus

optionStatus_pendingDeletion :: Lens' OptionStatus (Maybe Bool) Source #

Indicates that the option will be deleted once processing is complete.

optionStatus_updateVersion :: Lens' OptionStatus (Maybe Natural) Source #

A unique integer that indicates when this option was last updated.

optionStatus_creationDate :: Lens' OptionStatus UTCTime Source #

A timestamp for when this option was created.

optionStatus_updateDate :: Lens' OptionStatus UTCTime Source #

A timestamp for when this option was last updated.

optionStatus_state :: Lens' OptionStatus OptionState Source #

The state of processing a change to an option. Possible values:

  • RequiresIndexDocuments: the option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.
  • Processing: the option's latest value is in the process of being activated.
  • Active: the option's latest value is completely deployed.
  • FailedToValidate: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.

ScalingParameters

scalingParameters_desiredInstanceType :: Lens' ScalingParameters (Maybe PartitionInstanceType) Source #

The instance type that you want to preconfigure for your domain. For example, search.m1.small.

scalingParameters_desiredReplicationCount :: Lens' ScalingParameters (Maybe Natural) Source #

The number of replicas you want to preconfigure for each index partition.

scalingParameters_desiredPartitionCount :: Lens' ScalingParameters (Maybe Natural) Source #

The number of partitions you want to preconfigure for your domain. Only valid when you select m2.2xlarge as the desired instance type.

ScalingParametersStatus

ServiceEndpoint

Suggester

SuggesterStatus

TextArrayOptions

textArrayOptions_sourceFields :: Lens' TextArrayOptions (Maybe Text) Source #

A list of source fields to map to the field.

textArrayOptions_returnEnabled :: Lens' TextArrayOptions (Maybe Bool) Source #

Whether the contents of the field can be returned in the search results.

textArrayOptions_analysisScheme :: Lens' TextArrayOptions (Maybe Text) Source #

The name of an analysis scheme for a text-array field.

textArrayOptions_highlightEnabled :: Lens' TextArrayOptions (Maybe Bool) Source #

Whether highlights can be returned for the field.

textArrayOptions_defaultValue :: Lens' TextArrayOptions (Maybe Text) Source #

A value to use for the field if the field isn't specified for a document.

TextOptions

textOptions_returnEnabled :: Lens' TextOptions (Maybe Bool) Source #

Whether the contents of the field can be returned in the search results.

textOptions_analysisScheme :: Lens' TextOptions (Maybe Text) Source #

The name of an analysis scheme for a text field.

textOptions_highlightEnabled :: Lens' TextOptions (Maybe Bool) Source #

Whether highlights can be returned for the field.

textOptions_sortEnabled :: Lens' TextOptions (Maybe Bool) Source #

Whether the field can be used to sort the search results.

textOptions_defaultValue :: Lens' TextOptions (Maybe Text) Source #

A value to use for the field if the field isn't specified for a document.