| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.CloudSearch
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- BuildSuggesters
- CreateDomain
- DefineAnalysisScheme
- DefineExpression
- DefineIndexField
- DefineSuggester
- DeleteAnalysisScheme
- DeleteDomain
- DeleteExpression
- DeleteIndexField
- DeleteSuggester
- DescribeAnalysisSchemes
- DescribeAvailabilityOptions
- DescribeDomainEndpointOptions
- DescribeDomains
- DescribeExpressions
- DescribeIndexFields
- DescribeScalingParameters
- DescribeServiceAccessPolicies
- DescribeSuggesters
- IndexDocuments
- ListDomainNames
- UpdateAvailabilityOptions
- UpdateDomainEndpointOptions
- UpdateScalingParameters
- UpdateServiceAccessPolicies
- Types
- AlgorithmicStemming
- AnalysisSchemeLanguage
- IndexFieldType
- OptionState
- PartitionInstanceType
- SuggesterFuzzyMatching
- TLSSecurityPolicy
- AccessPoliciesStatus
- AnalysisOptions
- AnalysisScheme
- AnalysisSchemeStatus
- AvailabilityOptionsStatus
- DateArrayOptions
- DateOptions
- DocumentSuggesterOptions
- DomainEndpointOptions
- DomainEndpointOptionsStatus
- DomainStatus
- DoubleArrayOptions
- DoubleOptions
- Expression
- ExpressionStatus
- IndexField
- IndexFieldStatus
- IntArrayOptions
- IntOptions
- LatLonOptions
- Limits
- LiteralArrayOptions
- LiteralOptions
- OptionStatus
- ScalingParameters
- ScalingParametersStatus
- ServiceEndpoint
- Suggester
- SuggesterStatus
- TextArrayOptions
- TextOptions
Description
Derived from API version 2013-01-01 of the AWS service descriptions, licensed under Apache 2.0.
Amazon CloudSearch Configuration Service
You use the Amazon CloudSearch configuration service to create, configure, and manage search domains. Configuration service requests are submitted using the AWS Query protocol. AWS Query requests are HTTP or HTTPS requests submitted via HTTP GET or POST with a query parameter named Action.
The endpoint for configuration service requests is region-specific: cloudsearch.region.amazonaws.com. For example, cloudsearch.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see Regions and Endpoints.
Synopsis
- defaultService :: Service
- _BaseException :: AsError a => Fold a ServiceError
- _DisabledOperationException :: AsError a => Fold a ServiceError
- _InternalException :: AsError a => Fold a ServiceError
- _InvalidTypeException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _ResourceAlreadyExistsException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- data BuildSuggesters = BuildSuggesters' Text
- newBuildSuggesters :: Text -> BuildSuggesters
- data BuildSuggestersResponse = BuildSuggestersResponse' (Maybe [Text]) Int
- newBuildSuggestersResponse :: Int -> BuildSuggestersResponse
- data CreateDomain = CreateDomain' Text
- newCreateDomain :: Text -> CreateDomain
- data CreateDomainResponse = CreateDomainResponse' (Maybe DomainStatus) Int
- newCreateDomainResponse :: Int -> CreateDomainResponse
- data DefineAnalysisScheme = DefineAnalysisScheme' Text AnalysisScheme
- newDefineAnalysisScheme :: Text -> AnalysisScheme -> DefineAnalysisScheme
- data DefineAnalysisSchemeResponse = DefineAnalysisSchemeResponse' Int AnalysisSchemeStatus
- newDefineAnalysisSchemeResponse :: Int -> AnalysisSchemeStatus -> DefineAnalysisSchemeResponse
- data DefineExpression = DefineExpression' Text Expression
- newDefineExpression :: Text -> Expression -> DefineExpression
- data DefineExpressionResponse = DefineExpressionResponse' Int ExpressionStatus
- newDefineExpressionResponse :: Int -> ExpressionStatus -> DefineExpressionResponse
- data DefineIndexField = DefineIndexField' Text IndexField
- newDefineIndexField :: Text -> IndexField -> DefineIndexField
- data DefineIndexFieldResponse = DefineIndexFieldResponse' Int IndexFieldStatus
- newDefineIndexFieldResponse :: Int -> IndexFieldStatus -> DefineIndexFieldResponse
- data DefineSuggester = DefineSuggester' Text Suggester
- newDefineSuggester :: Text -> Suggester -> DefineSuggester
- data DefineSuggesterResponse = DefineSuggesterResponse' Int SuggesterStatus
- newDefineSuggesterResponse :: Int -> SuggesterStatus -> DefineSuggesterResponse
- data DeleteAnalysisScheme = DeleteAnalysisScheme' Text Text
- newDeleteAnalysisScheme :: Text -> Text -> DeleteAnalysisScheme
- data DeleteAnalysisSchemeResponse = DeleteAnalysisSchemeResponse' Int AnalysisSchemeStatus
- newDeleteAnalysisSchemeResponse :: Int -> AnalysisSchemeStatus -> DeleteAnalysisSchemeResponse
- data DeleteDomain = DeleteDomain' Text
- newDeleteDomain :: Text -> DeleteDomain
- data DeleteDomainResponse = DeleteDomainResponse' (Maybe DomainStatus) Int
- newDeleteDomainResponse :: Int -> DeleteDomainResponse
- data DeleteExpression = DeleteExpression' Text Text
- newDeleteExpression :: Text -> Text -> DeleteExpression
- data DeleteExpressionResponse = DeleteExpressionResponse' Int ExpressionStatus
- newDeleteExpressionResponse :: Int -> ExpressionStatus -> DeleteExpressionResponse
- data DeleteIndexField = DeleteIndexField' Text Text
- newDeleteIndexField :: Text -> Text -> DeleteIndexField
- data DeleteIndexFieldResponse = DeleteIndexFieldResponse' Int IndexFieldStatus
- newDeleteIndexFieldResponse :: Int -> IndexFieldStatus -> DeleteIndexFieldResponse
- data DeleteSuggester = DeleteSuggester' Text Text
- newDeleteSuggester :: Text -> Text -> DeleteSuggester
- data DeleteSuggesterResponse = DeleteSuggesterResponse' Int SuggesterStatus
- newDeleteSuggesterResponse :: Int -> SuggesterStatus -> DeleteSuggesterResponse
- data DescribeAnalysisSchemes = DescribeAnalysisSchemes' (Maybe [Text]) (Maybe Bool) Text
- newDescribeAnalysisSchemes :: Text -> DescribeAnalysisSchemes
- data DescribeAnalysisSchemesResponse = DescribeAnalysisSchemesResponse' Int [AnalysisSchemeStatus]
- newDescribeAnalysisSchemesResponse :: Int -> DescribeAnalysisSchemesResponse
- data DescribeAvailabilityOptions = DescribeAvailabilityOptions' (Maybe Bool) Text
- newDescribeAvailabilityOptions :: Text -> DescribeAvailabilityOptions
- data DescribeAvailabilityOptionsResponse = DescribeAvailabilityOptionsResponse' (Maybe AvailabilityOptionsStatus) Int
- newDescribeAvailabilityOptionsResponse :: Int -> DescribeAvailabilityOptionsResponse
- data DescribeDomainEndpointOptions = DescribeDomainEndpointOptions' (Maybe Bool) Text
- newDescribeDomainEndpointOptions :: Text -> DescribeDomainEndpointOptions
- data DescribeDomainEndpointOptionsResponse = DescribeDomainEndpointOptionsResponse' (Maybe DomainEndpointOptionsStatus) Int
- newDescribeDomainEndpointOptionsResponse :: Int -> DescribeDomainEndpointOptionsResponse
- data DescribeDomains = DescribeDomains' (Maybe [Text])
- newDescribeDomains :: DescribeDomains
- data DescribeDomainsResponse = DescribeDomainsResponse' Int [DomainStatus]
- newDescribeDomainsResponse :: Int -> DescribeDomainsResponse
- data DescribeExpressions = DescribeExpressions' (Maybe Bool) (Maybe [Text]) Text
- newDescribeExpressions :: Text -> DescribeExpressions
- data DescribeExpressionsResponse = DescribeExpressionsResponse' Int [ExpressionStatus]
- newDescribeExpressionsResponse :: Int -> DescribeExpressionsResponse
- data DescribeIndexFields = DescribeIndexFields' (Maybe Bool) (Maybe [Text]) Text
- newDescribeIndexFields :: Text -> DescribeIndexFields
- data DescribeIndexFieldsResponse = DescribeIndexFieldsResponse' Int [IndexFieldStatus]
- newDescribeIndexFieldsResponse :: Int -> DescribeIndexFieldsResponse
- data DescribeScalingParameters = DescribeScalingParameters' Text
- newDescribeScalingParameters :: Text -> DescribeScalingParameters
- data DescribeScalingParametersResponse = DescribeScalingParametersResponse' Int ScalingParametersStatus
- newDescribeScalingParametersResponse :: Int -> ScalingParametersStatus -> DescribeScalingParametersResponse
- data DescribeServiceAccessPolicies = DescribeServiceAccessPolicies' (Maybe Bool) Text
- newDescribeServiceAccessPolicies :: Text -> DescribeServiceAccessPolicies
- data DescribeServiceAccessPoliciesResponse = DescribeServiceAccessPoliciesResponse' Int AccessPoliciesStatus
- newDescribeServiceAccessPoliciesResponse :: Int -> AccessPoliciesStatus -> DescribeServiceAccessPoliciesResponse
- data DescribeSuggesters = DescribeSuggesters' (Maybe Bool) (Maybe [Text]) Text
- newDescribeSuggesters :: Text -> DescribeSuggesters
- data DescribeSuggestersResponse = DescribeSuggestersResponse' Int [SuggesterStatus]
- newDescribeSuggestersResponse :: Int -> DescribeSuggestersResponse
- data IndexDocuments = IndexDocuments' Text
- newIndexDocuments :: Text -> IndexDocuments
- data IndexDocumentsResponse = IndexDocumentsResponse' (Maybe [Text]) Int
- newIndexDocumentsResponse :: Int -> IndexDocumentsResponse
- data ListDomainNames = ListDomainNames' {
- newListDomainNames :: ListDomainNames
- data ListDomainNamesResponse = ListDomainNamesResponse' (Maybe (HashMap Text Text)) Int
- newListDomainNamesResponse :: Int -> ListDomainNamesResponse
- data UpdateAvailabilityOptions = UpdateAvailabilityOptions' Text Bool
- newUpdateAvailabilityOptions :: Text -> Bool -> UpdateAvailabilityOptions
- data UpdateAvailabilityOptionsResponse = UpdateAvailabilityOptionsResponse' (Maybe AvailabilityOptionsStatus) Int
- newUpdateAvailabilityOptionsResponse :: Int -> UpdateAvailabilityOptionsResponse
- data UpdateDomainEndpointOptions = UpdateDomainEndpointOptions' Text DomainEndpointOptions
- newUpdateDomainEndpointOptions :: Text -> DomainEndpointOptions -> UpdateDomainEndpointOptions
- data UpdateDomainEndpointOptionsResponse = UpdateDomainEndpointOptionsResponse' (Maybe DomainEndpointOptionsStatus) Int
- newUpdateDomainEndpointOptionsResponse :: Int -> UpdateDomainEndpointOptionsResponse
- data UpdateScalingParameters = UpdateScalingParameters' Text ScalingParameters
- newUpdateScalingParameters :: Text -> ScalingParameters -> UpdateScalingParameters
- data UpdateScalingParametersResponse = UpdateScalingParametersResponse' Int ScalingParametersStatus
- newUpdateScalingParametersResponse :: Int -> ScalingParametersStatus -> UpdateScalingParametersResponse
- data UpdateServiceAccessPolicies = UpdateServiceAccessPolicies' Text Text
- newUpdateServiceAccessPolicies :: Text -> Text -> UpdateServiceAccessPolicies
- data UpdateServiceAccessPoliciesResponse = UpdateServiceAccessPoliciesResponse' Int AccessPoliciesStatus
- newUpdateServiceAccessPoliciesResponse :: Int -> AccessPoliciesStatus -> UpdateServiceAccessPoliciesResponse
- newtype AlgorithmicStemming where
- AlgorithmicStemming' { }
- pattern AlgorithmicStemming_Full :: AlgorithmicStemming
- pattern AlgorithmicStemming_Light :: AlgorithmicStemming
- pattern AlgorithmicStemming_Minimal :: AlgorithmicStemming
- pattern AlgorithmicStemming_None :: AlgorithmicStemming
- newtype AnalysisSchemeLanguage where
- AnalysisSchemeLanguage' { }
- pattern AnalysisSchemeLanguage_Ar :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Bg :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Ca :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Cs :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Da :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_De :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_El :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_En :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Es :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Eu :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Fa :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Fi :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Fr :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Ga :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Gl :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_He :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Hi :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Hu :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Hy :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Id :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_It :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Ja :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Ko :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Lv :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Mul :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Nl :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_No :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Pt :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Ro :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Ru :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Sv :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Th :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Tr :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Zh_Hans :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Zh_Hant :: AnalysisSchemeLanguage
- newtype IndexFieldType where
- IndexFieldType' { }
- pattern IndexFieldType_Date :: IndexFieldType
- pattern IndexFieldType_Date_array :: IndexFieldType
- pattern IndexFieldType_Double :: IndexFieldType
- pattern IndexFieldType_Double_array :: IndexFieldType
- pattern IndexFieldType_Int :: IndexFieldType
- pattern IndexFieldType_Int_array :: IndexFieldType
- pattern IndexFieldType_Latlon :: IndexFieldType
- pattern IndexFieldType_Literal :: IndexFieldType
- pattern IndexFieldType_Literal_array :: IndexFieldType
- pattern IndexFieldType_Text :: IndexFieldType
- pattern IndexFieldType_Text_array :: IndexFieldType
- newtype OptionState where
- OptionState' { }
- pattern OptionState_Active :: OptionState
- pattern OptionState_FailedToValidate :: OptionState
- pattern OptionState_Processing :: OptionState
- pattern OptionState_RequiresIndexDocuments :: OptionState
- newtype PartitionInstanceType where
- PartitionInstanceType' { }
- pattern PartitionInstanceType_Search_2xlarge :: PartitionInstanceType
- pattern PartitionInstanceType_Search_large :: PartitionInstanceType
- pattern PartitionInstanceType_Search_m1_large :: PartitionInstanceType
- pattern PartitionInstanceType_Search_m1_small :: PartitionInstanceType
- pattern PartitionInstanceType_Search_m2_2xlarge :: PartitionInstanceType
- pattern PartitionInstanceType_Search_m2_xlarge :: PartitionInstanceType
- pattern PartitionInstanceType_Search_m3_2xlarge :: PartitionInstanceType
- pattern PartitionInstanceType_Search_m3_large :: PartitionInstanceType
- pattern PartitionInstanceType_Search_m3_medium :: PartitionInstanceType
- pattern PartitionInstanceType_Search_m3_xlarge :: PartitionInstanceType
- pattern PartitionInstanceType_Search_medium :: PartitionInstanceType
- pattern PartitionInstanceType_Search_previousgeneration_2xlarge :: PartitionInstanceType
- pattern PartitionInstanceType_Search_previousgeneration_large :: PartitionInstanceType
- pattern PartitionInstanceType_Search_previousgeneration_small :: PartitionInstanceType
- pattern PartitionInstanceType_Search_previousgeneration_xlarge :: PartitionInstanceType
- pattern PartitionInstanceType_Search_small :: PartitionInstanceType
- pattern PartitionInstanceType_Search_xlarge :: PartitionInstanceType
- newtype SuggesterFuzzyMatching where
- newtype TLSSecurityPolicy where
- data AccessPoliciesStatus = AccessPoliciesStatus' Text OptionStatus
- newAccessPoliciesStatus :: Text -> OptionStatus -> AccessPoliciesStatus
- data AnalysisOptions = AnalysisOptions' (Maybe AlgorithmicStemming) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newAnalysisOptions :: AnalysisOptions
- data AnalysisScheme = AnalysisScheme' (Maybe AnalysisOptions) Text AnalysisSchemeLanguage
- newAnalysisScheme :: Text -> AnalysisSchemeLanguage -> AnalysisScheme
- data AnalysisSchemeStatus = AnalysisSchemeStatus' AnalysisScheme OptionStatus
- newAnalysisSchemeStatus :: AnalysisScheme -> OptionStatus -> AnalysisSchemeStatus
- data AvailabilityOptionsStatus = AvailabilityOptionsStatus' Bool OptionStatus
- newAvailabilityOptionsStatus :: Bool -> OptionStatus -> AvailabilityOptionsStatus
- data DateArrayOptions = DateArrayOptions' (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text)
- newDateArrayOptions :: DateArrayOptions
- data DateOptions = DateOptions' (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text)
- newDateOptions :: DateOptions
- data DocumentSuggesterOptions = DocumentSuggesterOptions' (Maybe SuggesterFuzzyMatching) (Maybe Text) Text
- newDocumentSuggesterOptions :: Text -> DocumentSuggesterOptions
- data DomainEndpointOptions = DomainEndpointOptions' (Maybe Bool) (Maybe TLSSecurityPolicy)
- newDomainEndpointOptions :: DomainEndpointOptions
- data DomainEndpointOptionsStatus = DomainEndpointOptionsStatus' DomainEndpointOptions OptionStatus
- newDomainEndpointOptionsStatus :: DomainEndpointOptions -> OptionStatus -> DomainEndpointOptionsStatus
- data DomainStatus = DomainStatus' (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe ServiceEndpoint) (Maybe Limits) (Maybe Bool) (Maybe Natural) (Maybe Text) (Maybe Natural) (Maybe ServiceEndpoint) Text Text Bool
- newDomainStatus :: Text -> Text -> Bool -> DomainStatus
- data DoubleArrayOptions = DoubleArrayOptions' (Maybe Double) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text)
- newDoubleArrayOptions :: DoubleArrayOptions
- data DoubleOptions = DoubleOptions' (Maybe Double) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text)
- newDoubleOptions :: DoubleOptions
- data Expression = Expression' Text Text
- newExpression :: Text -> Text -> Expression
- data ExpressionStatus = ExpressionStatus' Expression OptionStatus
- newExpressionStatus :: Expression -> OptionStatus -> ExpressionStatus
- data IndexField = IndexField' (Maybe DateArrayOptions) (Maybe DateOptions) (Maybe DoubleArrayOptions) (Maybe DoubleOptions) (Maybe IntArrayOptions) (Maybe IntOptions) (Maybe LatLonOptions) (Maybe LiteralArrayOptions) (Maybe LiteralOptions) (Maybe TextArrayOptions) (Maybe TextOptions) Text IndexFieldType
- newIndexField :: Text -> IndexFieldType -> IndexField
- data IndexFieldStatus = IndexFieldStatus' IndexField OptionStatus
- newIndexFieldStatus :: IndexField -> OptionStatus -> IndexFieldStatus
- data IntArrayOptions = IntArrayOptions' (Maybe Integer) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text)
- newIntArrayOptions :: IntArrayOptions
- data IntOptions = IntOptions' (Maybe Integer) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text)
- newIntOptions :: IntOptions
- data LatLonOptions = LatLonOptions' (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text)
- newLatLonOptions :: LatLonOptions
- data Limits = Limits' Natural Natural
- newLimits :: Natural -> Natural -> Limits
- data LiteralArrayOptions = LiteralArrayOptions' (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text)
- newLiteralArrayOptions :: LiteralArrayOptions
- data LiteralOptions = LiteralOptions' (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text)
- newLiteralOptions :: LiteralOptions
- data OptionStatus = OptionStatus' (Maybe Bool) (Maybe Natural) ISO8601 ISO8601 OptionState
- newOptionStatus :: UTCTime -> UTCTime -> OptionState -> OptionStatus
- data ScalingParameters = ScalingParameters' (Maybe PartitionInstanceType) (Maybe Natural) (Maybe Natural)
- newScalingParameters :: ScalingParameters
- data ScalingParametersStatus = ScalingParametersStatus' ScalingParameters OptionStatus
- newScalingParametersStatus :: ScalingParameters -> OptionStatus -> ScalingParametersStatus
- data ServiceEndpoint = ServiceEndpoint' (Maybe Text)
- newServiceEndpoint :: ServiceEndpoint
- data Suggester = Suggester' Text DocumentSuggesterOptions
- newSuggester :: Text -> DocumentSuggesterOptions -> Suggester
- data SuggesterStatus = SuggesterStatus' Suggester OptionStatus
- newSuggesterStatus :: Suggester -> OptionStatus -> SuggesterStatus
- data TextArrayOptions = TextArrayOptions' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text)
- newTextArrayOptions :: TextArrayOptions
- data TextOptions = TextOptions' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text)
- newTextOptions :: TextOptions
Service Configuration
defaultService :: Service Source #
API version 2013-01-01 of the Amazon CloudSearch SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by CloudSearch.
BaseException
_BaseException :: AsError a => Fold a ServiceError Source #
An error occurred while processing the request.
DisabledOperationException
_DisabledOperationException :: AsError a => Fold a ServiceError Source #
The request was rejected because it attempted an operation which is not enabled.
InternalException
_InternalException :: AsError a => Fold a ServiceError Source #
An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
InvalidTypeException
_InvalidTypeException :: AsError a => Fold a ServiceError Source #
The request was rejected because it specified an invalid type definition.
LimitExceededException
_LimitExceededException :: AsError a => Fold a ServiceError Source #
The request was rejected because a resource limit has already been met.
ResourceAlreadyExistsException
_ResourceAlreadyExistsException :: AsError a => Fold a ServiceError Source #
The request was rejected because it attempted to create a resource that already exists.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The request was rejected because it attempted to reference a resource that does not exist.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
The request was rejected because it has invalid parameters.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
BuildSuggesters
data BuildSuggesters Source #
Container for the parameters to the BuildSuggester operation.
Specifies the name of the domain you want to update.
See: newBuildSuggesters smart constructor.
Constructors
| BuildSuggesters' Text |
Instances
Arguments
| :: Text | |
| -> BuildSuggesters |
Create a value of BuildSuggesters with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
BuildSuggesters, buildSuggesters_domainName - Undocumented member.
data BuildSuggestersResponse Source #
The result of a BuildSuggester request. Contains a list of the fields
used for suggestions.
See: newBuildSuggestersResponse smart constructor.
Constructors
| BuildSuggestersResponse' (Maybe [Text]) Int |
Instances
newBuildSuggestersResponse Source #
Create a value of BuildSuggestersResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fieldNames:BuildSuggestersResponse', buildSuggestersResponse_fieldNames - Undocumented member.
$sel:httpStatus:BuildSuggestersResponse', buildSuggestersResponse_httpStatus - The response's http status code.
CreateDomain
data CreateDomain Source #
Container for the parameters to the CreateDomain operation. Specifies
a name for the new search domain.
See: newCreateDomain smart constructor.
Constructors
| CreateDomain' Text |
Instances
Arguments
| :: Text | |
| -> CreateDomain |
Create a value of CreateDomain with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateDomain, createDomain_domainName - 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.
data CreateDomainResponse Source #
The result of a CreateDomainRequest. Contains the status of a newly
created domain.
See: newCreateDomainResponse smart constructor.
Constructors
| CreateDomainResponse' (Maybe DomainStatus) Int |
Instances
newCreateDomainResponse Source #
Arguments
| :: Int | |
| -> CreateDomainResponse |
Create a value of CreateDomainResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domainStatus:CreateDomainResponse', createDomainResponse_domainStatus - Undocumented member.
$sel:httpStatus:CreateDomainResponse', createDomainResponse_httpStatus - The response's http status code.
DefineAnalysisScheme
data DefineAnalysisScheme Source #
Container for the parameters to the DefineAnalysisScheme operation.
Specifies the name of the domain you want to update and the analysis
scheme configuration.
See: newDefineAnalysisScheme smart constructor.
Constructors
| DefineAnalysisScheme' Text AnalysisScheme |
Instances
newDefineAnalysisScheme Source #
Create a value of DefineAnalysisScheme with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DefineAnalysisScheme, defineAnalysisScheme_domainName - Undocumented member.
DefineAnalysisScheme, defineAnalysisScheme_analysisScheme - Undocumented member.
data DefineAnalysisSchemeResponse Source #
The result of a DefineAnalysisScheme request. Contains the status of
the newly-configured analysis scheme.
See: newDefineAnalysisSchemeResponse smart constructor.
Constructors
| DefineAnalysisSchemeResponse' Int AnalysisSchemeStatus |
Instances
newDefineAnalysisSchemeResponse Source #
Arguments
| :: Int | |
| -> AnalysisSchemeStatus | |
| -> DefineAnalysisSchemeResponse |
Create a value of DefineAnalysisSchemeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DefineAnalysisSchemeResponse', defineAnalysisSchemeResponse_httpStatus - The response's http status code.
DefineAnalysisScheme, defineAnalysisSchemeResponse_analysisScheme - Undocumented member.
DefineExpression
data DefineExpression Source #
Container for the parameters to the DefineExpression operation.
Specifies the name of the domain you want to update and the expression
you want to configure.
See: newDefineExpression smart constructor.
Constructors
| DefineExpression' Text Expression |
Instances
Arguments
| :: Text | |
| -> Expression | |
| -> DefineExpression |
Create a value of DefineExpression with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DefineExpression, defineExpression_domainName - Undocumented member.
DefineExpression, defineExpression_expression - Undocumented member.
data DefineExpressionResponse Source #
The result of a DefineExpression request. Contains the status of the
newly-configured expression.
See: newDefineExpressionResponse smart constructor.
Constructors
| DefineExpressionResponse' Int ExpressionStatus |
Instances
newDefineExpressionResponse Source #
Arguments
| :: Int | |
| -> ExpressionStatus | |
| -> DefineExpressionResponse |
Create a value of DefineExpressionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DefineExpressionResponse', defineExpressionResponse_httpStatus - The response's http status code.
DefineExpression, defineExpressionResponse_expression - Undocumented member.
DefineIndexField
data DefineIndexField Source #
Container for the parameters to the DefineIndexField operation.
Specifies the name of the domain you want to update and the index field
configuration.
See: newDefineIndexField smart constructor.
Constructors
| DefineIndexField' Text IndexField |
Instances
Arguments
| :: Text | |
| -> IndexField | |
| -> DefineIndexField |
Create a value of DefineIndexField with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DefineIndexField, defineIndexField_domainName - Undocumented member.
DefineIndexField, defineIndexField_indexField - The index field and field options you want to configure.
data DefineIndexFieldResponse Source #
The result of a DefineIndexField request. Contains the status of the
newly-configured index field.
See: newDefineIndexFieldResponse smart constructor.
Constructors
| DefineIndexFieldResponse' Int IndexFieldStatus |
Instances
newDefineIndexFieldResponse Source #
Arguments
| :: Int | |
| -> IndexFieldStatus | |
| -> DefineIndexFieldResponse |
Create a value of DefineIndexFieldResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DefineIndexFieldResponse', defineIndexFieldResponse_httpStatus - The response's http status code.
DefineIndexField, defineIndexFieldResponse_indexField - Undocumented member.
DefineSuggester
data DefineSuggester Source #
Container for the parameters to the DefineSuggester operation.
Specifies the name of the domain you want to update and the suggester
configuration.
See: newDefineSuggester smart constructor.
Constructors
| DefineSuggester' Text Suggester |
Instances
Arguments
| :: Text | |
| -> Suggester | |
| -> DefineSuggester |
Create a value of DefineSuggester with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DefineSuggester, defineSuggester_domainName - Undocumented member.
DefineSuggester, defineSuggester_suggester - Undocumented member.
data DefineSuggesterResponse Source #
The result of a DefineSuggester request. Contains the status of the
newly-configured suggester.
See: newDefineSuggesterResponse smart constructor.
Constructors
| DefineSuggesterResponse' Int SuggesterStatus |
Instances
newDefineSuggesterResponse Source #
Arguments
| :: Int | |
| -> SuggesterStatus | |
| -> DefineSuggesterResponse |
Create a value of DefineSuggesterResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DefineSuggesterResponse', defineSuggesterResponse_httpStatus - The response's http status code.
DefineSuggester, defineSuggesterResponse_suggester - Undocumented member.
DeleteAnalysisScheme
data DeleteAnalysisScheme Source #
Container for the parameters to the DeleteAnalysisScheme operation.
Specifies the name of the domain you want to update and the analysis
scheme you want to delete.
See: newDeleteAnalysisScheme smart constructor.
Constructors
| DeleteAnalysisScheme' Text Text |
Instances
newDeleteAnalysisScheme Source #
Arguments
| :: Text | |
| -> Text | |
| -> DeleteAnalysisScheme |
Create a value of DeleteAnalysisScheme with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteAnalysisScheme, deleteAnalysisScheme_domainName - Undocumented member.
DeleteAnalysisScheme, deleteAnalysisScheme_analysisSchemeName - The name of the analysis scheme you want to delete.
data DeleteAnalysisSchemeResponse Source #
The result of a DeleteAnalysisScheme request. Contains the status of
the deleted analysis scheme.
See: newDeleteAnalysisSchemeResponse smart constructor.
Constructors
| DeleteAnalysisSchemeResponse' Int AnalysisSchemeStatus |
Instances
newDeleteAnalysisSchemeResponse Source #
Arguments
| :: Int | |
| -> AnalysisSchemeStatus | |
| -> DeleteAnalysisSchemeResponse |
Create a value of DeleteAnalysisSchemeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteAnalysisSchemeResponse', deleteAnalysisSchemeResponse_httpStatus - The response's http status code.
DeleteAnalysisSchemeResponse, deleteAnalysisSchemeResponse_analysisScheme - The status of the analysis scheme being deleted.
DeleteDomain
data DeleteDomain Source #
Container for the parameters to the DeleteDomain operation. Specifies
the name of the domain you want to delete.
See: newDeleteDomain smart constructor.
Constructors
| DeleteDomain' Text |
Instances
Arguments
| :: Text | |
| -> DeleteDomain |
Create a value of DeleteDomain with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteDomain, deleteDomain_domainName - The name of the domain you want to permanently delete.
data DeleteDomainResponse Source #
The result of a DeleteDomain request. Contains the status of a newly
deleted domain, or no status if the domain has already been completely
deleted.
See: newDeleteDomainResponse smart constructor.
Constructors
| DeleteDomainResponse' (Maybe DomainStatus) Int |
Instances
newDeleteDomainResponse Source #
Arguments
| :: Int | |
| -> DeleteDomainResponse |
Create a value of DeleteDomainResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domainStatus:DeleteDomainResponse', deleteDomainResponse_domainStatus - Undocumented member.
$sel:httpStatus:DeleteDomainResponse', deleteDomainResponse_httpStatus - The response's http status code.
DeleteExpression
data DeleteExpression Source #
Container for the parameters to the DeleteExpression operation.
Specifies the name of the domain you want to update and the name of the
expression you want to delete.
See: newDeleteExpression smart constructor.
Constructors
| DeleteExpression' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DeleteExpression |
Create a value of DeleteExpression with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteExpression, deleteExpression_domainName - Undocumented member.
DeleteExpression, deleteExpression_expressionName - The name of the Expression to delete.
data DeleteExpressionResponse Source #
The result of a DeleteExpression request. Specifies the expression
being deleted.
See: newDeleteExpressionResponse smart constructor.
Constructors
| DeleteExpressionResponse' Int ExpressionStatus |
Instances
newDeleteExpressionResponse Source #
Arguments
| :: Int | |
| -> ExpressionStatus | |
| -> DeleteExpressionResponse |
Create a value of DeleteExpressionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteExpressionResponse', deleteExpressionResponse_httpStatus - The response's http status code.
$sel:expression:DeleteExpressionResponse', deleteExpressionResponse_expression - The status of the expression being deleted.
DeleteIndexField
data DeleteIndexField Source #
Container for the parameters to the DeleteIndexField operation.
Specifies the name of the domain you want to update and the name of the
index field you want to delete.
See: newDeleteIndexField smart constructor.
Constructors
| DeleteIndexField' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DeleteIndexField |
Create a value of DeleteIndexField with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteIndexField, deleteIndexField_domainName - Undocumented member.
DeleteIndexField, deleteIndexField_indexFieldName - The name of the index field your want to remove from the domain's
indexing options.
data DeleteIndexFieldResponse Source #
The result of a DeleteIndexField request.
See: newDeleteIndexFieldResponse smart constructor.
Constructors
| DeleteIndexFieldResponse' Int IndexFieldStatus |
Instances
newDeleteIndexFieldResponse Source #
Arguments
| :: Int | |
| -> IndexFieldStatus | |
| -> DeleteIndexFieldResponse |
Create a value of DeleteIndexFieldResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteIndexFieldResponse', deleteIndexFieldResponse_httpStatus - The response's http status code.
$sel:indexField:DeleteIndexFieldResponse', deleteIndexFieldResponse_indexField - The status of the index field being deleted.
DeleteSuggester
data DeleteSuggester Source #
Container for the parameters to the DeleteSuggester operation.
Specifies the name of the domain you want to update and name of the
suggester you want to delete.
See: newDeleteSuggester smart constructor.
Constructors
| DeleteSuggester' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DeleteSuggester |
Create a value of DeleteSuggester with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteSuggester, deleteSuggester_domainName - Undocumented member.
DeleteSuggester, deleteSuggester_suggesterName - Specifies the name of the suggester you want to delete.
data DeleteSuggesterResponse Source #
The result of a DeleteSuggester request. Contains the status of the
deleted suggester.
See: newDeleteSuggesterResponse smart constructor.
Constructors
| DeleteSuggesterResponse' Int SuggesterStatus |
Instances
newDeleteSuggesterResponse Source #
Arguments
| :: Int | |
| -> SuggesterStatus | |
| -> DeleteSuggesterResponse |
Create a value of DeleteSuggesterResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteSuggesterResponse', deleteSuggesterResponse_httpStatus - The response's http status code.
$sel:suggester:DeleteSuggesterResponse', deleteSuggesterResponse_suggester - The status of the suggester being deleted.
DescribeAnalysisSchemes
data DescribeAnalysisSchemes Source #
Container for the parameters to the DescribeAnalysisSchemes operation.
Specifies the name of the domain you want to describe. To limit the
response to particular analysis schemes, specify the names of the
analysis schemes you want to describe. To show the active configuration
and exclude any pending changes, set the Deployed option to true.
See: newDescribeAnalysisSchemes smart constructor.
Instances
newDescribeAnalysisSchemes Source #
Arguments
| :: Text | |
| -> DescribeAnalysisSchemes |
Create a value of DescribeAnalysisSchemes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:analysisSchemeNames:DescribeAnalysisSchemes', describeAnalysisSchemes_analysisSchemeNames - The analysis schemes you want to describe.
$sel:deployed:DescribeAnalysisSchemes', describeAnalysisSchemes_deployed - Whether to display the deployed configuration (true) or include any
pending changes (false). Defaults to false.
DescribeAnalysisSchemes, describeAnalysisSchemes_domainName - The name of the domain you want to describe.
data DescribeAnalysisSchemesResponse Source #
The result of a DescribeAnalysisSchemes request. Contains the analysis
schemes configured for the domain specified in the request.
See: newDescribeAnalysisSchemesResponse smart constructor.
Constructors
| DescribeAnalysisSchemesResponse' Int [AnalysisSchemeStatus] |
Instances
newDescribeAnalysisSchemesResponse Source #
Create a value of DescribeAnalysisSchemesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeAnalysisSchemesResponse', describeAnalysisSchemesResponse_httpStatus - The response's http status code.
$sel:analysisSchemes:DescribeAnalysisSchemesResponse', describeAnalysisSchemesResponse_analysisSchemes - The analysis scheme descriptions.
DescribeAvailabilityOptions
data DescribeAvailabilityOptions Source #
Container for the parameters to the DescribeAvailabilityOptions
operation. Specifies the name of the domain you want to describe. To
show the active configuration and exclude any pending changes, set the
Deployed option to true.
See: newDescribeAvailabilityOptions smart constructor.
Constructors
| DescribeAvailabilityOptions' (Maybe Bool) Text |
Instances
newDescribeAvailabilityOptions Source #
Arguments
| :: Text | |
| -> DescribeAvailabilityOptions |
Create a value of DescribeAvailabilityOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deployed:DescribeAvailabilityOptions', describeAvailabilityOptions_deployed - Whether to display the deployed configuration (true) or include any
pending changes (false). Defaults to false.
DescribeAvailabilityOptions, describeAvailabilityOptions_domainName - The name of the domain you want to describe.
data DescribeAvailabilityOptionsResponse Source #
The result of a DescribeAvailabilityOptions request. Indicates whether
or not the Multi-AZ option is enabled for the domain specified in the
request.
See: newDescribeAvailabilityOptionsResponse smart constructor.
Instances
newDescribeAvailabilityOptionsResponse Source #
Arguments
| :: Int | |
| -> DescribeAvailabilityOptionsResponse |
Create a value of DescribeAvailabilityOptionsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:availabilityOptions:DescribeAvailabilityOptionsResponse', describeAvailabilityOptionsResponse_availabilityOptions - The availability options configured for the domain. Indicates whether
Multi-AZ is enabled for the domain.
$sel:httpStatus:DescribeAvailabilityOptionsResponse', describeAvailabilityOptionsResponse_httpStatus - The response's http status code.
DescribeDomainEndpointOptions
data DescribeDomainEndpointOptions Source #
Container for the parameters to the DescribeDomainEndpointOptions
operation. Specify the name of the domain you want to describe. To show
the active configuration and exclude any pending changes, set the
Deployed option to true.
See: newDescribeDomainEndpointOptions smart constructor.
Constructors
| DescribeDomainEndpointOptions' (Maybe Bool) Text |
Instances
newDescribeDomainEndpointOptions Source #
Create a value of DescribeDomainEndpointOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deployed:DescribeDomainEndpointOptions', describeDomainEndpointOptions_deployed - Whether to retrieve the latest configuration (which might be in a
Processing state) or the current, active configuration. Defaults to
false.
DescribeDomainEndpointOptions, describeDomainEndpointOptions_domainName - A string that represents the name of a domain.
data DescribeDomainEndpointOptionsResponse Source #
The result of a DescribeDomainEndpointOptions request. Contains the
status and configuration of a search domain's endpoint options.
See: newDescribeDomainEndpointOptionsResponse smart constructor.
Instances
newDescribeDomainEndpointOptionsResponse Source #
Arguments
| :: Int | |
| -> DescribeDomainEndpointOptionsResponse |
Create a value of DescribeDomainEndpointOptionsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domainEndpointOptions:DescribeDomainEndpointOptionsResponse', describeDomainEndpointOptionsResponse_domainEndpointOptions - The status and configuration of a search domain's endpoint options.
$sel:httpStatus:DescribeDomainEndpointOptionsResponse', describeDomainEndpointOptionsResponse_httpStatus - The response's http status code.
DescribeDomains
data DescribeDomains Source #
Container for the parameters to the DescribeDomains operation. By
default shows the status of all domains. To restrict the response to
particular domains, specify the names of the domains you want to
describe.
See: newDescribeDomains smart constructor.
Constructors
| DescribeDomains' (Maybe [Text]) |
Instances
newDescribeDomains :: DescribeDomains Source #
Create a value of DescribeDomains with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domainNames:DescribeDomains', describeDomains_domainNames - The names of the domains you want to include in the response.
data DescribeDomainsResponse Source #
The result of a DescribeDomains request. Contains the status of the
domains specified in the request or all domains owned by the account.
See: newDescribeDomainsResponse smart constructor.
Constructors
| DescribeDomainsResponse' Int [DomainStatus] |
Instances
newDescribeDomainsResponse Source #
Create a value of DescribeDomainsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeDomainsResponse', describeDomainsResponse_httpStatus - The response's http status code.
$sel:domainStatusList:DescribeDomainsResponse', describeDomainsResponse_domainStatusList - Undocumented member.
DescribeExpressions
data DescribeExpressions Source #
Container for the parameters to the DescribeDomains operation.
Specifies the name of the domain you want to describe. To restrict the
response to particular expressions, specify the names of the expressions
you want to describe. To show the active configuration and exclude any
pending changes, set the Deployed option to true.
See: newDescribeExpressions smart constructor.
Instances
newDescribeExpressions Source #
Arguments
| :: Text | |
| -> DescribeExpressions |
Create a value of DescribeExpressions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deployed:DescribeExpressions', describeExpressions_deployed - Whether to display the deployed configuration (true) or include any
pending changes (false). Defaults to false.
$sel:expressionNames:DescribeExpressions', describeExpressions_expressionNames - Limits the DescribeExpressions response to the specified expressions.
If not specified, all expressions are shown.
DescribeExpressions, describeExpressions_domainName - The name of the domain you want to describe.
data DescribeExpressionsResponse Source #
The result of a DescribeExpressions request. Contains the expressions
configured for the domain specified in the request.
See: newDescribeExpressionsResponse smart constructor.
Constructors
| DescribeExpressionsResponse' Int [ExpressionStatus] |
Instances
newDescribeExpressionsResponse Source #
Create a value of DescribeExpressionsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeExpressionsResponse', describeExpressionsResponse_httpStatus - The response's http status code.
$sel:expressions:DescribeExpressionsResponse', describeExpressionsResponse_expressions - The expressions configured for the domain.
DescribeIndexFields
data DescribeIndexFields Source #
Container for the parameters to the DescribeIndexFields operation.
Specifies the name of the domain you want to describe. To restrict the
response to particular index fields, specify the names of the index
fields you want to describe. To show the active configuration and
exclude any pending changes, set the Deployed option to true.
See: newDescribeIndexFields smart constructor.
Instances
newDescribeIndexFields Source #
Arguments
| :: Text | |
| -> DescribeIndexFields |
Create a value of DescribeIndexFields with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deployed:DescribeIndexFields', describeIndexFields_deployed - Whether to display the deployed configuration (true) or include any
pending changes (false). Defaults to false.
$sel:fieldNames:DescribeIndexFields', describeIndexFields_fieldNames - A list of the index fields you want to describe. If not specified,
information is returned for all configured index fields.
DescribeIndexFields, describeIndexFields_domainName - The name of the domain you want to describe.
data DescribeIndexFieldsResponse Source #
The result of a DescribeIndexFields request. Contains the index fields
configured for the domain specified in the request.
See: newDescribeIndexFieldsResponse smart constructor.
Constructors
| DescribeIndexFieldsResponse' Int [IndexFieldStatus] |
Instances
newDescribeIndexFieldsResponse Source #
Create a value of DescribeIndexFieldsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeIndexFieldsResponse', describeIndexFieldsResponse_httpStatus - The response's http status code.
$sel:indexFields:DescribeIndexFieldsResponse', describeIndexFieldsResponse_indexFields - The index fields configured for the domain.
DescribeScalingParameters
data DescribeScalingParameters Source #
Container for the parameters to the DescribeScalingParameters
operation. Specifies the name of the domain you want to describe.
See: newDescribeScalingParameters smart constructor.
Constructors
| DescribeScalingParameters' Text |
Instances
newDescribeScalingParameters Source #
Arguments
| :: Text | |
| -> DescribeScalingParameters |
Create a value of DescribeScalingParameters with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeScalingParameters, describeScalingParameters_domainName - Undocumented member.
data DescribeScalingParametersResponse Source #
The result of a DescribeScalingParameters request. Contains the
scaling parameters configured for the domain specified in the request.
See: newDescribeScalingParametersResponse smart constructor.
Instances
newDescribeScalingParametersResponse Source #
Arguments
| :: Int | |
| -> ScalingParametersStatus | |
| -> DescribeScalingParametersResponse |
Create a value of DescribeScalingParametersResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeScalingParametersResponse', describeScalingParametersResponse_httpStatus - The response's http status code.
$sel:scalingParameters:DescribeScalingParametersResponse', describeScalingParametersResponse_scalingParameters - Undocumented member.
DescribeServiceAccessPolicies
data DescribeServiceAccessPolicies Source #
Container for the parameters to the DescribeServiceAccessPolicies
operation. Specifies the name of the domain you want to describe. To
show the active configuration and exclude any pending changes, set the
Deployed option to true.
See: newDescribeServiceAccessPolicies smart constructor.
Constructors
| DescribeServiceAccessPolicies' (Maybe Bool) Text |
Instances
newDescribeServiceAccessPolicies Source #
Create a value of DescribeServiceAccessPolicies with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deployed:DescribeServiceAccessPolicies', describeServiceAccessPolicies_deployed - Whether to display the deployed configuration (true) or include any
pending changes (false). Defaults to false.
DescribeServiceAccessPolicies, describeServiceAccessPolicies_domainName - The name of the domain you want to describe.
data DescribeServiceAccessPoliciesResponse Source #
The result of a DescribeServiceAccessPolicies request.
See: newDescribeServiceAccessPoliciesResponse smart constructor.
Instances
newDescribeServiceAccessPoliciesResponse Source #
Arguments
| :: Int | |
| -> AccessPoliciesStatus | |
| -> DescribeServiceAccessPoliciesResponse |
Create a value of DescribeServiceAccessPoliciesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeServiceAccessPoliciesResponse', describeServiceAccessPoliciesResponse_httpStatus - The response's http status code.
$sel:accessPolicies:DescribeServiceAccessPoliciesResponse', describeServiceAccessPoliciesResponse_accessPolicies - The access rules configured for the domain specified in the request.
DescribeSuggesters
data DescribeSuggesters Source #
Container for the parameters to the DescribeSuggester operation.
Specifies the name of the domain you want to describe. To restrict the
response to particular suggesters, specify the names of the suggesters
you want to describe. To show the active configuration and exclude any
pending changes, set the Deployed option to true.
See: newDescribeSuggesters smart constructor.
Instances
newDescribeSuggesters Source #
Arguments
| :: Text | |
| -> DescribeSuggesters |
Create a value of DescribeSuggesters with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deployed:DescribeSuggesters', describeSuggesters_deployed - Whether to display the deployed configuration (true) or include any
pending changes (false). Defaults to false.
$sel:suggesterNames:DescribeSuggesters', describeSuggesters_suggesterNames - The suggesters you want to describe.
DescribeSuggesters, describeSuggesters_domainName - The name of the domain you want to describe.
data DescribeSuggestersResponse Source #
The result of a DescribeSuggesters request.
See: newDescribeSuggestersResponse smart constructor.
Constructors
| DescribeSuggestersResponse' Int [SuggesterStatus] |
Instances
newDescribeSuggestersResponse Source #
Create a value of DescribeSuggestersResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeSuggestersResponse', describeSuggestersResponse_httpStatus - The response's http status code.
$sel:suggesters:DescribeSuggestersResponse', describeSuggestersResponse_suggesters - The suggesters configured for the domain specified in the request.
IndexDocuments
data IndexDocuments Source #
Container for the parameters to the IndexDocuments operation.
Specifies the name of the domain you want to re-index.
See: newIndexDocuments smart constructor.
Constructors
| IndexDocuments' Text |
Instances
Arguments
| :: Text | |
| -> IndexDocuments |
Create a value of IndexDocuments with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
IndexDocuments, indexDocuments_domainName - Undocumented member.
data IndexDocumentsResponse Source #
The result of an IndexDocuments request. Contains the status of the
indexing operation, including the fields being indexed.
See: newIndexDocumentsResponse smart constructor.
Constructors
| IndexDocumentsResponse' (Maybe [Text]) Int |
Instances
newIndexDocumentsResponse Source #
Create a value of IndexDocumentsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fieldNames:IndexDocumentsResponse', indexDocumentsResponse_fieldNames - The names of the fields that are currently being indexed.
$sel:httpStatus:IndexDocumentsResponse', indexDocumentsResponse_httpStatus - The response's http status code.
ListDomainNames
data ListDomainNames Source #
See: newListDomainNames smart constructor.
Constructors
| ListDomainNames' | |
Instances
newListDomainNames :: ListDomainNames Source #
Create a value of ListDomainNames with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data ListDomainNamesResponse Source #
The result of a ListDomainNames request. Contains a list of the
domains owned by an account.
See: newListDomainNamesResponse smart constructor.
Instances
newListDomainNamesResponse Source #
Create a value of ListDomainNamesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domainNames:ListDomainNamesResponse', listDomainNamesResponse_domainNames - The names of the search domains owned by an account.
$sel:httpStatus:ListDomainNamesResponse', listDomainNamesResponse_httpStatus - The response's http status code.
UpdateAvailabilityOptions
data UpdateAvailabilityOptions Source #
Container for the parameters to the UpdateAvailabilityOptions
operation. Specifies the name of the domain you want to update and the
Multi-AZ availability option.
See: newUpdateAvailabilityOptions smart constructor.
Constructors
| UpdateAvailabilityOptions' Text Bool |
Instances
newUpdateAvailabilityOptions Source #
Arguments
| :: Text | |
| -> Bool | |
| -> UpdateAvailabilityOptions |
Create a value of UpdateAvailabilityOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateAvailabilityOptions, updateAvailabilityOptions_domainName - Undocumented member.
$sel:multiAZ:UpdateAvailabilityOptions', updateAvailabilityOptions_multiAZ - 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.
data UpdateAvailabilityOptionsResponse Source #
The result of a UpdateAvailabilityOptions request. Contains the status
of the domain's availability options.
See: newUpdateAvailabilityOptionsResponse smart constructor.
Constructors
| UpdateAvailabilityOptionsResponse' (Maybe AvailabilityOptionsStatus) Int |
Instances
newUpdateAvailabilityOptionsResponse Source #
Arguments
| :: Int | |
| -> UpdateAvailabilityOptionsResponse |
Create a value of UpdateAvailabilityOptionsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:availabilityOptions:UpdateAvailabilityOptionsResponse', updateAvailabilityOptionsResponse_availabilityOptions - The newly-configured availability options. Indicates whether Multi-AZ is
enabled for the domain.
$sel:httpStatus:UpdateAvailabilityOptionsResponse', updateAvailabilityOptionsResponse_httpStatus - The response's http status code.
UpdateDomainEndpointOptions
data UpdateDomainEndpointOptions Source #
Container for the parameters to the UpdateDomainEndpointOptions
operation. Specifies the name of the domain you want to update and the
domain endpoint options.
See: newUpdateDomainEndpointOptions smart constructor.
Constructors
| UpdateDomainEndpointOptions' Text DomainEndpointOptions |
Instances
newUpdateDomainEndpointOptions Source #
Arguments
| :: Text | |
| -> DomainEndpointOptions | |
| -> UpdateDomainEndpointOptions |
Create a value of UpdateDomainEndpointOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateDomainEndpointOptions, updateDomainEndpointOptions_domainName - A string that represents the name of a domain.
UpdateDomainEndpointOptions, updateDomainEndpointOptions_domainEndpointOptions - 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.
data UpdateDomainEndpointOptionsResponse Source #
The result of a UpdateDomainEndpointOptions request. Contains the
configuration and status of the domain's endpoint options.
See: newUpdateDomainEndpointOptionsResponse smart constructor.
Instances
newUpdateDomainEndpointOptionsResponse Source #
Arguments
| :: Int | |
| -> UpdateDomainEndpointOptionsResponse |
Create a value of UpdateDomainEndpointOptionsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateDomainEndpointOptions, updateDomainEndpointOptionsResponse_domainEndpointOptions - The newly-configured domain endpoint options.
$sel:httpStatus:UpdateDomainEndpointOptionsResponse', updateDomainEndpointOptionsResponse_httpStatus - The response's http status code.
UpdateScalingParameters
data UpdateScalingParameters Source #
Container for the parameters to the UpdateScalingParameters operation.
Specifies the name of the domain you want to update and the scaling
parameters you want to configure.
See: newUpdateScalingParameters smart constructor.
Constructors
| UpdateScalingParameters' Text ScalingParameters |
Instances
newUpdateScalingParameters Source #
Arguments
| :: Text | |
| -> ScalingParameters | |
| -> UpdateScalingParameters |
Create a value of UpdateScalingParameters with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateScalingParameters, updateScalingParameters_domainName - Undocumented member.
UpdateScalingParameters, updateScalingParameters_scalingParameters - Undocumented member.
data UpdateScalingParametersResponse Source #
The result of a UpdateScalingParameters request. Contains the status
of the newly-configured scaling parameters.
See: newUpdateScalingParametersResponse smart constructor.
Instances
newUpdateScalingParametersResponse Source #
Arguments
| :: Int | |
| -> ScalingParametersStatus | |
| -> UpdateScalingParametersResponse |
Create a value of UpdateScalingParametersResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateScalingParametersResponse', updateScalingParametersResponse_httpStatus - The response's http status code.
UpdateScalingParameters, updateScalingParametersResponse_scalingParameters - Undocumented member.
UpdateServiceAccessPolicies
data UpdateServiceAccessPolicies Source #
Container for the parameters to the UpdateServiceAccessPolicies
operation. Specifies the name of the domain you want to update and the
access rules you want to configure.
See: newUpdateServiceAccessPolicies smart constructor.
Constructors
| UpdateServiceAccessPolicies' Text Text |
Instances
newUpdateServiceAccessPolicies Source #
Arguments
| :: Text | |
| -> Text | |
| -> UpdateServiceAccessPolicies |
Create a value of UpdateServiceAccessPolicies with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateServiceAccessPolicies, updateServiceAccessPolicies_domainName - Undocumented member.
UpdateServiceAccessPolicies, updateServiceAccessPolicies_accessPolicies - The access rules you want to configure. These rules replace any existing
rules.
data UpdateServiceAccessPoliciesResponse Source #
The result of an UpdateServiceAccessPolicies request. Contains the new
access policies.
See: newUpdateServiceAccessPoliciesResponse smart constructor.
Instances
newUpdateServiceAccessPoliciesResponse Source #
Arguments
| :: Int | |
| -> AccessPoliciesStatus | |
| -> UpdateServiceAccessPoliciesResponse |
Create a value of UpdateServiceAccessPoliciesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateServiceAccessPoliciesResponse', updateServiceAccessPoliciesResponse_httpStatus - The response's http status code.
UpdateServiceAccessPolicies, updateServiceAccessPoliciesResponse_accessPolicies - The access rules configured for the domain.
Types
AlgorithmicStemming
newtype AlgorithmicStemming Source #
Constructors
| AlgorithmicStemming' | |
Fields | |
Bundled Patterns
| pattern AlgorithmicStemming_Full :: AlgorithmicStemming | |
| pattern AlgorithmicStemming_Light :: AlgorithmicStemming | |
| pattern AlgorithmicStemming_Minimal :: AlgorithmicStemming | |
| pattern AlgorithmicStemming_None :: AlgorithmicStemming |
Instances
AnalysisSchemeLanguage
newtype AnalysisSchemeLanguage Source #
An IETF RFC 4646 language code or
mul for multiple languages.
Constructors
| AnalysisSchemeLanguage' | |
Fields | |
Bundled Patterns
Instances
IndexFieldType
newtype IndexFieldType Source #
The type of field. The valid options for a field depend on the field type. For more information about the supported field types, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.
Constructors
| IndexFieldType' | |
Fields | |
Bundled Patterns
| pattern IndexFieldType_Date :: IndexFieldType | |
| pattern IndexFieldType_Date_array :: IndexFieldType | |
| pattern IndexFieldType_Double :: IndexFieldType | |
| pattern IndexFieldType_Double_array :: IndexFieldType | |
| pattern IndexFieldType_Int :: IndexFieldType | |
| pattern IndexFieldType_Int_array :: IndexFieldType | |
| pattern IndexFieldType_Latlon :: IndexFieldType | |
| pattern IndexFieldType_Literal :: IndexFieldType | |
| pattern IndexFieldType_Literal_array :: IndexFieldType | |
| pattern IndexFieldType_Text :: IndexFieldType | |
| pattern IndexFieldType_Text_array :: IndexFieldType |
Instances
OptionState
newtype OptionState Source #
The state of processing a change to an option. One of:
- 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 fully 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.
Constructors
| OptionState' | |
Fields | |
Bundled Patterns
| pattern OptionState_Active :: OptionState | |
| pattern OptionState_FailedToValidate :: OptionState | |
| pattern OptionState_Processing :: OptionState | |
| pattern OptionState_RequiresIndexDocuments :: OptionState |
Instances
PartitionInstanceType
newtype PartitionInstanceType Source #
The instance type (such as search.m1.small) on which an index
partition is hosted.
Constructors
| PartitionInstanceType' | |
Fields | |
Bundled Patterns
Instances
SuggesterFuzzyMatching
newtype SuggesterFuzzyMatching Source #
Constructors
| SuggesterFuzzyMatching' | |
Fields | |
Bundled Patterns
| pattern SuggesterFuzzyMatching_High :: SuggesterFuzzyMatching | |
| pattern SuggesterFuzzyMatching_Low :: SuggesterFuzzyMatching | |
| pattern SuggesterFuzzyMatching_None :: SuggesterFuzzyMatching |
Instances
TLSSecurityPolicy
newtype TLSSecurityPolicy Source #
The minimum required TLS version.
Constructors
| TLSSecurityPolicy' | |
Fields | |
Bundled Patterns
| pattern TLSSecurityPolicy_Policy_Min_TLS_1_0_2019_07 :: TLSSecurityPolicy | |
| pattern TLSSecurityPolicy_Policy_Min_TLS_1_2_2019_07 :: TLSSecurityPolicy |
Instances
AccessPoliciesStatus
data AccessPoliciesStatus Source #
The configured access rules for the domain's document and search endpoints, and the current status of those rules.
See: newAccessPoliciesStatus smart constructor.
Constructors
| AccessPoliciesStatus' Text OptionStatus |
Instances
newAccessPoliciesStatus Source #
Arguments
| :: Text | |
| -> OptionStatus | |
| -> AccessPoliciesStatus |
Create a value of AccessPoliciesStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:options:AccessPoliciesStatus', accessPoliciesStatus_options - Undocumented member.
$sel:status:AccessPoliciesStatus', accessPoliciesStatus_status - Undocumented member.
AnalysisOptions
data AnalysisOptions Source #
Synonyms, stopwords, and stemming options for an analysis scheme. Includes tokenization dictionary for Japanese.
See: newAnalysisOptions smart constructor.
Constructors
| AnalysisOptions' (Maybe AlgorithmicStemming) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newAnalysisOptions :: AnalysisOptions Source #
Create a value of AnalysisOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:algorithmicStemming:AnalysisOptions', analysisOptions_algorithmicStemming - 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
$sel:japaneseTokenizationDictionary:AnalysisOptions', analysisOptions_japaneseTokenizationDictionary - 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.
$sel:stemmingDictionary:AnalysisOptions', analysisOptions_stemmingDictionary - 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.
$sel:stopwords:AnalysisOptions', analysisOptions_stopwords - 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.
$sel:synonyms:AnalysisOptions', analysisOptions_synonyms - 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.
AnalysisScheme
data AnalysisScheme Source #
Configuration information for an analysis scheme. Each analysis scheme
has a unique name and specifies the language of the text to be
processed. The following options can be configured for an analysis
scheme: Synonyms, Stopwords, StemmingDictionary,
JapaneseTokenizationDictionary and AlgorithmicStemming.
See: newAnalysisScheme smart constructor.
Constructors
| AnalysisScheme' (Maybe AnalysisOptions) Text AnalysisSchemeLanguage |
Instances
Arguments
| :: Text | |
| -> AnalysisSchemeLanguage | |
| -> AnalysisScheme |
Create a value of AnalysisScheme with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:analysisOptions:AnalysisScheme', analysisScheme_analysisOptions - Undocumented member.
$sel:analysisSchemeName:AnalysisScheme', analysisScheme_analysisSchemeName - Undocumented member.
$sel:analysisSchemeLanguage:AnalysisScheme', analysisScheme_analysisSchemeLanguage - Undocumented member.
AnalysisSchemeStatus
data AnalysisSchemeStatus Source #
The status and configuration of an AnalysisScheme.
See: newAnalysisSchemeStatus smart constructor.
Constructors
| AnalysisSchemeStatus' AnalysisScheme OptionStatus |
Instances
newAnalysisSchemeStatus Source #
Arguments
| :: AnalysisScheme | |
| -> OptionStatus | |
| -> AnalysisSchemeStatus |
Create a value of AnalysisSchemeStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:options:AnalysisSchemeStatus', analysisSchemeStatus_options - Undocumented member.
$sel:status:AnalysisSchemeStatus', analysisSchemeStatus_status - Undocumented member.
AvailabilityOptionsStatus
data AvailabilityOptionsStatus Source #
The status and configuration of the domain's availability options.
See: newAvailabilityOptionsStatus smart constructor.
Constructors
| AvailabilityOptionsStatus' Bool OptionStatus |
Instances
newAvailabilityOptionsStatus Source #
Arguments
| :: Bool | |
| -> OptionStatus | |
| -> AvailabilityOptionsStatus |
Create a value of AvailabilityOptionsStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:options:AvailabilityOptionsStatus', availabilityOptionsStatus_options - The availability options configured for the domain.
$sel:status:AvailabilityOptionsStatus', availabilityOptionsStatus_status - Undocumented member.
DateArrayOptions
data DateArrayOptions Source #
Options for a field that contains an array of dates. Present if
IndexFieldType specifies the field is of type date-array. All
options are enabled by default.
See: newDateArrayOptions smart constructor.
Instances
newDateArrayOptions :: DateArrayOptions Source #
Create a value of DateArrayOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:defaultValue:DateArrayOptions', dateArrayOptions_defaultValue - A value to use for the field if the field isn't specified for a
document.
$sel:facetEnabled:DateArrayOptions', dateArrayOptions_facetEnabled - Whether facet information can be returned for the field.
$sel:returnEnabled:DateArrayOptions', dateArrayOptions_returnEnabled - Whether the contents of the field can be returned in the search results.
$sel:searchEnabled:DateArrayOptions', dateArrayOptions_searchEnabled - Whether the contents of the field are searchable.
$sel:sourceFields:DateArrayOptions', dateArrayOptions_sourceFields - A list of source fields to map to the field.
DateOptions
data DateOptions Source #
Options for a date field. Dates and times are specified in UTC
(Coordinated Universal Time) according to IETF RFC3339:
yyyy-mm-ddT00:00:00Z. Present if IndexFieldType specifies the field is
of type date. All options are enabled by default.
See: newDateOptions smart constructor.
Constructors
| DateOptions' (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text) |
Instances
newDateOptions :: DateOptions Source #
Create a value of DateOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:defaultValue:DateOptions', dateOptions_defaultValue - A value to use for the field if the field isn't specified for a
document.
$sel:facetEnabled:DateOptions', dateOptions_facetEnabled - Whether facet information can be returned for the field.
$sel:returnEnabled:DateOptions', dateOptions_returnEnabled - Whether the contents of the field can be returned in the search results.
$sel:searchEnabled:DateOptions', dateOptions_searchEnabled - Whether the contents of the field are searchable.
$sel:sortEnabled:DateOptions', dateOptions_sortEnabled - Whether the field can be used to sort the search results.
$sel:sourceField:DateOptions', dateOptions_sourceField - Undocumented member.
DocumentSuggesterOptions
data DocumentSuggesterOptions Source #
Options for a search suggester.
See: newDocumentSuggesterOptions smart constructor.
Constructors
| DocumentSuggesterOptions' (Maybe SuggesterFuzzyMatching) (Maybe Text) Text |
Instances
newDocumentSuggesterOptions Source #
Create a value of DocumentSuggesterOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fuzzyMatching:DocumentSuggesterOptions', documentSuggesterOptions_fuzzyMatching - 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.
$sel:sortExpression:DocumentSuggesterOptions', documentSuggesterOptions_sortExpression - 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.
$sel:sourceField:DocumentSuggesterOptions', documentSuggesterOptions_sourceField - The name of the index field you want to use for suggestions.
DomainEndpointOptions
data DomainEndpointOptions Source #
The domain's endpoint options.
See: newDomainEndpointOptions smart constructor.
Constructors
| DomainEndpointOptions' (Maybe Bool) (Maybe TLSSecurityPolicy) |
Instances
newDomainEndpointOptions :: DomainEndpointOptions Source #
Create a value of DomainEndpointOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:enforceHTTPS:DomainEndpointOptions', domainEndpointOptions_enforceHTTPS - Whether the domain is HTTPS only enabled.
$sel:tLSSecurityPolicy:DomainEndpointOptions', domainEndpointOptions_tLSSecurityPolicy - The minimum required TLS version
DomainEndpointOptionsStatus
data DomainEndpointOptionsStatus Source #
The configuration and status of the domain's endpoint options.
See: newDomainEndpointOptionsStatus smart constructor.
Instances
newDomainEndpointOptionsStatus Source #
Arguments
| :: DomainEndpointOptions | |
| -> OptionStatus | |
| -> DomainEndpointOptionsStatus |
Create a value of DomainEndpointOptionsStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:options:DomainEndpointOptionsStatus', domainEndpointOptionsStatus_options - The domain endpoint options configured for the domain.
$sel:status:DomainEndpointOptionsStatus', domainEndpointOptionsStatus_status - The status of the configured domain endpoint options.
DomainStatus
data DomainStatus Source #
The current status of the search domain.
See: newDomainStatus smart constructor.
Constructors
| DomainStatus' (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe ServiceEndpoint) (Maybe Limits) (Maybe Bool) (Maybe Natural) (Maybe Text) (Maybe Natural) (Maybe ServiceEndpoint) Text Text Bool |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Bool | |
| -> DomainStatus |
Create a value of DomainStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:DomainStatus', domainStatus_arn - Undocumented member.
$sel:created:DomainStatus', domainStatus_created - 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.
$sel:deleted:DomainStatus', domainStatus_deleted - 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.
$sel:docService:DomainStatus', domainStatus_docService - The service endpoint for updating documents in a search domain.
$sel:limits:DomainStatus', domainStatus_limits - Undocumented member.
$sel:processing:DomainStatus', domainStatus_processing - True if processing is being done to activate the current domain
configuration.
$sel:searchInstanceCount:DomainStatus', domainStatus_searchInstanceCount - The number of search instances that are available to process search
requests.
$sel:searchInstanceType:DomainStatus', domainStatus_searchInstanceType - The instance type that is being used to process search requests.
$sel:searchPartitionCount:DomainStatus', domainStatus_searchPartitionCount - The number of partitions across which the search index is spread.
$sel:searchService:DomainStatus', domainStatus_searchService - The service endpoint for requesting search results from a search domain.
$sel:domainId:DomainStatus', domainStatus_domainId - Undocumented member.
$sel:domainName:DomainStatus', domainStatus_domainName - Undocumented member.
$sel:requiresIndexDocuments:DomainStatus', domainStatus_requiresIndexDocuments - True if IndexDocuments needs to be called to activate the current domain
configuration.
DoubleArrayOptions
data DoubleArrayOptions Source #
Options for a field that contains an array of double-precision 64-bit
floating point values. Present if IndexFieldType specifies the field
is of type double-array. All options are enabled by default.
See: newDoubleArrayOptions smart constructor.
Instances
newDoubleArrayOptions :: DoubleArrayOptions Source #
Create a value of DoubleArrayOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:defaultValue:DoubleArrayOptions', doubleArrayOptions_defaultValue - A value to use for the field if the field isn't specified for a
document.
$sel:facetEnabled:DoubleArrayOptions', doubleArrayOptions_facetEnabled - Whether facet information can be returned for the field.
$sel:returnEnabled:DoubleArrayOptions', doubleArrayOptions_returnEnabled - Whether the contents of the field can be returned in the search results.
$sel:searchEnabled:DoubleArrayOptions', doubleArrayOptions_searchEnabled - Whether the contents of the field are searchable.
$sel:sourceFields:DoubleArrayOptions', doubleArrayOptions_sourceFields - A list of source fields to map to the field.
DoubleOptions
data DoubleOptions Source #
Options for a double-precision 64-bit floating point field. Present if
IndexFieldType specifies the field is of type double. All options
are enabled by default.
See: newDoubleOptions smart constructor.
Constructors
| DoubleOptions' (Maybe Double) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text) |
Instances
newDoubleOptions :: DoubleOptions Source #
Create a value of DoubleOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:defaultValue:DoubleOptions', doubleOptions_defaultValue - 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.
$sel:facetEnabled:DoubleOptions', doubleOptions_facetEnabled - Whether facet information can be returned for the field.
$sel:returnEnabled:DoubleOptions', doubleOptions_returnEnabled - Whether the contents of the field can be returned in the search results.
$sel:searchEnabled:DoubleOptions', doubleOptions_searchEnabled - Whether the contents of the field are searchable.
$sel:sortEnabled:DoubleOptions', doubleOptions_sortEnabled - Whether the field can be used to sort the search results.
$sel:sourceField:DoubleOptions', doubleOptions_sourceField - The name of the source field to map to the field.
Expression
data Expression Source #
A named expression that can be evaluated at search time. Can be used to sort the search results, define other expressions, or return computed information in the search results.
See: newExpression smart constructor.
Constructors
| Expression' Text Text |
Instances
Create a value of Expression with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expressionName:Expression', expression_expressionName - Undocumented member.
$sel:expressionValue:Expression', expression_expressionValue - Undocumented member.
ExpressionStatus
data ExpressionStatus Source #
The value of an Expression and its current status.
See: newExpressionStatus smart constructor.
Constructors
| ExpressionStatus' Expression OptionStatus |
Instances
Arguments
| :: Expression | |
| -> OptionStatus | |
| -> ExpressionStatus |
Create a value of ExpressionStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:options:ExpressionStatus', expressionStatus_options - The expression that is evaluated for sorting while processing a search
request.
$sel:status:ExpressionStatus', expressionStatus_status - Undocumented member.
IndexField
data IndexField Source #
Configuration information for a field in the index, including its name,
type, and options. The supported options depend on the IndexFieldType.
See: newIndexField smart constructor.
Constructors
Instances
Arguments
| :: Text | |
| -> IndexFieldType | |
| -> IndexField |
Create a value of IndexField with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dateArrayOptions:IndexField', indexField_dateArrayOptions - Undocumented member.
$sel:dateOptions:IndexField', indexField_dateOptions - Undocumented member.
$sel:doubleArrayOptions:IndexField', indexField_doubleArrayOptions - Undocumented member.
$sel:doubleOptions:IndexField', indexField_doubleOptions - Undocumented member.
$sel:intArrayOptions:IndexField', indexField_intArrayOptions - Undocumented member.
$sel:intOptions:IndexField', indexField_intOptions - Undocumented member.
$sel:latLonOptions:IndexField', indexField_latLonOptions - Undocumented member.
$sel:literalArrayOptions:IndexField', indexField_literalArrayOptions - Undocumented member.
$sel:literalOptions:IndexField', indexField_literalOptions - Undocumented member.
$sel:textArrayOptions:IndexField', indexField_textArrayOptions - Undocumented member.
$sel:textOptions:IndexField', indexField_textOptions - Undocumented member.
$sel:indexFieldName:IndexField', indexField_indexFieldName - 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.
$sel:indexFieldType:IndexField', indexField_indexFieldType - Undocumented member.
IndexFieldStatus
data IndexFieldStatus Source #
The value of an IndexField and its current status.
See: newIndexFieldStatus smart constructor.
Constructors
| IndexFieldStatus' IndexField OptionStatus |
Instances
Arguments
| :: IndexField | |
| -> OptionStatus | |
| -> IndexFieldStatus |
Create a value of IndexFieldStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:options:IndexFieldStatus', indexFieldStatus_options - Undocumented member.
$sel:status:IndexFieldStatus', indexFieldStatus_status - Undocumented member.
IntArrayOptions
data IntArrayOptions Source #
Options for a field that contains an array of 64-bit signed integers.
Present if IndexFieldType specifies the field is of type int-array.
All options are enabled by default.
See: newIntArrayOptions smart constructor.
Instances
newIntArrayOptions :: IntArrayOptions Source #
Create a value of IntArrayOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:defaultValue:IntArrayOptions', intArrayOptions_defaultValue - A value to use for the field if the field isn't specified for a
document.
$sel:facetEnabled:IntArrayOptions', intArrayOptions_facetEnabled - Whether facet information can be returned for the field.
$sel:returnEnabled:IntArrayOptions', intArrayOptions_returnEnabled - Whether the contents of the field can be returned in the search results.
$sel:searchEnabled:IntArrayOptions', intArrayOptions_searchEnabled - Whether the contents of the field are searchable.
$sel:sourceFields:IntArrayOptions', intArrayOptions_sourceFields - A list of source fields to map to the field.
IntOptions
data IntOptions Source #
Options for a 64-bit signed integer field. Present if IndexFieldType
specifies the field is of type int. All options are enabled by
default.
See: newIntOptions smart constructor.
Constructors
| IntOptions' (Maybe Integer) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text) |
Instances
newIntOptions :: IntOptions Source #
Create a value of IntOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:defaultValue:IntOptions', intOptions_defaultValue - 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.
$sel:facetEnabled:IntOptions', intOptions_facetEnabled - Whether facet information can be returned for the field.
$sel:returnEnabled:IntOptions', intOptions_returnEnabled - Whether the contents of the field can be returned in the search results.
$sel:searchEnabled:IntOptions', intOptions_searchEnabled - Whether the contents of the field are searchable.
$sel:sortEnabled:IntOptions', intOptions_sortEnabled - Whether the field can be used to sort the search results.
$sel:sourceField:IntOptions', intOptions_sourceField - The name of the source field to map to the field.
LatLonOptions
data LatLonOptions Source #
Options for a latlon field. A latlon field contains a location stored as
a latitude and longitude value pair. Present if IndexFieldType
specifies the field is of type latlon. All options are enabled by
default.
See: newLatLonOptions smart constructor.
Constructors
| LatLonOptions' (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text) |
Instances
newLatLonOptions :: LatLonOptions Source #
Create a value of LatLonOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:defaultValue:LatLonOptions', latLonOptions_defaultValue - A value to use for the field if the field isn't specified for a
document.
$sel:facetEnabled:LatLonOptions', latLonOptions_facetEnabled - Whether facet information can be returned for the field.
$sel:returnEnabled:LatLonOptions', latLonOptions_returnEnabled - Whether the contents of the field can be returned in the search results.
$sel:searchEnabled:LatLonOptions', latLonOptions_searchEnabled - Whether the contents of the field are searchable.
$sel:sortEnabled:LatLonOptions', latLonOptions_sortEnabled - Whether the field can be used to sort the search results.
$sel:sourceField:LatLonOptions', latLonOptions_sourceField - Undocumented member.
Limits
See: newLimits smart constructor.
Instances
| FromXML Limits Source # | |
| Generic Limits Source # | |
| Read Limits Source # | |
| Show Limits Source # | |
| NFData Limits Source # | |
Defined in Amazonka.CloudSearch.Types.Limits | |
| Eq Limits Source # | |
| Hashable Limits Source # | |
Defined in Amazonka.CloudSearch.Types.Limits | |
| type Rep Limits Source # | |
Defined in Amazonka.CloudSearch.Types.Limits type Rep Limits = D1 ('MetaData "Limits" "Amazonka.CloudSearch.Types.Limits" "amazonka-cloudsearch-2.0-A2SXRDW2ivUDvdOgQgoVJQ" 'False) (C1 ('MetaCons "Limits'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maximumReplicationCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural) :*: S1 ('MetaSel ('Just "maximumPartitionCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural))) | |
Create a value of Limits with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maximumReplicationCount:Limits', limits_maximumReplicationCount - Undocumented member.
$sel:maximumPartitionCount:Limits', limits_maximumPartitionCount - Undocumented member.
LiteralArrayOptions
data LiteralArrayOptions Source #
Options for a field that contains an array of literal strings. Present
if IndexFieldType specifies the field is of type literal-array. All
options are enabled by default.
See: newLiteralArrayOptions smart constructor.
Instances
newLiteralArrayOptions :: LiteralArrayOptions Source #
Create a value of LiteralArrayOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:defaultValue:LiteralArrayOptions', literalArrayOptions_defaultValue - A value to use for the field if the field isn't specified for a
document.
$sel:facetEnabled:LiteralArrayOptions', literalArrayOptions_facetEnabled - Whether facet information can be returned for the field.
$sel:returnEnabled:LiteralArrayOptions', literalArrayOptions_returnEnabled - Whether the contents of the field can be returned in the search results.
$sel:searchEnabled:LiteralArrayOptions', literalArrayOptions_searchEnabled - Whether the contents of the field are searchable.
$sel:sourceFields:LiteralArrayOptions', literalArrayOptions_sourceFields - A list of source fields to map to the field.
LiteralOptions
data LiteralOptions Source #
Options for literal field. Present if IndexFieldType specifies the
field is of type literal. All options are enabled by default.
See: newLiteralOptions smart constructor.
Constructors
| LiteralOptions' (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text) |
Instances
newLiteralOptions :: LiteralOptions Source #
Create a value of LiteralOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:defaultValue:LiteralOptions', literalOptions_defaultValue - A value to use for the field if the field isn't specified for a
document.
$sel:facetEnabled:LiteralOptions', literalOptions_facetEnabled - Whether facet information can be returned for the field.
$sel:returnEnabled:LiteralOptions', literalOptions_returnEnabled - Whether the contents of the field can be returned in the search results.
$sel:searchEnabled:LiteralOptions', literalOptions_searchEnabled - Whether the contents of the field are searchable.
$sel:sortEnabled:LiteralOptions', literalOptions_sortEnabled - Whether the field can be used to sort the search results.
$sel:sourceField:LiteralOptions', literalOptions_sourceField - Undocumented member.
OptionStatus
data OptionStatus Source #
The status of domain configuration option.
See: newOptionStatus smart constructor.
Constructors
| OptionStatus' (Maybe Bool) (Maybe Natural) ISO8601 ISO8601 OptionState |
Instances
Arguments
| :: UTCTime | |
| -> UTCTime | |
| -> OptionState | |
| -> OptionStatus |
Create a value of OptionStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pendingDeletion:OptionStatus', optionStatus_pendingDeletion - Indicates that the option will be deleted once processing is complete.
$sel:updateVersion:OptionStatus', optionStatus_updateVersion - A unique integer that indicates when this option was last updated.
$sel:creationDate:OptionStatus', optionStatus_creationDate - A timestamp for when this option was created.
$sel:updateDate:OptionStatus', optionStatus_updateDate - A timestamp for when this option was last updated.
$sel:state:OptionStatus', optionStatus_state - 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
data ScalingParameters Source #
The desired instance type and desired number of replicas of each index partition.
See: newScalingParameters smart constructor.
Constructors
| ScalingParameters' (Maybe PartitionInstanceType) (Maybe Natural) (Maybe Natural) |
Instances
newScalingParameters :: ScalingParameters Source #
Create a value of ScalingParameters with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:desiredInstanceType:ScalingParameters', scalingParameters_desiredInstanceType - The instance type that you want to preconfigure for your domain. For
example, search.m1.small.
$sel:desiredPartitionCount:ScalingParameters', scalingParameters_desiredPartitionCount - The number of partitions you want to preconfigure for your domain. Only
valid when you select m2.2xlarge as the desired instance type.
$sel:desiredReplicationCount:ScalingParameters', scalingParameters_desiredReplicationCount - The number of replicas you want to preconfigure for each index
partition.
ScalingParametersStatus
data ScalingParametersStatus Source #
The status and configuration of a search domain's scaling parameters.
See: newScalingParametersStatus smart constructor.
Constructors
| ScalingParametersStatus' ScalingParameters OptionStatus |
Instances
newScalingParametersStatus Source #
Arguments
| :: ScalingParameters | |
| -> OptionStatus | |
| -> ScalingParametersStatus |
Create a value of ScalingParametersStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:options:ScalingParametersStatus', scalingParametersStatus_options - Undocumented member.
$sel:status:ScalingParametersStatus', scalingParametersStatus_status - Undocumented member.
ServiceEndpoint
data ServiceEndpoint Source #
The endpoint to which service requests can be submitted.
See: newServiceEndpoint smart constructor.
Constructors
| ServiceEndpoint' (Maybe Text) |
Instances
newServiceEndpoint :: ServiceEndpoint Source #
Create a value of ServiceEndpoint with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endpoint:ServiceEndpoint', serviceEndpoint_endpoint - Undocumented member.
Suggester
Configuration information for a search suggester. Each suggester has a
unique name and specifies the text field you want to use for
suggestions. The following options can be configured for a suggester:
FuzzyMatching, SortExpression.
See: newSuggester smart constructor.
Constructors
| Suggester' Text DocumentSuggesterOptions |
Instances
| ToQuery Suggester Source # | |
Defined in Amazonka.CloudSearch.Types.Suggester Methods toQuery :: Suggester -> QueryString # | |
| FromXML Suggester Source # | |
| Generic Suggester Source # | |
| Read Suggester Source # | |
| Show Suggester Source # | |
| NFData Suggester Source # | |
Defined in Amazonka.CloudSearch.Types.Suggester | |
| Eq Suggester Source # | |
| Hashable Suggester Source # | |
Defined in Amazonka.CloudSearch.Types.Suggester | |
| type Rep Suggester Source # | |
Defined in Amazonka.CloudSearch.Types.Suggester type Rep Suggester = D1 ('MetaData "Suggester" "Amazonka.CloudSearch.Types.Suggester" "amazonka-cloudsearch-2.0-A2SXRDW2ivUDvdOgQgoVJQ" 'False) (C1 ('MetaCons "Suggester'" 'PrefixI 'True) (S1 ('MetaSel ('Just "suggesterName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "documentSuggesterOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DocumentSuggesterOptions))) | |
Arguments
| :: Text | |
| -> DocumentSuggesterOptions | |
| -> Suggester |
Create a value of Suggester with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:suggesterName:Suggester', suggester_suggesterName - Undocumented member.
$sel:documentSuggesterOptions:Suggester', suggester_documentSuggesterOptions - Undocumented member.
SuggesterStatus
data SuggesterStatus Source #
The value of a Suggester and its current status.
See: newSuggesterStatus smart constructor.
Constructors
| SuggesterStatus' Suggester OptionStatus |
Instances
Arguments
| :: Suggester | |
| -> OptionStatus | |
| -> SuggesterStatus |
Create a value of SuggesterStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:options:SuggesterStatus', suggesterStatus_options - Undocumented member.
$sel:status:SuggesterStatus', suggesterStatus_status - Undocumented member.
TextArrayOptions
data TextArrayOptions Source #
Options for a field that contains an array of text strings. Present if
IndexFieldType specifies the field is of type text-array. A
text-array field is always searchable. All options are enabled by
default.
See: newTextArrayOptions smart constructor.
Instances
newTextArrayOptions :: TextArrayOptions Source #
Create a value of TextArrayOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:analysisScheme:TextArrayOptions', textArrayOptions_analysisScheme - The name of an analysis scheme for a text-array field.
$sel:defaultValue:TextArrayOptions', textArrayOptions_defaultValue - A value to use for the field if the field isn't specified for a
document.
$sel:highlightEnabled:TextArrayOptions', textArrayOptions_highlightEnabled - Whether highlights can be returned for the field.
$sel:returnEnabled:TextArrayOptions', textArrayOptions_returnEnabled - Whether the contents of the field can be returned in the search results.
$sel:sourceFields:TextArrayOptions', textArrayOptions_sourceFields - A list of source fields to map to the field.
TextOptions
data TextOptions Source #
Options for text field. Present if IndexFieldType specifies the field
is of type text. A text field is always searchable. All options are
enabled by default.
See: newTextOptions smart constructor.
Constructors
| TextOptions' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text) |
Instances
newTextOptions :: TextOptions Source #
Create a value of TextOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:analysisScheme:TextOptions', textOptions_analysisScheme - The name of an analysis scheme for a text field.
$sel:defaultValue:TextOptions', textOptions_defaultValue - A value to use for the field if the field isn't specified for a
document.
$sel:highlightEnabled:TextOptions', textOptions_highlightEnabled - Whether highlights can be returned for the field.
$sel:returnEnabled:TextOptions', textOptions_returnEnabled - Whether the contents of the field can be returned in the search results.
$sel:sortEnabled:TextOptions', textOptions_sortEnabled - Whether the field can be used to sort the search results.
$sel:sourceField:TextOptions', textOptions_sourceField - Undocumented member.