describeExpressions method

Future<DescribeExpressionsResponse> describeExpressions({ required String domainName, bool? deployed, List<String>? expressionNames, })

Gets the expressions configured for the search domain. Can be limited to specific expressions by name. By default, shows all expressions 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 Expressions 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 deployed : Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

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

Implementation

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