describeIndexFields method

Future<DescribeIndexFieldsResponse> describeIndexFields({ required String domainName, bool? deployed, List<String>? fieldNames, })

Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. By default, shows all fields 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 Getting Domain Information 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 fieldNames : A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.

Implementation

Future<DescribeIndexFieldsResponse> describeIndexFields({
  required String domainName,
  bool? deployed,
  List<String>? fieldNames,
}) 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);
  fieldNames?.also((arg) => $request['FieldNames'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'DescribeIndexFields',
    version: '2013-01-01',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DescribeIndexFieldsRequest'],
    shapes: shapes,
    resultWrapper: 'DescribeIndexFieldsResult',
  );
  return DescribeIndexFieldsResponse.fromXml($result);
}