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

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 ListVocabulariesRequest 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. If there are fewer results in the list, this response contains only the actual results.

Returns:

  • (Integer)

1307
1308
1309
1310
1311
1312
1313
1314
# File 'lib/aws-sdk-transcribeservice/types.rb', line 1307

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

#name_containsString

When specified, the vocabularies returned in the list are limited to vocabularies whose name contains the specified string. The search is not case sensitive, `ListVocabularies` returns both “vocabularyname” and “VocabularyName” in the response list.

Returns:

  • (String)

1307
1308
1309
1310
1311
1312
1313
1314
# File 'lib/aws-sdk-transcribeservice/types.rb', line 1307

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

#next_tokenString

If the result of the previous request to `ListVocabularies` was truncated, include the `NextToken` to fetch the next set of jobs.

Returns:

  • (String)

1307
1308
1309
1310
1311
1312
1313
1314
# File 'lib/aws-sdk-transcribeservice/types.rb', line 1307

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

#state_equalsString

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

Returns:

  • (String)

1307
1308
1309
1310
1311
1312
1313
1314
# File 'lib/aws-sdk-transcribeservice/types.rb', line 1307

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