Amazonka.Polly.StartSpeechSynthesisTask

Allows the creation of an asynchronous synthesis task, by starting a new SpeechSynthesisTask. This operation requires all the standard information needed for speech synthesis, plus the name of an Amazon S3 bucket for the service to store the output of the synthesis task and two optional parameters (OutputS3KeyPrefix and SnsTopicArn). Once the synthesis task is created, this operation will return a SpeechSynthesisTask object, which will include an identifier of this task as well as the current status. The SpeechSynthesisTask object is available for 72 hours after starting the asynchronous synthesis task.

Creating a Request

data StartSpeechSynthesisTask

See: newStartSpeechSynthesisTask smart constructor.

Constructors

StartSpeechSynthesisTask'

Fields

• engine :: Maybe Engine

  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.

• languageCode :: Maybe LanguageCode

  Optional language code for the Speech Synthesis request. 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.

• lexiconNames :: Maybe [Text]

  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.

• outputS3KeyPrefix :: Maybe Text

  The Amazon S3 key prefix for the output speech file.

• sampleRate :: Maybe Text

  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".

• snsTopicArn :: Maybe Text

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

• speechMarkTypes :: Maybe [SpeechMarkType]

  The type of speech marks returned for the input text.

• textType :: Maybe TextType

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

• outputFormat :: OutputFormat

  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.

• outputS3BucketName :: Text

  Amazon S3 bucket name to which the output file will be saved.

• text :: Text

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

• voiceId :: VoiceId

  Voice ID to use for the synthesis.

Instances

ToJSON StartSpeechSynthesisTask

Defined in Amazonka.Polly.StartSpeechSynthesisTask

Methods

toJSON :: StartSpeechSynthesisTask -> Value

toEncoding :: StartSpeechSynthesisTask -> Encoding

toJSONList :: [StartSpeechSynthesisTask] -> Value

toEncodingList :: [StartSpeechSynthesisTask] -> Encoding

ToHeaders StartSpeechSynthesisTask

Defined in Amazonka.Polly.StartSpeechSynthesisTask

Methods

toHeaders :: StartSpeechSynthesisTask -> [Header]

ToPath StartSpeechSynthesisTask

Defined in Amazonka.Polly.StartSpeechSynthesisTask

Methods

toPath :: StartSpeechSynthesisTask -> ByteString

ToQuery StartSpeechSynthesisTask

Defined in Amazonka.Polly.StartSpeechSynthesisTask

Methods

toQuery :: StartSpeechSynthesisTask -> QueryString

AWSRequest StartSpeechSynthesisTask

Defined in Amazonka.Polly.StartSpeechSynthesisTask

Associated Types

type AWSResponse StartSpeechSynthesisTask

Methods

request :: (Service -> Service) -> StartSpeechSynthesisTask -> Request StartSpeechSynthesisTask

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartSpeechSynthesisTask -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartSpeechSynthesisTask)))

Generic StartSpeechSynthesisTask

Defined in Amazonka.Polly.StartSpeechSynthesisTask

Associated Types

type Rep StartSpeechSynthesisTask :: Type -> Type

Methods

from :: StartSpeechSynthesisTask -> Rep StartSpeechSynthesisTask x

to :: Rep StartSpeechSynthesisTask x -> StartSpeechSynthesisTask

Read StartSpeechSynthesisTask

Defined in Amazonka.Polly.StartSpeechSynthesisTask

Methods

readsPrec :: Int -> ReadS StartSpeechSynthesisTask

readList :: ReadS [StartSpeechSynthesisTask]

readPrec :: ReadPrec StartSpeechSynthesisTask

readListPrec :: ReadPrec [StartSpeechSynthesisTask]

Show StartSpeechSynthesisTask

Defined in Amazonka.Polly.StartSpeechSynthesisTask

Methods

showsPrec :: Int -> StartSpeechSynthesisTask -> ShowS

show :: StartSpeechSynthesisTask -> String

showList :: [StartSpeechSynthesisTask] -> ShowS

NFData StartSpeechSynthesisTask

Defined in Amazonka.Polly.StartSpeechSynthesisTask

Methods

rnf :: StartSpeechSynthesisTask -> ()

Eq StartSpeechSynthesisTask

Defined in Amazonka.Polly.StartSpeechSynthesisTask

Methods

(==) :: StartSpeechSynthesisTask -> StartSpeechSynthesisTask -> Bool

