ListSpeechSynthesisTasks - Amazon Polly

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

ListSpeechSynthesisTasks

返回按创建日期排序的 SpeechSynthesisTask 对象列表。此操作可以按任务状态筛选任务,例如,允许用户仅列出已完成的任务。

请求语法

GET /v1/synthesisTasks?MaxResults=MaxResults&NextToken=NextToken&Status=Status HTTP/1.1

URI 请求参数

请求使用以下 URI 参数。

MaxResults

在列表操作中返回的最大语音合成任务数。

有效范围:最小值为 1。最大值为 100。

NextToken

在下一个请求中使用的分页标记,用于继续列出语音合成任务。

长度约束:最小长度为 0。最大长度为 4096。

Status

在列表操作中返回的语音合成任务的状态

有效值:scheduled | inProgress | completed | failed

请求正文

该请求没有请求正文。

响应语法

HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "SynthesisTasks": [ { "CreationTime": number, "Engine": "string", "LanguageCode": "string", "LexiconNames": [ "string" ], "OutputFormat": "string", "OutputUri": "string", "RequestCharacters": number, "SampleRate": "string", "SnsTopicArn": "string", "SpeechMarkTypes": [ "string" ], "TaskId": "string", "TaskStatus": "string", "TaskStatusReason": "string", "TextType": "string", "VoiceId": "string" } ] }

响应元素

如果此操作成功,则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

NextToken

此请求中从上一次列表操作返回的不透明分页标记。如果存在,则表示在哪里继续列出。

类型:字符串

长度约束:最小长度为 0。最大长度为 4096。

SynthesisTasks

提供列表请求中指定任务信息的 SynthesisTask 对象列表,包括输出格式、创建时间、任务状态等。

类型:SynthesisTask 对象数组

错误

InvalidNextTokenException

NextToken 无效。确保拼写正确,然后请重试。

HTTP 状态代码:400

ServiceFailureException

未知情况导致服务故障。

HTTP 状态代码:500

另请参阅

有关在特定语言的 AWS SDK 中使用此 API 的更多信息,请参阅以下内容: