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
show all
Defined in:
(unknown)

Overview

Note:

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

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)

    The maximum number of vocabularies to return in the response.

#name_containsString

When specified, the vocabularies returned in the list are limited to vocabularies whose name contains the specified string. The search is case-insensitive, ListVocabularies will return both \"vocabularyname\" and \"VocabularyName\" in the response list.

Returns:

  • (String)

    When specified, the vocabularies returned in the list are limited to vocabularies whose name contains the specified string.

#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)

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

#state_equalsString

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

Possible values:

  • PENDING
  • READY
  • FAILED

Returns:

  • (String)

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