Module: Aws::Polly::Types

Defined in:
gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb

Defined Under Namespace

Classes: AudioEvent, DeleteLexiconInput, DeleteLexiconOutput, DescribeVoicesInput, DescribeVoicesOutput, EngineNotSupportedException, FlushStreamConfiguration, GetLexiconInput, GetLexiconOutput, GetSpeechSynthesisTaskInput, GetSpeechSynthesisTaskOutput, InvalidLexiconException, InvalidNextTokenException, InvalidS3BucketException, InvalidS3KeyException, InvalidSampleRateException, InvalidSnsTopicArnException, InvalidSsmlException, InvalidTaskIdException, LanguageNotSupportedException, Lexicon, LexiconAttributes, LexiconDescription, LexiconNotFoundException, LexiconSizeExceededException, ListLexiconsInput, ListLexiconsOutput, ListSpeechSynthesisTasksInput, ListSpeechSynthesisTasksOutput, MarksNotSupportedForFormatException, MaxLexemeLengthExceededException, MaxLexiconsNumberExceededException, PutLexiconInput, PutLexiconOutput, ServiceFailureException, ServiceQuotaExceededException, SsmlMarksNotSupportedForTextTypeException, StartSpeechSynthesisStreamActionStream, StartSpeechSynthesisStreamEventStream, StartSpeechSynthesisStreamInput, StartSpeechSynthesisStreamOutput, StartSpeechSynthesisTaskInput, StartSpeechSynthesisTaskOutput, StreamClosedEvent, SynthesisTask, SynthesisTaskNotFoundException, SynthesizeSpeechInput, SynthesizeSpeechOutput, TextEvent, TextLengthExceededException, ThrottlingException, ThrottlingReason, UnsupportedPlsAlphabetException, UnsupportedPlsLanguageException, ValidationException, ValidationExceptionField, Voice

Instance Attribute Summary collapse

Instance Attribute Details

#audio_chunk ⇒ String

A chunk of synthesized audio data encoded in the format specified by the OutputFormat parameter.

Returns:

  • (String) 


22
23
24
25
26
27
 
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 22

class AudioEvent < Struct.new(
  :audio_chunk,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#fields ⇒ Array<Types::ValidationExceptionField>

The fields that caused the validation error.

Returns:



1274
1275
1276
1277
1278
1279
1280
1281
 
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 1274

class ValidationException < Struct.new(
  :message,
  :reason,
  :fields,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#flush_stream_configuration ⇒ Types::FlushStreamConfiguration

Configuration for controlling when synthesized audio flushes to the output stream.

Returns:



1162
1163
1164
1165
1166
1167
1168
1169
 
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 1162

class TextEvent < Struct.new(
  :text,
  :text_type,
  :flush_stream_configuration,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#message ⇒ String

Returns:

  • (String) 


604
605
606
607
608
609
 
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 604

class ServiceFailureException < Struct.new(
  :message,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#quota_code ⇒ String

The quota code identifying the specific quota.

Returns:

  • (String) 


626
627
628
629
630
631
632
633
 
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 626

class ServiceQuotaExceededException < Struct.new(
  :message,
  :quota_code,
  :service_code,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#reason ⇒ String

The reason the request failed validation.

Returns:

  • (String) 


1274
1275
1276
1277
1278
1279
1280
1281
 
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 1274

class ValidationException < Struct.new(
  :message,
  :reason,
  :fields,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#request_characters ⇒ Integer

The total number of characters synthesized during the streaming session.

Returns:

  • (Integer) 


845
846
847
848
849
850
 
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 845

class StreamClosedEvent < Struct.new(
  :request_characters,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#service_code ⇒ String

The service code identifying the originating service.

Returns:

  • (String) 


626
627
628
629
630
631
632
633
 
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 626

class ServiceQuotaExceededException < Struct.new(
  :message,
  :quota_code,
  :service_code,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#text ⇒ String

The text content to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.

Returns:

  • (String) 


1162
1163
1164
1165
1166
1167
1168
1169
 
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 1162

class TextEvent < Struct.new(
  :text,
  :text_type,
  :flush_stream_configuration,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#text_type ⇒ String

Specifies whether the input text is plain text or SSML. Default: plain text.

Returns:

  • (String) 


1162
1163
1164
1165
1166
1167
1168
1169
 
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 1162

class TextEvent < Struct.new(
  :text,
  :text_type,
  :flush_stream_configuration,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#throttling_reasons ⇒ Array<Types::ThrottlingReason>

A list of reasons explaining why the request was throttled.

Returns:



1200
1201
1202
1203
1204
1205
1206
 
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 1200

class ThrottlingException < Struct.new(
  :message,
  :throttling_reasons,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end