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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-transcribeservice/types.rb

Overview

Note:

When making an API call, you may pass ListMedicalVocabulariesRequest data as a hash:

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#max_resultsInteger

The maximum number of vocabularies to return in the response.

Returns:

  • (Integer)

1163
1164
1165
1166
1167
1168
1169
1170
# File 'lib/aws-sdk-transcribeservice/types.rb', line 1163

class ListMedicalVocabulariesRequest < Struct.new(
  :next_token,
  :max_results,
  :state_equals,
  :name_contains)
  SENSITIVE = []
  include Aws::Structure
end

#name_containsString

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

Returns:

  • (String)

1163
1164
1165
1166
1167
1168
1169
1170
# File 'lib/aws-sdk-transcribeservice/types.rb', line 1163

class ListMedicalVocabulariesRequest < Struct.new(
  :next_token,
  :max_results,
  :state_equals,
  :name_contains)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)

1163
1164
1165
1166
1167
1168
1169
1170
# File 'lib/aws-sdk-transcribeservice/types.rb', line 1163

class ListMedicalVocabulariesRequest < Struct.new(
  :next_token,
  :max_results,
  :state_equals,
  :name_contains)
  SENSITIVE = []
  include Aws::Structure
end

#state_equalsString

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.

Returns:

  • (String)

1163
1164
1165
1166
1167
1168
1169
1170
# File 'lib/aws-sdk-transcribeservice/types.rb', line 1163

class ListMedicalVocabulariesRequest < Struct.new(
  :next_token,
  :max_results,
  :state_equals,
  :name_contains)
  SENSITIVE = []
  include Aws::Structure
end