Skip to content
AWS for Query.Farm

aws.polly.get_speech_synthesis_task

Example SQL Queries

SELECT * FROM
aws.polly.get_speech_synthesis_task
WHERE
"task_id" = 'VALUE';

Description

Retrieves a specific SpeechSynthesisTask object based on its TaskID. This object contains information about the given speech synthesis task, including the status of the task, and a link to the S3 bucket containing the output of the task.

Table Definition

Column NameColumn Data Type
task_id Required Input Column

The Amazon Polly generated identifier for a speech synthesis task.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
synthesis_task

SynthesisTask object that provides information from the requested task, including output format, creation time, task status, and so on.

STRUCT(
    "engine" VARCHAR,
    "task_id" VARCHAR,
    "task_status" VARCHAR,
    "task_status_reason" VARCHAR,
    "output_uri" VARCHAR,
    "creation_time" TIMESTAMP_S,
    "request_characters" BIGINT,
    "sns_topic_arn" VARCHAR,
    "lexicon_names" VARCHAR[],
    "output_format" VARCHAR,
    "sample_rate" VARCHAR,
    "speech_mark_types" VARCHAR[],
    "text_type" VARCHAR,
    "voice_id" VARCHAR,
    "language_code" VARCHAR
)
Show child fields
synthesis_task.creation_time

Timestamp for the time the synthesis task was started.

synthesis_task.engine

Specifies the engine (standard, neural, long-form or generative) 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.

synthesis_task.language_code

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.

synthesis_task.lexicon_names[]
synthesis_task.output_format

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.

synthesis_task.output_uri

Pathway for the output speech file.

synthesis_task.request_characters

Number of billable characters synthesized.

synthesis_task.sample_rate

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". The default value for long-form voices is "24000". The default value for generative voices is "24000".

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

synthesis_task.sns_topic_arn

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

synthesis_task.speech_mark_types[]
synthesis_task.task_id

The Amazon Polly generated identifier for a speech synthesis task.

synthesis_task.task_status

Current status of the individual speech synthesis task.

synthesis_task.task_status_reason

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

synthesis_task.text_type

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

synthesis_task.voice_id

Voice ID to use for the synthesis.