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