Skip to content

Type definitions#

Index > Polly > Type definitions

Auto-generated documentation for Polly type annotations stubs module mypy-boto3-polly.

DeleteLexiconInputRequestTypeDef#

# DeleteLexiconInputRequestTypeDef definition

class DeleteLexiconInputRequestTypeDef(TypedDict):
    Name: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

DescribeVoicesInputRequestTypeDef#

# DescribeVoicesInputRequestTypeDef definition

class DescribeVoicesInputRequestTypeDef(TypedDict):
    Engine: NotRequired[EngineType],  # (1)
    LanguageCode: NotRequired[LanguageCodeType],  # (2)
    IncludeAdditionalLanguageCodes: NotRequired[bool],
    NextToken: NotRequired[str],
  1. See EngineType
  2. See LanguageCodeType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

VoiceTypeDef#

# VoiceTypeDef definition

class VoiceTypeDef(TypedDict):
    Gender: NotRequired[GenderType],  # (1)
    Id: NotRequired[VoiceIdType],  # (2)
    LanguageCode: NotRequired[LanguageCodeType],  # (3)
    LanguageName: NotRequired[str],
    Name: NotRequired[str],
    AdditionalLanguageCodes: NotRequired[List[LanguageCodeType]],  # (4)
    SupportedEngines: NotRequired[List[EngineType]],  # (5)
  1. See GenderType
  2. See VoiceIdType
  3. See LanguageCodeType
  4. See LanguageCodeType
  5. See EngineType

GetLexiconInputRequestTypeDef#

# GetLexiconInputRequestTypeDef definition

class GetLexiconInputRequestTypeDef(TypedDict):
    Name: str,

LexiconAttributesTypeDef#

# LexiconAttributesTypeDef definition

class LexiconAttributesTypeDef(TypedDict):
    Alphabet: NotRequired[str],
    LanguageCode: NotRequired[LanguageCodeType],  # (1)
    LastModified: NotRequired[datetime],
    LexiconArn: NotRequired[str],
    LexemesCount: NotRequired[int],
    Size: NotRequired[int],
  1. See LanguageCodeType

LexiconTypeDef#

# LexiconTypeDef definition

class LexiconTypeDef(TypedDict):
    Content: NotRequired[str],
    Name: NotRequired[str],

GetSpeechSynthesisTaskInputRequestTypeDef#

# GetSpeechSynthesisTaskInputRequestTypeDef definition

class GetSpeechSynthesisTaskInputRequestTypeDef(TypedDict):
    TaskId: str,

SynthesisTaskTypeDef#

# SynthesisTaskTypeDef definition

class SynthesisTaskTypeDef(TypedDict):
    Engine: NotRequired[EngineType],  # (1)
    TaskId: NotRequired[str],
    TaskStatus: NotRequired[TaskStatusType],  # (2)
    TaskStatusReason: NotRequired[str],
    OutputUri: NotRequired[str],
    CreationTime: NotRequired[datetime],
    RequestCharacters: NotRequired[int],
    SnsTopicArn: NotRequired[str],
    LexiconNames: NotRequired[List[str]],
    OutputFormat: NotRequired[OutputFormatType],  # (3)
    SampleRate: NotRequired[str],
    SpeechMarkTypes: NotRequired[List[SpeechMarkTypeType]],  # (4)
    TextType: NotRequired[TextTypeType],  # (5)
    VoiceId: NotRequired[VoiceIdType],  # (6)
    LanguageCode: NotRequired[LanguageCodeType],  # (7)
  1. See EngineType
  2. See TaskStatusType
  3. See OutputFormatType
  4. See SpeechMarkTypeType
  5. See TextTypeType
  6. See VoiceIdType
  7. See LanguageCodeType

ListLexiconsInputRequestTypeDef#

# ListLexiconsInputRequestTypeDef definition

class ListLexiconsInputRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],

ListSpeechSynthesisTasksInputRequestTypeDef#

# ListSpeechSynthesisTasksInputRequestTypeDef definition

class ListSpeechSynthesisTasksInputRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    Status: NotRequired[TaskStatusType],  # (1)
  1. See TaskStatusType

PutLexiconInputRequestTypeDef#

# PutLexiconInputRequestTypeDef definition

class PutLexiconInputRequestTypeDef(TypedDict):
    Name: str,
    Content: str,

StartSpeechSynthesisTaskInputRequestTypeDef#

# StartSpeechSynthesisTaskInputRequestTypeDef definition

class StartSpeechSynthesisTaskInputRequestTypeDef(TypedDict):
    OutputFormat: OutputFormatType,  # (1)
    OutputS3BucketName: str,
    Text: str,
    VoiceId: VoiceIdType,  # (2)
    Engine: NotRequired[EngineType],  # (3)
    LanguageCode: NotRequired[LanguageCodeType],  # (4)
    LexiconNames: NotRequired[Sequence[str]],
    OutputS3KeyPrefix: NotRequired[str],
    SampleRate: NotRequired[str],
    SnsTopicArn: NotRequired[str],
    SpeechMarkTypes: NotRequired[Sequence[SpeechMarkTypeType]],  # (5)
    TextType: NotRequired[TextTypeType],  # (6)
  1. See OutputFormatType
  2. See VoiceIdType
  3. See EngineType
  4. See LanguageCodeType
  5. See SpeechMarkTypeType
  6. See TextTypeType