(/=) :: StartSpeechSynthesisTask -> StartSpeechSynthesisTask -> Bool

Hashable StartSpeechSynthesisTask

Defined in Amazonka.Polly.StartSpeechSynthesisTask

Methods

hashWithSalt :: Int -> StartSpeechSynthesisTask -> Int

hash :: StartSpeechSynthesisTask -> Int

type AWSResponse StartSpeechSynthesisTask

Defined in Amazonka.Polly.StartSpeechSynthesisTask

type AWSResponse StartSpeechSynthesisTask = StartSpeechSynthesisTaskResponse

type Rep StartSpeechSynthesisTask

Defined in Amazonka.Polly.StartSpeechSynthesisTask

type Rep StartSpeechSynthesisTask = D1 ('MetaData "StartSpeechSynthesisTask" "Amazonka.Polly.StartSpeechSynthesisTask" "amazonka-polly-2.0-6sZiChgAXCB1QK3Mfr0Pfp" 'False) (C1 ('MetaCons "StartSpeechSynthesisTask'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Engine)) :*: (S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LanguageCode)) :*: S1 ('MetaSel ('Just "lexiconNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :*: (S1 ('MetaSel ('Just "outputS3KeyPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "sampleRate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "snsTopicArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "speechMarkTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SpeechMarkType])) :*: (S1 ('MetaSel ('Just "textType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TextType)) :*: S1 ('MetaSel ('Just "outputFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 OutputFormat))) :*: (S1 ('MetaSel ('Just "outputS3BucketName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "voiceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 VoiceId))))))

newStartSpeechSynthesisTask

Arguments

:: OutputFormat

StartSpeechSynthesisTask

-> Text

$sel:outputS3BucketName:StartSpeechSynthesisTask'

-> Text

$sel:text:StartSpeechSynthesisTask'

-> VoiceId

StartSpeechSynthesisTask

-> StartSpeechSynthesisTask

Create a value of StartSpeechSynthesisTask with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

StartSpeechSynthesisTask, startSpeechSynthesisTask_engine - 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.

StartSpeechSynthesisTask, startSpeechSynthesisTask_languageCode - Optional language code for the Speech Synthesis request. 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.

StartSpeechSynthesisTask, startSpeechSynthesisTask_lexiconNames - 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.

$sel:outputS3KeyPrefix:StartSpeechSynthesisTask', startSpeechSynthesisTask_outputS3KeyPrefix - The Amazon S3 key prefix for the output speech file.

StartSpeechSynthesisTask, startSpeechSynthesisTask_sampleRate - 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".

StartSpeechSynthesisTask, startSpeechSynthesisTask_snsTopicArn - ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.

StartSpeechSynthesisTask, startSpeechSynthesisTask_speechMarkTypes - The type of speech marks returned for the input text.

StartSpeechSynthesisTask, startSpeechSynthesisTask_textType - Specifies whether the input text is plain text or SSML. The default value is plain text.

StartSpeechSynthesisTask, startSpeechSynthesisTask_outputFormat - 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.

$sel:outputS3BucketName:StartSpeechSynthesisTask', startSpeechSynthesisTask_outputS3BucketName - Amazon S3 bucket name to which the output file will be saved.

$sel:text:StartSpeechSynthesisTask', startSpeechSynthesisTask_text - The input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.

StartSpeechSynthesisTask, startSpeechSynthesisTask_voiceId - Voice ID to use for the synthesis.

Request Lenses

startSpeechSynthesisTask_engine :: Lens' StartSpeechSynthesisTask (Maybe Engine)

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.

startSpeechSynthesisTask_languageCode :: Lens' StartSpeechSynthesisTask (Maybe LanguageCode)

Optional language code for the Speech Synthesis request. 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.

startSpeechSynthesisTask_lexiconNames :: Lens' StartSpeechSynthesisTask (Maybe [Text])

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.

startSpeechSynthesisTask_outputS3KeyPrefix :: Lens' StartSpeechSynthesisTask (Maybe Text)

The Amazon S3 key prefix for the output speech file.

startSpeechSynthesisTask_sampleRate :: Lens' StartSpeechSynthesisTask (Maybe Text)

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".

startSpeechSynthesisTask_snsTopicArn :: Lens' StartSpeechSynthesisTask (Maybe Text)

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

startSpeechSynthesisTask_speechMarkTypes :: Lens' StartSpeechSynthesisTask (Maybe [SpeechMarkType])

The type of speech marks returned for the input text.

startSpeechSynthesisTask_textType :: Lens' StartSpeechSynthesisTask (Maybe TextType)

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

startSpeechSynthesisTask_outputFormat :: Lens' StartSpeechSynthesisTask OutputFormat

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.

startSpeechSynthesisTask_outputS3BucketName :: Lens' StartSpeechSynthesisTask Text

Amazon S3 bucket name to which the output file will be saved.

startSpeechSynthesisTask_text :: Lens' StartSpeechSynthesisTask Text

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

startSpeechSynthesisTask_voiceId :: Lens' StartSpeechSynthesisTask VoiceId

Voice ID to use for the synthesis.

Destructuring the Response

data StartSpeechSynthesisTaskResponse

See: newStartSpeechSynthesisTaskResponse smart constructor.

Constructors

StartSpeechSynthesisTaskResponse'

Fields

• synthesisTask :: Maybe SynthesisTask

  SynthesisTask object that provides information and attributes about a newly submitted speech synthesis task.

• httpStatus :: Int

  The response's http status code.

Instances

Generic StartSpeechSynthesisTaskResponse

Defined in Amazonka.Polly.StartSpeechSynthesisTask

Associated Types

type Rep StartSpeechSynthesisTaskResponse :: Type -> Type

Methods

from :: StartSpeechSynthesisTaskResponse -> Rep StartSpeechSynthesisTaskResponse x

to :: Rep StartSpeechSynthesisTaskResponse x -> StartSpeechSynthesisTaskResponse

Read StartSpeechSynthesisTaskResponse

Defined in Amazonka.Polly.StartSpeechSynthesisTask

Methods

readsPrec :: Int -> ReadS StartSpeechSynthesisTaskResponse

readList :: ReadS [StartSpeechSynthesisTaskResponse]

readPrec :: ReadPrec StartSpeechSynthesisTaskResponse

readListPrec :: ReadPrec [StartSpeechSynthesisTaskResponse]

Show StartSpeechSynthesisTaskResponse

Defined in Amazonka.Polly.StartSpeechSynthesisTask

Methods

showsPrec :: Int -> StartSpeechSynthesisTaskResponse -> ShowS

show :: StartSpeechSynthesisTaskResponse -> String

showList :: [StartSpeechSynthesisTaskResponse] -> ShowS

NFData StartSpeechSynthesisTaskResponse

Defined in Amazonka.Polly.StartSpeechSynthesisTask

Methods

rnf :: StartSpeechSynthesisTaskResponse -> ()

Eq StartSpeechSynthesisTaskResponse

Defined in Amazonka.Polly.StartSpeechSynthesisTask

Methods

(==) :: StartSpeechSynthesisTaskResponse -> StartSpeechSynthesisTaskResponse -> Bool

(/=) :: StartSpeechSynthesisTaskResponse -> StartSpeechSynthesisTaskResponse -> Bool

type Rep StartSpeechSynthesisTaskResponse

Defined in Amazonka.Polly.StartSpeechSynthesisTask

type Rep StartSpeechSynthesisTaskResponse = D1 ('MetaData "StartSpeechSynthesisTaskResponse" "Amazonka.Polly.StartSpeechSynthesisTask" "amazonka-polly-2.0-6sZiChgAXCB1QK3Mfr0Pfp" 'False) (C1 ('MetaCons "StartSpeechSynthesisTaskResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "synthesisTask") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SynthesisTask)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartSpeechSynthesisTaskResponse

Arguments

:: Int

$sel:httpStatus:StartSpeechSynthesisTaskResponse'

-> StartSpeechSynthesisTaskResponse

Create a value of StartSpeechSynthesisTaskResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:synthesisTask:StartSpeechSynthesisTaskResponse', startSpeechSynthesisTaskResponse_synthesisTask - SynthesisTask object that provides information and attributes about a newly submitted speech synthesis task.

$sel:httpStatus:StartSpeechSynthesisTaskResponse', startSpeechSynthesisTaskResponse_httpStatus - The response's http status code.

Response Lenses

startSpeechSynthesisTaskResponse_synthesisTask :: Lens' StartSpeechSynthesisTaskResponse (Maybe SynthesisTask)

SynthesisTask object that provides information and attributes about a newly submitted speech synthesis task.

startSpeechSynthesisTaskResponse_httpStatus :: Lens' StartSpeechSynthesisTaskResponse Int

The response's http status code.