Class: Aws::TranscribeService::Types::ListVocabulariesRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#max_results ⇒ Integer

The maximum number of custom vocabularies to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you don’t specify a value, a default of 5 is used.

Returns:

  • (Integer) 


2410
2411
2412
2413
2414
2415
2416
2417
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2410

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

#name_contains ⇒ String

Returns only the custom vocabularies that contain the specified string. The search is not case sensitive.

Returns:

  • (String) 


2410
2411
2412
2413
2414
2415
2416
2417
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2410

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

#next_token ⇒ String

If your ‘ListVocabularies` request returns more results than can be displayed, `NextToken` is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including `NextToken` with the value of the copied string. Repeat as needed to view all your results.

Returns:

  • (String) 


2410
2411
2412
2413
2414
2415
2416
2417
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2410

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

#state_equals ⇒ String

Returns only custom vocabularies with the specified state. Vocabularies are ordered by creation date, with the newest vocabulary first. If you don’t include ‘StateEquals`, all custom medical vocabularies are returned.

Returns:

  • (String) 


2410
2411
2412
2413
2414
2415
2416
2417
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2410

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