Typed dictionaries
Index > PinpointSMSVoice > Typed dictionaries
Auto-generated documentation for PinpointSMSVoice type annotations stubs module mypy-boto3-sms-voice.
CallInstructionsMessageTypeTypeDef
Usage Example
from mypy_boto3_sms_voice.type_defs import CallInstructionsMessageTypeTypeDef
def get_value() -> CallInstructionsMessageTypeTypeDef:
return {
"Text": ...,
}
CloudWatchLogsDestinationTypeDef
Usage Example
from mypy_boto3_sms_voice.type_defs import CloudWatchLogsDestinationTypeDef
def get_value() -> CloudWatchLogsDestinationTypeDef:
return {
"IamRoleArn": ...,
}
Definition
class CloudWatchLogsDestinationTypeDef(TypedDict):
IamRoleArn: NotRequired[str],
LogGroupArn: NotRequired[str],
CreateConfigurationSetRequestRequestTypeDef
Usage Example
from mypy_boto3_sms_voice.type_defs import CreateConfigurationSetRequestRequestTypeDef
def get_value() -> CreateConfigurationSetRequestRequestTypeDef:
return {
"ConfigurationSetName": ...,
}
Definition
class CreateConfigurationSetRequestRequestTypeDef(TypedDict):
ConfigurationSetName: NotRequired[str],
DeleteConfigurationSetEventDestinationRequestRequestTypeDef
Usage Example
from mypy_boto3_sms_voice.type_defs import DeleteConfigurationSetEventDestinationRequestRequestTypeDef
def get_value() -> DeleteConfigurationSetEventDestinationRequestRequestTypeDef:
return {
"ConfigurationSetName": ...,
"EventDestinationName": ...,
}
Definition
class DeleteConfigurationSetEventDestinationRequestRequestTypeDef(TypedDict):
ConfigurationSetName: str,
EventDestinationName: str,
DeleteConfigurationSetRequestRequestTypeDef
Usage Example
from mypy_boto3_sms_voice.type_defs import DeleteConfigurationSetRequestRequestTypeDef
def get_value() -> DeleteConfigurationSetRequestRequestTypeDef:
return {
"ConfigurationSetName": ...,
}
KinesisFirehoseDestinationTypeDef
Usage Example
from mypy_boto3_sms_voice.type_defs import KinesisFirehoseDestinationTypeDef
def get_value() -> KinesisFirehoseDestinationTypeDef:
return {
"DeliveryStreamArn": ...,
}
Definition
class KinesisFirehoseDestinationTypeDef(TypedDict):
DeliveryStreamArn: NotRequired[str],
IamRoleArn: NotRequired[str],
SnsDestinationTypeDef
Usage Example
from mypy_boto3_sms_voice.type_defs import SnsDestinationTypeDef
def get_value() -> SnsDestinationTypeDef:
return {
"TopicArn": ...,
}
GetConfigurationSetEventDestinationsRequestRequestTypeDef
Usage Example
from mypy_boto3_sms_voice.type_defs import GetConfigurationSetEventDestinationsRequestRequestTypeDef
def get_value() -> GetConfigurationSetEventDestinationsRequestRequestTypeDef:
return {
"ConfigurationSetName": ...,
}
Definition
class GetConfigurationSetEventDestinationsRequestRequestTypeDef(TypedDict):
ConfigurationSetName: str,
ResponseMetadataTypeDef
Usage Example
from mypy_boto3_sms_voice.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,
ListConfigurationSetsRequestRequestTypeDef
Usage Example
from mypy_boto3_sms_voice.type_defs import ListConfigurationSetsRequestRequestTypeDef
def get_value() -> ListConfigurationSetsRequestRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class ListConfigurationSetsRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
PageSize: NotRequired[str],
PlainTextMessageTypeTypeDef
Usage Example
from mypy_boto3_sms_voice.type_defs import PlainTextMessageTypeTypeDef
def get_value() -> PlainTextMessageTypeTypeDef:
return {
"LanguageCode": ...,
}
Definition
class PlainTextMessageTypeTypeDef(TypedDict):
LanguageCode: NotRequired[str],
Text: NotRequired[str],
VoiceId: NotRequired[str],
SSMLMessageTypeTypeDef
Usage Example
from mypy_boto3_sms_voice.type_defs import SSMLMessageTypeTypeDef
def get_value() -> SSMLMessageTypeTypeDef:
return {
"LanguageCode": ...,
}
Definition
class SSMLMessageTypeTypeDef(TypedDict):
LanguageCode: NotRequired[str],
Text: NotRequired[str],
VoiceId: NotRequired[str],
EventDestinationDefinitionTypeDef
Usage Example
from mypy_boto3_sms_voice.type_defs import EventDestinationDefinitionTypeDef
def get_value() -> EventDestinationDefinitionTypeDef:
return {
"CloudWatchLogsDestination": ...,
}
Definition
class EventDestinationDefinitionTypeDef(TypedDict):
CloudWatchLogsDestination: NotRequired[CloudWatchLogsDestinationTypeDef], # (1)
Enabled: NotRequired[bool],
KinesisFirehoseDestination: NotRequired[KinesisFirehoseDestinationTypeDef], # (2)
MatchingEventTypes: NotRequired[Sequence[EventTypeType]], # (3)
SnsDestination: NotRequired[SnsDestinationTypeDef], # (4)
- See CloudWatchLogsDestinationTypeDef
- See KinesisFirehoseDestinationTypeDef
- See EventTypeType
- See SnsDestinationTypeDef
EventDestinationTypeDef
Usage Example
from mypy_boto3_sms_voice.type_defs import EventDestinationTypeDef
def get_value() -> EventDestinationTypeDef:
return {
"CloudWatchLogsDestination": ...,
}
Definition
class EventDestinationTypeDef(TypedDict):
CloudWatchLogsDestination: NotRequired[CloudWatchLogsDestinationTypeDef], # (1)
Enabled: NotRequired[bool],
KinesisFirehoseDestination: NotRequired[KinesisFirehoseDestinationTypeDef], # (2)
MatchingEventTypes: NotRequired[List[EventTypeType]], # (3)
Name: NotRequired[str],
SnsDestination: NotRequired[SnsDestinationTypeDef], # (4)
- See CloudWatchLogsDestinationTypeDef
- See KinesisFirehoseDestinationTypeDef
- See EventTypeType
- See SnsDestinationTypeDef
ListConfigurationSetsResponseTypeDef
Usage Example
from mypy_boto3_sms_voice.type_defs import ListConfigurationSetsResponseTypeDef
def get_value() -> ListConfigurationSetsResponseTypeDef:
return {
"ConfigurationSets": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListConfigurationSetsResponseTypeDef(TypedDict):
ConfigurationSets: List[str],
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
SendVoiceMessageResponseTypeDef
Usage Example
from mypy_boto3_sms_voice.type_defs import SendVoiceMessageResponseTypeDef
def get_value() -> SendVoiceMessageResponseTypeDef:
return {
"MessageId": ...,
"ResponseMetadata": ...,
}
Definition
class SendVoiceMessageResponseTypeDef(TypedDict):
MessageId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
VoiceMessageContentTypeDef
Usage Example
from mypy_boto3_sms_voice.type_defs import VoiceMessageContentTypeDef
def get_value() -> VoiceMessageContentTypeDef:
return {
"CallInstructionsMessage": ...,
}
Definition
class VoiceMessageContentTypeDef(TypedDict):
CallInstructionsMessage: NotRequired[CallInstructionsMessageTypeTypeDef], # (1)
PlainTextMessage: NotRequired[PlainTextMessageTypeTypeDef], # (2)
SSMLMessage: NotRequired[SSMLMessageTypeTypeDef], # (3)
CreateConfigurationSetEventDestinationRequestRequestTypeDef
Usage Example
from mypy_boto3_sms_voice.type_defs import CreateConfigurationSetEventDestinationRequestRequestTypeDef
def get_value() -> CreateConfigurationSetEventDestinationRequestRequestTypeDef:
return {
"ConfigurationSetName": ...,
}
Definition
class CreateConfigurationSetEventDestinationRequestRequestTypeDef(TypedDict):
ConfigurationSetName: str,
EventDestination: NotRequired[EventDestinationDefinitionTypeDef], # (1)
EventDestinationName: NotRequired[str],
UpdateConfigurationSetEventDestinationRequestRequestTypeDef
Usage Example
from mypy_boto3_sms_voice.type_defs import UpdateConfigurationSetEventDestinationRequestRequestTypeDef
def get_value() -> UpdateConfigurationSetEventDestinationRequestRequestTypeDef:
return {
"ConfigurationSetName": ...,
"EventDestinationName": ...,
}
Definition
class UpdateConfigurationSetEventDestinationRequestRequestTypeDef(TypedDict):
ConfigurationSetName: str,
EventDestinationName: str,
EventDestination: NotRequired[EventDestinationDefinitionTypeDef], # (1)
GetConfigurationSetEventDestinationsResponseTypeDef
Usage Example
from mypy_boto3_sms_voice.type_defs import GetConfigurationSetEventDestinationsResponseTypeDef
def get_value() -> GetConfigurationSetEventDestinationsResponseTypeDef:
return {
"EventDestinations": ...,
"ResponseMetadata": ...,
}
Definition
class GetConfigurationSetEventDestinationsResponseTypeDef(TypedDict):
EventDestinations: List[EventDestinationTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SendVoiceMessageRequestRequestTypeDef
Usage Example
from mypy_boto3_sms_voice.type_defs import SendVoiceMessageRequestRequestTypeDef
def get_value() -> SendVoiceMessageRequestRequestTypeDef:
return {
"CallerId": ...,
}