Class: Aws::Polly::Types::DescribeVoicesInput

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

Overview

Note:

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

{
  engine: "standard", # accepts standard, neural
  language_code: "arb", # accepts arb, cmn-CN, cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN, en-US, es-ES, es-MX, es-US, fr-CA, fr-FR, is-IS, it-IT, ja-JP, hi-IN, ko-KR, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, tr-TR
  include_additional_language_codes: false,
  next_token: "NextToken",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#engineString

Specifies the engine (‘standard` or `neural`) used by Amazon Polly when processing input text for speech synthesis.

Returns:

  • (String)


76
77
78
79
80
81
82
83
# File 'lib/aws-sdk-polly/types.rb', line 76

class DescribeVoicesInput < Struct.new(
  :engine,
  :language_code,
  :include_additional_language_codes,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#include_additional_language_codesBoolean

Boolean value indicating whether to return any bilingual voices that use the specified language as an additional language. For instance, if you request all languages that use US English (es-US), and there is an Italian voice that speaks both Italian (it-IT) and US English, that voice will be included if you specify ‘yes` but not if you specify `no`.

Returns:

  • (Boolean)


76
77
78
79
80
81
82
83
# File 'lib/aws-sdk-polly/types.rb', line 76

class DescribeVoicesInput < Struct.new(
  :engine,
  :language_code,
  :include_additional_language_codes,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#language_codeString

The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned. If you don’t specify this optional parameter, all available voices are returned.

Returns:

  • (String)


76
77
78
79
80
81
82
83
# File 'lib/aws-sdk-polly/types.rb', line 76

class DescribeVoicesInput < Struct.new(
  :engine,
  :language_code,
  :include_additional_language_codes,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

An opaque pagination token returned from the previous ‘DescribeVoices` operation. If present, this indicates where to continue the listing.

Returns:

  • (String)


76
77
78
79
80
81
82
83
# File 'lib/aws-sdk-polly/types.rb', line 76

class DescribeVoicesInput < Struct.new(
  :engine,
  :language_code,
  :include_additional_language_codes,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end