You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::TranscribeService::Types::ListVocabulariesRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::TranscribeService::Types::ListVocabulariesRequest
- Defined in:
- (unknown)
Overview
When passing ListVocabulariesRequest 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",
}
Instance Attribute Summary collapse
-
#max_results ⇒ Integer
The maximum number of vocabularies to return in the response.
-
#name_contains ⇒ String
When specified, the vocabularies returned in the list are limited to vocabularies whose name contains the specified string.
-
#next_token ⇒ String
If the result of the previous request to
ListVocabularies
was truncated, include theNextToken
to fetch the next set of jobs. -
#state_equals ⇒ String
When specified, only returns vocabularies with the
VocabularyState
field equal to the specified state.
Instance Attribute Details
#max_results ⇒ Integer
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.
#name_contains ⇒ String
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.
#next_token ⇒ String
If the result of the previous request to ListVocabularies
was
truncated, include the NextToken
to fetch the next set of jobs.
#state_equals ⇒ String
When specified, only returns vocabularies with the VocabularyState
field equal to the specified state.
Possible values:
- PENDING
- READY
- FAILED