You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::TranscribeService::Types::ListMedicalVocabulariesRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListMedicalVocabulariesRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  next_token: "NextToken",
  max_results: 1,
  state_equals: "PENDING", # accepts PENDING, READY, FAILED
  name_contains: "VocabularyName",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#max_results ⇒ Integer

The maximum number of vocabularies to return in the response.

Returns:

  • (Integer) —

    The maximum number of vocabularies to return in the response.

#name_contains ⇒ String

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

Returns:

  • (String) —

    Returns vocabularies whose names contain the specified string.

#next_token ⇒ String

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

Returns:

  • (String) —

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

#state_equals ⇒ String

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.

Possible values:

  • PENDING
  • READY
  • FAILED

Returns:

  • (String) —

    When specified, returns only vocabularies with the VocabularyState equal to the specified vocabulary state.