describeAnalysisSchemes method

Future<DescribeAnalysisSchemesResponse> describeAnalysisSchemes({ required String domainName, List<String>? analysisSchemeNames, bool? deployed, })

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.

May throw BaseException. May throw InternalException. May throw ResourceNotFoundException.

Parameter domainName : The name of the domain you want to describe.

Parameter analysisSchemeNames : The analysis schemes you want to describe.

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

Implementation

Future<DescribeAnalysisSchemesResponse> describeAnalysisSchemes({
  required String domainName,
  List<String>? analysisSchemeNames,
  bool? deployed,
}) async {
  ArgumentError.checkNotNull(domainName, 'domainName');
  _s.validateStringLength(
    'domainName',
    domainName,
    3,
    28,
    isRequired: true,
  );
  final $request = <String, dynamic>{};
  $request['DomainName'] = domainName;
  analysisSchemeNames?.also((arg) => $request['AnalysisSchemeNames'] = arg);
  deployed?.also((arg) => $request['Deployed'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'DescribeAnalysisSchemes',
    version: '2013-01-01',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DescribeAnalysisSchemesRequest'],
    shapes: shapes,
    resultWrapper: 'DescribeAnalysisSchemesResult',
  );
  return DescribeAnalysisSchemesResponse.fromXml($result);
}