start_speech_synthesis_task async ¶

async def start_speech_synthesis_task(
    self,
    output_format: "capo_polly.types.output_format.OutputFormat",
    output_s3_bucket_name: "capo_polly.types.output_s3_bucket_name.OutputS3BucketName",
    text: "capo_polly.types.text.Text",
    voice_id: "capo_polly.types.voice_id.VoiceId",
    *,
    config_overrides: Optional[AsyncPollyClientConfig] = None,
    engine: Optional["capo_polly.types.engine.Engine"] = None,
    language_code: Optional["capo_polly.types.language_code.LanguageCode"] = None,
    lexicon_names: Optional[
        "capo_polly.types.lexicon_name_list.LexiconNameList"
    ] = None,
    output_s3_key_prefix: Optional[
        "capo_polly.types.output_s3_key_prefix.OutputS3KeyPrefix"
    ] = None,
    sample_rate: Optional["capo_polly.types.sample_rate.SampleRate"] = None,
    sns_topic_arn: Optional["capo_polly.types.sns_topic_arn.SnsTopicArn"] = None,
    speech_mark_types: Optional[
        "capo_polly.types.speech_mark_type_list.SpeechMarkTypeList"
    ] = None,
    text_type: Optional["capo_polly.types.text_type.TextType"] = None,
) -> "capo_polly.types.start_speech_synthesis_task_output.StartSpeechSynthesisTaskOutput":
    """<p>Allows the creation of an asynchronous synthesis task, by starting a new <code>SpeechSynthesisTask</code>. 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 (<code>OutputS3KeyPrefix</code> and <code>SnsTopicArn</code>). Once the synthesis task is created, this operation will return a <code>SpeechSynthesisTask</code> object, which will include an identifier of this task as well as the current status. The <code>SpeechSynthesisTask</code> object is available for 72 hours after starting the asynchronous synthesis task.</p>

    Args:
        engine: <p>Specifies the engine (<code>standard</code>, <code>neural</code>, <code>long-form</code> or <code>generative</code>) 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.</p>
        language_code: <p>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). </p> <p>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 <a href="https://docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html">DescribeVoices</a> operation for the <code>LanguageCode</code> parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.</p>
        lexicon_names: <p>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. </p>
        output_format: <p>The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, ogg_opus, mu-law, a-law, or pcm. For speech marks, this will be json. </p>
        output_s3_bucket_name: <p>Amazon S3 bucket name to which the output file will be saved.</p>
        output_s3_key_prefix: <p>The Amazon S3 key prefix for the output speech file.</p>
        sample_rate: <p>The audio frequency specified in Hz.</p> <p>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". The default value for long-form voices is "24000". The default value for generative voices is "24000".</p> <p>Valid values for pcm are "8000" and "16000" The default value is "16000". </p> <p>Valid value for ogg_opus is "48000". </p> <p>Valid value for mu-law and a-law is "8000". </p>
        sns_topic_arn: <p>ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.</p>
        speech_mark_types: <p>The type of speech marks returned for the input text.</p>
        text: <p>The input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text. </p>
        text_type: <p>Specifies whether the input text is plain text or SSML. The default value is plain text. </p>
        voice_id: <p>Voice ID to use for the synthesis. </p>

    Raises:
        capo_polly.errors.engine_not_supported_exception.EngineNotSupportedException: <p>This engine is not compatible with the voice that you have designated. Choose a new voice that is compatible with the engine or change the engine and restart the operation.</p>
        capo_polly.errors.invalid_s3_bucket_exception.InvalidS3BucketException: <p>The provided Amazon S3 bucket name is invalid. Please check your input with S3 bucket naming requirements and try again.</p>
        capo_polly.errors.invalid_s3_key_exception.InvalidS3KeyException: <p>The provided Amazon S3 key prefix is invalid. Please provide a valid S3 object key name.</p>
        capo_polly.errors.invalid_sample_rate_exception.InvalidSampleRateException: <p>The specified sample rate is not valid.</p>
        capo_polly.errors.invalid_sns_topic_arn_exception.InvalidSnsTopicArnException: <p>The provided SNS topic ARN is invalid. Please provide a valid SNS topic ARN and try again.</p>
        capo_polly.errors.invalid_ssml_exception.InvalidSsmlException: <p>The SSML you provided is invalid. Verify the SSML syntax, spelling of tags and values, and then try again.</p>
        capo_polly.errors.language_not_supported_exception.LanguageNotSupportedException: <p>The language specified is not currently supported by Amazon Polly in this capacity.</p>
        capo_polly.errors.lexicon_not_found_exception.LexiconNotFoundException: <p>Amazon Polly can't find the specified lexicon. This could be caused by a lexicon that is missing, its name is misspelled or specifying a lexicon that is in a different region.</p> <p>Verify that the lexicon exists, is in the region (see <a>ListLexicons</a>) and that you spelled its name is spelled correctly. Then try again.</p>
        capo_polly.errors.marks_not_supported_for_format_exception.MarksNotSupportedForFormatException: <p>Speech marks are not supported for the <code>OutputFormat</code> selected. Speech marks are only available for content in <code>json</code> format.</p>
        capo_polly.errors.service_failure_exception.ServiceFailureException: <p>An unknown condition has caused a service failure.</p>
        capo_polly.errors.ssml_marks_not_supported_for_text_type_exception.SsmlMarksNotSupportedForTextTypeException: <p>SSML speech marks are not supported for plain text-type input.</p>
        capo_polly.errors.text_length_exceeded_exception.TextLengthExceededException: <p>The value of the "Text" parameter is longer than the accepted limits. For the <code>SynthesizeSpeech</code> API, the limit for input text is a maximum of 6000 characters total, of which no more than 3000 can be billed characters. For the <code>StartSpeechSynthesisTask</code> API, the maximum is 200,000 characters, of which no more than 100,000 can be billed characters. SSML tags are not counted as billed characters.</p>
        capo_polly.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_polly.types.start_speech_synthesis_task_input.StartSpeechSynthesisTaskInput]",
    ) -> AsyncOperationResponse[
        "capo_polly.types.start_speech_synthesis_task_output.StartSpeechSynthesisTaskOutput"
    ]:
        import capo_polly._operations.parrot_v1.start_speech_synthesis_task

        (
            output,
            http_response,
        ) = await capo_polly._operations.parrot_v1.start_speech_synthesis_task.async_start_speech_synthesis_task(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartSpeechSynthesisTask")
    )
    input_: capo_polly.types.start_speech_synthesis_task_input.StartSpeechSynthesisTaskInput = {
        "output_format": output_format,
        "output_s3_bucket_name": output_s3_bucket_name,
        "text": text,
        "voice_id": voice_id,
    }
    if engine is not None:
        input_["engine"] = engine
    if language_code is not None:
        input_["language_code"] = language_code
    if lexicon_names is not None:
        input_["lexicon_names"] = lexicon_names
    if output_s3_key_prefix is not None:
        input_["output_s3_key_prefix"] = output_s3_key_prefix
    if sample_rate is not None:
        input_["sample_rate"] = sample_rate
    if sns_topic_arn is not None:
        input_["sns_topic_arn"] = sns_topic_arn
    if speech_mark_types is not None:
        input_["speech_mark_types"] = speech_mark_types
    if text_type is not None:
        input_["text_type"] = text_type

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output