Typed dictionaries#
Auto-generated documentation for Polly type annotations stubs module mypy-boto3-polly.
DeleteLexiconInputRequestTypeDef#
# DeleteLexiconInputRequestTypeDef usage example
from mypy_boto3_polly.type_defs import DeleteLexiconInputRequestTypeDef
def get_value() -> DeleteLexiconInputRequestTypeDef:
return {
"Name": ...,
}
# DeleteLexiconInputRequestTypeDef definition
class DeleteLexiconInputRequestTypeDef(TypedDict):
Name: str,
DescribeVoicesInputDescribeVoicesPaginateTypeDef#
# DescribeVoicesInputDescribeVoicesPaginateTypeDef usage example
from mypy_boto3_polly.type_defs import DescribeVoicesInputDescribeVoicesPaginateTypeDef
def get_value() -> DescribeVoicesInputDescribeVoicesPaginateTypeDef:
return {
"Engine": ...,
}
# DescribeVoicesInputDescribeVoicesPaginateTypeDef definition
class DescribeVoicesInputDescribeVoicesPaginateTypeDef(TypedDict):
Engine: NotRequired[EngineType], # (1)
LanguageCode: NotRequired[LanguageCodeType], # (2)
IncludeAdditionalLanguageCodes: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)
- See EngineType
- See LanguageCodeType
- See PaginatorConfigTypeDef
DescribeVoicesInputRequestTypeDef#
# DescribeVoicesInputRequestTypeDef usage example
from mypy_boto3_polly.type_defs import DescribeVoicesInputRequestTypeDef
def get_value() -> DescribeVoicesInputRequestTypeDef:
return {
"Engine": ...,
}
# DescribeVoicesInputRequestTypeDef definition
class DescribeVoicesInputRequestTypeDef(TypedDict):
Engine: NotRequired[EngineType], # (1)
LanguageCode: NotRequired[LanguageCodeType], # (2)
IncludeAdditionalLanguageCodes: NotRequired[bool],
NextToken: NotRequired[str],
- See EngineType
- See LanguageCodeType
VoiceTypeDef#
# VoiceTypeDef usage example
from mypy_boto3_polly.type_defs import VoiceTypeDef
def get_value() -> VoiceTypeDef:
return {
"Gender": ...,
}
# 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)
- See GenderType
- See VoiceIdType
- See LanguageCodeType
- See LanguageCodeType
- See EngineType
GetLexiconInputRequestTypeDef#
# GetLexiconInputRequestTypeDef usage example
from mypy_boto3_polly.type_defs import GetLexiconInputRequestTypeDef
def get_value() -> GetLexiconInputRequestTypeDef:
return {
"Name": ...,
}
# GetLexiconInputRequestTypeDef definition
class GetLexiconInputRequestTypeDef(TypedDict):
Name: str,
LexiconAttributesTypeDef#
# LexiconAttributesTypeDef usage example
from mypy_boto3_polly.type_defs import LexiconAttributesTypeDef
def get_value() -> LexiconAttributesTypeDef:
return {
"Alphabet": ...,
}
# LexiconAttributesTypeDef definition
class LexiconAttributesTypeDef(TypedDict):
Alphabet: NotRequired[str],
LanguageCode: NotRequired[LanguageCodeType], # (1)
LastModified: NotRequired[datetime],
LexiconArn: NotRequired[str],
LexemesCount: NotRequired[int],
Size: NotRequired[int],
- See LanguageCodeType
LexiconTypeDef#
# LexiconTypeDef usage example
from mypy_boto3_polly.type_defs import LexiconTypeDef
def get_value() -> LexiconTypeDef:
return {
"Content": ...,
}
# LexiconTypeDef definition
class LexiconTypeDef(TypedDict):
Content: NotRequired[str],
Name: NotRequired[str],
GetSpeechSynthesisTaskInputRequestTypeDef#
# GetSpeechSynthesisTaskInputRequestTypeDef usage example
from mypy_boto3_polly.type_defs import GetSpeechSynthesisTaskInputRequestTypeDef
def get_value() -> GetSpeechSynthesisTaskInputRequestTypeDef:
return {
"TaskId": ...,
}
# GetSpeechSynthesisTaskInputRequestTypeDef definition
class GetSpeechSynthesisTaskInputRequestTypeDef(TypedDict):
TaskId: str,
SynthesisTaskTypeDef#
# SynthesisTaskTypeDef usage example
from mypy_boto3_polly.type_defs import SynthesisTaskTypeDef
def get_value() -> SynthesisTaskTypeDef:
return {
"Engine": ...,
}
# 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)
- See EngineType
- See TaskStatusType
- See OutputFormatType
- See SpeechMarkTypeType
- See TextTypeType
- See VoiceIdType
- See LanguageCodeType
ListLexiconsInputListLexiconsPaginateTypeDef#
# ListLexiconsInputListLexiconsPaginateTypeDef usage example
from mypy_boto3_polly.type_defs import ListLexiconsInputListLexiconsPaginateTypeDef
def get_value() -> ListLexiconsInputListLexiconsPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# ListLexiconsInputListLexiconsPaginateTypeDef definition
class ListLexiconsInputListLexiconsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListLexiconsInputRequestTypeDef#
# ListLexiconsInputRequestTypeDef usage example
from mypy_boto3_polly.type_defs import ListLexiconsInputRequestTypeDef
def get_value() -> ListLexiconsInputRequestTypeDef:
return {
"NextToken": ...,
}
# ListLexiconsInputRequestTypeDef definition
class ListLexiconsInputRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
ListSpeechSynthesisTasksInputListSpeechSynthesisTasksPaginateTypeDef#
# ListSpeechSynthesisTasksInputListSpeechSynthesisTasksPaginateTypeDef usage example
from mypy_boto3_polly.type_defs import ListSpeechSynthesisTasksInputListSpeechSynthesisTasksPaginateTypeDef
def get_value() -> ListSpeechSynthesisTasksInputListSpeechSynthesisTasksPaginateTypeDef:
return {
"Status": ...,
}
# ListSpeechSynthesisTasksInputListSpeechSynthesisTasksPaginateTypeDef definition
class ListSpeechSynthesisTasksInputListSpeechSynthesisTasksPaginateTypeDef(TypedDict):
Status: NotRequired[TaskStatusType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
- See TaskStatusType
- See PaginatorConfigTypeDef
ListSpeechSynthesisTasksInputRequestTypeDef#
# ListSpeechSynthesisTasksInputRequestTypeDef usage example
from mypy_boto3_polly.type_defs import ListSpeechSynthesisTasksInputRequestTypeDef
def get_value() -> ListSpeechSynthesisTasksInputRequestTypeDef:
return {
"MaxResults": ...,
}
# ListSpeechSynthesisTasksInputRequestTypeDef definition
class ListSpeechSynthesisTasksInputRequestTypeDef(TypedDict):
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
Status: NotRequired[TaskStatusType], # (1)
- See TaskStatusType
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef usage example
from mypy_boto3_polly.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
PutLexiconInputRequestTypeDef#
# PutLexiconInputRequestTypeDef usage example
from mypy_boto3_polly.type_defs import PutLexiconInputRequestTypeDef
def get_value() -> PutLexiconInputRequestTypeDef:
return {
"Name": ...,
"Content": ...,
}
# PutLexiconInputRequestTypeDef definition
class PutLexiconInputRequestTypeDef(TypedDict):
Name: str,
Content: str,
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef usage example
from mypy_boto3_polly.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
StartSpeechSynthesisTaskInputRequestTypeDef#
# StartSpeechSynthesisTaskInputRequestTypeDef usage example
from mypy_boto3_polly.type_defs import StartSpeechSynthesisTaskInputRequestTypeDef
def get_value() -> StartSpeechSynthesisTaskInputRequestTypeDef:
return {
"OutputFormat": ...,
"OutputS3BucketName": ...,
"Text": ...,
"VoiceId": ...,
}
# 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)
- See OutputFormatType
- See VoiceIdType
- See EngineType
- See LanguageCodeType
- See SpeechMarkTypeType
- See TextTypeType
SynthesizeSpeechInputRequestTypeDef#
# SynthesizeSpeechInputRequestTypeDef usage example
from mypy_boto3_polly.type_defs import SynthesizeSpeechInputRequestTypeDef
def get_value() -> SynthesizeSpeechInputRequestTypeDef:
return {
"OutputFormat": ...,
"Text": ...,
"VoiceId": ...,
}
# 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)
- See OutputFormatType
- See VoiceIdType
- See EngineType
- See LanguageCodeType
- See SpeechMarkTypeType
- See TextTypeType
SynthesizeSpeechOutputTypeDef#
# SynthesizeSpeechOutputTypeDef usage example
from mypy_boto3_polly.type_defs import SynthesizeSpeechOutputTypeDef
def get_value() -> SynthesizeSpeechOutputTypeDef:
return {
"AudioStream": ...,
"ContentType": ...,
"RequestCharacters": ...,
"ResponseMetadata": ...,
}
# SynthesizeSpeechOutputTypeDef definition
class SynthesizeSpeechOutputTypeDef(TypedDict):
AudioStream: StreamingBody,
ContentType: str,
RequestCharacters: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeVoicesOutputTypeDef#
# DescribeVoicesOutputTypeDef usage example
from mypy_boto3_polly.type_defs import DescribeVoicesOutputTypeDef
def get_value() -> DescribeVoicesOutputTypeDef:
return {
"Voices": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# DescribeVoicesOutputTypeDef definition
class DescribeVoicesOutputTypeDef(TypedDict):
Voices: List[VoiceTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See VoiceTypeDef
- See ResponseMetadataTypeDef
LexiconDescriptionTypeDef#
# LexiconDescriptionTypeDef usage example
from mypy_boto3_polly.type_defs import LexiconDescriptionTypeDef
def get_value() -> LexiconDescriptionTypeDef:
return {
"Name": ...,
}
# LexiconDescriptionTypeDef definition
class LexiconDescriptionTypeDef(TypedDict):
Name: NotRequired[str],
Attributes: NotRequired[LexiconAttributesTypeDef], # (1)
GetLexiconOutputTypeDef#
# GetLexiconOutputTypeDef usage example
from mypy_boto3_polly.type_defs import GetLexiconOutputTypeDef
def get_value() -> GetLexiconOutputTypeDef:
return {
"Lexicon": ...,
"LexiconAttributes": ...,
"ResponseMetadata": ...,
}
# GetLexiconOutputTypeDef definition
class GetLexiconOutputTypeDef(TypedDict):
Lexicon: LexiconTypeDef, # (1)
LexiconAttributes: LexiconAttributesTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
GetSpeechSynthesisTaskOutputTypeDef#
# GetSpeechSynthesisTaskOutputTypeDef usage example
from mypy_boto3_polly.type_defs import GetSpeechSynthesisTaskOutputTypeDef
def get_value() -> GetSpeechSynthesisTaskOutputTypeDef:
return {
"SynthesisTask": ...,
"ResponseMetadata": ...,
}
# GetSpeechSynthesisTaskOutputTypeDef definition
class GetSpeechSynthesisTaskOutputTypeDef(TypedDict):
SynthesisTask: SynthesisTaskTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListSpeechSynthesisTasksOutputTypeDef#
# ListSpeechSynthesisTasksOutputTypeDef usage example
from mypy_boto3_polly.type_defs import ListSpeechSynthesisTasksOutputTypeDef
def get_value() -> ListSpeechSynthesisTasksOutputTypeDef:
return {
"NextToken": ...,
"SynthesisTasks": ...,
"ResponseMetadata": ...,
}
# ListSpeechSynthesisTasksOutputTypeDef definition
class ListSpeechSynthesisTasksOutputTypeDef(TypedDict):
NextToken: str,
SynthesisTasks: List[SynthesisTaskTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StartSpeechSynthesisTaskOutputTypeDef#
# StartSpeechSynthesisTaskOutputTypeDef usage example
from mypy_boto3_polly.type_defs import StartSpeechSynthesisTaskOutputTypeDef
def get_value() -> StartSpeechSynthesisTaskOutputTypeDef:
return {
"SynthesisTask": ...,
"ResponseMetadata": ...,
}
# StartSpeechSynthesisTaskOutputTypeDef definition
class StartSpeechSynthesisTaskOutputTypeDef(TypedDict):
SynthesisTask: SynthesisTaskTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListLexiconsOutputTypeDef#
# ListLexiconsOutputTypeDef usage example
from mypy_boto3_polly.type_defs import ListLexiconsOutputTypeDef
def get_value() -> ListLexiconsOutputTypeDef:
return {
"Lexicons": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# ListLexiconsOutputTypeDef definition
class ListLexiconsOutputTypeDef(TypedDict):
Lexicons: List[LexiconDescriptionTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)