listMedicalVocabularies method

Future<ListMedicalVocabulariesResponse> listMedicalVocabularies({ int? maxResults, String? nameContains, String? nextToken, VocabularyState? stateEquals, })

Returns a list of vocabularies that match the specified criteria. If you don't enter a value in any of the request parameters, returns the entire list of vocabularies.

May throw BadRequestException. May throw LimitExceededException. May throw InternalFailureException.

Parameter maxResults : The maximum number of vocabularies to return in the response.

Parameter nameContains : Returns vocabularies whose names contain the specified string. The search is not case sensitive. ListMedicalVocabularies returns both "vocabularyname" and "VocabularyName".

Parameter nextToken : If the result of your previous request to ListMedicalVocabularies was truncated, include the NextToken to fetch the next set of vocabularies.

Parameter stateEquals : When specified, returns only vocabularies with the VocabularyState equal to the specified vocabulary state. Use this field to see which vocabularies are ready for your medical transcription jobs.

Implementation

Future<ListMedicalVocabulariesResponse> listMedicalVocabularies({
  int? maxResults,
  String? nameContains,
  String? nextToken,
  VocabularyState? stateEquals,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    100,
  );
  _s.validateStringLength(
    'nameContains',
    nameContains,
    1,
    200,
  );
  _s.validateStringLength(
    'nextToken',
    nextToken,
    0,
    8192,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'Transcribe.ListMedicalVocabularies'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      if (maxResults != null) 'MaxResults': maxResults,
      if (nameContains != null) 'NameContains': nameContains,
      if (nextToken != null) 'NextToken': nextToken,
      if (stateEquals != null) 'StateEquals': stateEquals.toValue(),
    },
  );

  return ListMedicalVocabulariesResponse.fromJson(jsonResponse.body);
}