Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Network.AWS.CloudSearch.DescribeAnalysisSchemes
Description
Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific text processing options for a text
field. Can be limited to specific analysis schemes by name. By default, shows all analysis schemes and includes any pending changes to the configuration. Set the Deployed
option to true
to show the active configuration and exclude pending changes. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide .
- describeAnalysisSchemes :: Text -> DescribeAnalysisSchemes
- data DescribeAnalysisSchemes
- dassDeployed :: Lens' DescribeAnalysisSchemes (Maybe Bool)
- dassAnalysisSchemeNames :: Lens' DescribeAnalysisSchemes [Text]
- dassDomainName :: Lens' DescribeAnalysisSchemes Text
- describeAnalysisSchemesResponse :: Int -> DescribeAnalysisSchemesResponse
- data DescribeAnalysisSchemesResponse
- dasrsResponseStatus :: Lens' DescribeAnalysisSchemesResponse Int
- dasrsAnalysisSchemes :: Lens' DescribeAnalysisSchemesResponse [AnalysisSchemeStatus]
Creating a Request
Arguments
:: Text | |
-> DescribeAnalysisSchemes |
Creates a value of DescribeAnalysisSchemes
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dassDeployed
- Whether to display the deployed configuration (true
) or include any pending changes (false
). Defaults tofalse
.dassAnalysisSchemeNames
- The analysis schemes you want to describe.dassDomainName
- The name of the domain you want to describe.
data DescribeAnalysisSchemes #
Container for the parameters to the
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 DescribeAnalysisSchemes
Deployed
option to true
.
See: describeAnalysisSchemes
smart constructor.
Instances
Request Lenses
dassDeployed :: Lens' DescribeAnalysisSchemes (Maybe Bool) #
Whether to display the deployed configuration (true
) or include any pending changes (false
). Defaults to false
.
dassAnalysisSchemeNames :: Lens' DescribeAnalysisSchemes [Text] #
The analysis schemes you want to describe.
dassDomainName :: Lens' DescribeAnalysisSchemes Text #
The name of the domain you want to describe.
Destructuring the Response
describeAnalysisSchemesResponse #
Arguments
:: Int | |
-> DescribeAnalysisSchemesResponse |
Creates a value of DescribeAnalysisSchemesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dasrsResponseStatus
- -- | The response status code.dasrsAnalysisSchemes
- The analysis scheme descriptions.
data DescribeAnalysisSchemesResponse #
The result of a DescribeAnalysisSchemes
request. Contains the analysis schemes configured for the domain specified in the request.
See: describeAnalysisSchemesResponse
smart constructor.
Response Lenses
dasrsResponseStatus :: Lens' DescribeAnalysisSchemesResponse Int #
- - | The response status code.
dasrsAnalysisSchemes :: Lens' DescribeAnalysisSchemesResponse [AnalysisSchemeStatus] #
The analysis scheme descriptions.