SynthesizeSpeechInputRequestTypeDef#

# SynthesizeSpeechInputRequestTypeDef definition

class SynthesizeSpeechInputRequestTypeDef(TypedDict):
    OutputFormat: OutputFormatType,  # (1)
    Text: str,
    VoiceId: VoiceIdType,  # (2)
    Engine: NotRequired[EngineType],  # (3)
    LanguageCode: NotRequired[LanguageCodeType],  # (4)
    LexiconNames: NotRequired[Sequence[str]],
    SampleRate: NotRequired[str],
    SpeechMarkTypes: NotRequired[Sequence[SpeechMarkTypeType]],  # (5)
    TextType: NotRequired[TextTypeType],  # (6)
  1. See OutputFormatType
  2. See VoiceIdType
  3. See EngineType
  4. See LanguageCodeType
  5. See SpeechMarkTypeType
  6. See TextTypeType

DescribeVoicesInputDescribeVoicesPaginateTypeDef#

# DescribeVoicesInputDescribeVoicesPaginateTypeDef definition

class DescribeVoicesInputDescribeVoicesPaginateTypeDef(TypedDict):
    Engine: NotRequired[EngineType],  # (1)
    LanguageCode: NotRequired[LanguageCodeType],  # (2)
    IncludeAdditionalLanguageCodes: NotRequired[bool],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See EngineType
  2. See LanguageCodeType
  3. See PaginatorConfigTypeDef

ListLexiconsInputListLexiconsPaginateTypeDef#

# ListLexiconsInputListLexiconsPaginateTypeDef definition

class ListLexiconsInputListLexiconsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListSpeechSynthesisTasksInputListSpeechSynthesisTasksPaginateTypeDef#

# ListSpeechSynthesisTasksInputListSpeechSynthesisTasksPaginateTypeDef definition

class ListSpeechSynthesisTasksInputListSpeechSynthesisTasksPaginateTypeDef(TypedDict):
    Status: NotRequired[TaskStatusType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See TaskStatusType
  2. See PaginatorConfigTypeDef

SynthesizeSpeechOutputTypeDef#

# SynthesizeSpeechOutputTypeDef definition

class SynthesizeSpeechOutputTypeDef(TypedDict):
    AudioStream: StreamingBody,
    ContentType: str,
    RequestCharacters: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeVoicesOutputTypeDef#

# DescribeVoicesOutputTypeDef definition

class DescribeVoicesOutputTypeDef(TypedDict):
    Voices: List[VoiceTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See VoiceTypeDef
  2. See ResponseMetadataTypeDef

LexiconDescriptionTypeDef#

# LexiconDescriptionTypeDef definition

class LexiconDescriptionTypeDef(TypedDict):
    Name: NotRequired[str],
    Attributes: NotRequired[LexiconAttributesTypeDef],  # (1)
  1. See LexiconAttributesTypeDef

GetLexiconOutputTypeDef#

# GetLexiconOutputTypeDef definition

class GetLexiconOutputTypeDef(TypedDict):
    Lexicon: LexiconTypeDef,  # (1)
    LexiconAttributes: LexiconAttributesTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See LexiconTypeDef
  2. See LexiconAttributesTypeDef
  3. See ResponseMetadataTypeDef

GetSpeechSynthesisTaskOutputTypeDef#

# GetSpeechSynthesisTaskOutputTypeDef definition

class GetSpeechSynthesisTaskOutputTypeDef(TypedDict):
    SynthesisTask: SynthesisTaskTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SynthesisTaskTypeDef
  2. See ResponseMetadataTypeDef

ListSpeechSynthesisTasksOutputTypeDef#

# ListSpeechSynthesisTasksOutputTypeDef definition

class ListSpeechSynthesisTasksOutputTypeDef(TypedDict):
    NextToken: str,
    SynthesisTasks: List[SynthesisTaskTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SynthesisTaskTypeDef
  2. See ResponseMetadataTypeDef

StartSpeechSynthesisTaskOutputTypeDef#

# StartSpeechSynthesisTaskOutputTypeDef definition

class StartSpeechSynthesisTaskOutputTypeDef(TypedDict):
    SynthesisTask: SynthesisTaskTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SynthesisTaskTypeDef
  2. See ResponseMetadataTypeDef

ListLexiconsOutputTypeDef#

# ListLexiconsOutputTypeDef definition

class ListLexiconsOutputTypeDef(TypedDict):
    Lexicons: List[LexiconDescriptionTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See LexiconDescriptionTypeDef
  2. See ResponseMetadataTypeDef