AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::Polly::Types::SynthesisTask

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

Overview

SynthesisTask object that provides information about a speech synthesis task.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#creation_timeTime

Timestamp for the time the synthesis task was started.

Returns:

  • (Time)


855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 855

class SynthesisTask < Struct.new(
  :engine,
  :task_id,
  :task_status,
  :task_status_reason,
  :output_uri,
  :creation_time,
  :request_characters,
  :sns_topic_arn,
  :lexicon_names,
  :output_format,
  :sample_rate,
  :speech_mark_types,
  :text_type,
  :voice_id,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end

#engineString

Specifies the engine (standard or neural) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.

Returns:

  • (String)


855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 855

class SynthesisTask < Struct.new(
  :engine,
  :task_id,
  :task_status,
  :task_status_reason,
  :output_uri,
  :creation_time,
  :request_characters,
  :sns_topic_arn,
  :lexicon_names,
  :output_format,
  :sample_rate,
  :speech_mark_types,
  :text_type,
  :voice_id,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end

#language_codeString

Optional language code for a synthesis task. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).

If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.

Returns:

  • (String)


855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 855

class SynthesisTask < Struct.new(
  :engine,
  :task_id,
  :task_status,
  :task_status_reason,
  :output_uri,
  :creation_time,
  :request_characters,
  :sns_topic_arn,
  :lexicon_names,
  :output_format,
  :sample_rate,
  :speech_mark_types,
  :text_type,
  :voice_id,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end

#lexicon_namesArray<String>

List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice.

Returns:

  • (Array<String>)


855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 855

class SynthesisTask < Struct.new(
  :engine,
  :task_id,
  :task_status,
  :task_status_reason,
  :output_uri,
  :creation_time,
  :request_characters,
  :sns_topic_arn,
  :lexicon_names,
  :output_format,
  :sample_rate,
  :speech_mark_types,
  :text_type,
  :voice_id,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end

#output_formatString

The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.

Returns:

  • (String)


855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 855

class SynthesisTask < Struct.new(
  :engine,
  :task_id,
  :task_status,
  :task_status_reason,
  :output_uri,
  :creation_time,
  :request_characters,
  :sns_topic_arn,
  :lexicon_names,
  :output_format,
  :sample_rate,
  :speech_mark_types,
  :text_type,
  :voice_id,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end

#output_uriString

Pathway for the output speech file.

Returns:

  • (String)


855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 855

class SynthesisTask < Struct.new(
  :engine,
  :task_id,
  :task_status,
  :task_status_reason,
  :output_uri,
  :creation_time,
  :request_characters,
  :sns_topic_arn,
  :lexicon_names,
  :output_format,
  :sample_rate,
  :speech_mark_types,
  :text_type,
  :voice_id,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end

#request_charactersInteger

Number of billable characters synthesized.

Returns:

  • (Integer)


855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 855

class SynthesisTask < Struct.new(
  :engine,
  :task_id,
  :task_status,
  :task_status_reason,
  :output_uri,
  :creation_time,
  :request_characters,
  :sns_topic_arn,
  :lexicon_names,
  :output_format,
  :sample_rate,
  :speech_mark_types,
  :text_type,
  :voice_id,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end

#sample_rateString

The audio frequency specified in Hz.

The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000".

Valid values for pcm are "8000" and "16000" The default value is "16000".

Returns:

  • (String)


855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 855

class SynthesisTask < Struct.new(
  :engine,
  :task_id,
  :task_status,
  :task_status_reason,
  :output_uri,
  :creation_time,
  :request_characters,
  :sns_topic_arn,
  :lexicon_names,
  :output_format,
  :sample_rate,
  :speech_mark_types,
  :text_type,
  :voice_id,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end

#sns_topic_arnString

ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.

Returns:

  • (String)


855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 855

class SynthesisTask < Struct.new(
  :engine,
  :task_id,
  :task_status,
  :task_status_reason,
  :output_uri,
  :creation_time,
  :request_characters,
  :sns_topic_arn,
  :lexicon_names,
  :output_format,
  :sample_rate,
  :speech_mark_types,
  :text_type,
  :voice_id,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end

#speech_mark_typesArray<String>

The type of speech marks returned for the input text.

Returns:

  • (Array<String>)


855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 855

class SynthesisTask < Struct.new(
  :engine,
  :task_id,
  :task_status,
  :task_status_reason,
  :output_uri,
  :creation_time,
  :request_characters,
  :sns_topic_arn,
  :lexicon_names,
  :output_format,
  :sample_rate,
  :speech_mark_types,
  :text_type,
  :voice_id,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end

#task_idString

The Amazon Polly generated identifier for a speech synthesis task.

Returns:

  • (String)


855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 855

class SynthesisTask < Struct.new(
  :engine,
  :task_id,
  :task_status,
  :task_status_reason,
  :output_uri,
  :creation_time,
  :request_characters,
  :sns_topic_arn,
  :lexicon_names,
  :output_format,
  :sample_rate,
  :speech_mark_types,
  :text_type,
  :voice_id,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end

#task_statusString

Current status of the individual speech synthesis task.

Returns:

  • (String)


855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 855

class SynthesisTask < Struct.new(
  :engine,
  :task_id,
  :task_status,
  :task_status_reason,
  :output_uri,
  :creation_time,
  :request_characters,
  :sns_topic_arn,
  :lexicon_names,
  :output_format,
  :sample_rate,
  :speech_mark_types,
  :text_type,
  :voice_id,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end

#task_status_reasonString

Reason for the current status of a specific speech synthesis task, including errors if the task has failed.

Returns:

  • (String)


855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 855

class SynthesisTask < Struct.new(
  :engine,
  :task_id,
  :task_status,
  :task_status_reason,
  :output_uri,
  :creation_time,
  :request_characters,
  :sns_topic_arn,
  :lexicon_names,
  :output_format,
  :sample_rate,
  :speech_mark_types,
  :text_type,
  :voice_id,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end

#text_typeString

Specifies whether the input text is plain text or SSML. The default value is plain text.

Returns:

  • (String)


855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 855

class SynthesisTask < Struct.new(
  :engine,
  :task_id,
  :task_status,
  :task_status_reason,
  :output_uri,
  :creation_time,
  :request_characters,
  :sns_topic_arn,
  :lexicon_names,
  :output_format,
  :sample_rate,
  :speech_mark_types,
  :text_type,
  :voice_id,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end

#voice_idString

Voice ID to use for the synthesis.

Returns:

  • (String)


855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 855

class SynthesisTask < Struct.new(
  :engine,
  :task_id,
  :task_status,
  :task_status_reason,
  :output_uri,
  :creation_time,
  :request_characters,
  :sns_topic_arn,
  :lexicon_names,
  :output_format,
  :sample_rate,
  :speech_mark_types,
  :text_type,
  :voice_id,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end