Typed dictionaries#
Auto-generated documentation for Pinpoint type annotations stubs module mypy-boto3-pinpoint.
ADMChannelRequestTypeDef#
# ADMChannelRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import ADMChannelRequestTypeDef
def get_value() -> ADMChannelRequestTypeDef:
return {
"ClientId": ...,
"ClientSecret": ...,
}# ADMChannelRequestTypeDef definition
class ADMChannelRequestTypeDef(TypedDict):
ClientId: str,
ClientSecret: str,
Enabled: NotRequired[bool],ADMChannelResponseTypeDef#
# ADMChannelResponseTypeDef usage example
from mypy_boto3_pinpoint.type_defs import ADMChannelResponseTypeDef
def get_value() -> ADMChannelResponseTypeDef:
return {
"Platform": ...,
}# ADMChannelResponseTypeDef definition
class ADMChannelResponseTypeDef(TypedDict):
Platform: str,
ApplicationId: NotRequired[str],
CreationDate: NotRequired[str],
Enabled: NotRequired[bool],
HasCredential: NotRequired[bool],
Id: NotRequired[str],
IsArchived: NotRequired[bool],
LastModifiedBy: NotRequired[str],
LastModifiedDate: NotRequired[str],
Version: NotRequired[int],ADMMessageTypeDef#
# ADMMessageTypeDef usage example
from mypy_boto3_pinpoint.type_defs import ADMMessageTypeDef
def get_value() -> ADMMessageTypeDef:
return {
"Action": ...,
}# ADMMessageTypeDef definition
class ADMMessageTypeDef(TypedDict):
Action: NotRequired[ActionType], # (1)
Body: NotRequired[str],
ConsolidationKey: NotRequired[str],
Data: NotRequired[Mapping[str, str]],
ExpiresAfter: NotRequired[str],
IconReference: NotRequired[str],
ImageIconUrl: NotRequired[str],
ImageUrl: NotRequired[str],
MD5: NotRequired[str],
RawContent: NotRequired[str],
SilentPush: NotRequired[bool],
SmallImageIconUrl: NotRequired[str],
Sound: NotRequired[str],
Substitutions: NotRequired[Mapping[str, Sequence[str]]],
Title: NotRequired[str],
Url: NotRequired[str],- See ActionType
APNSChannelRequestTypeDef#
# APNSChannelRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import APNSChannelRequestTypeDef
def get_value() -> APNSChannelRequestTypeDef:
return {
"BundleId": ...,
}# APNSChannelRequestTypeDef definition
class APNSChannelRequestTypeDef(TypedDict):
BundleId: NotRequired[str],
Certificate: NotRequired[str],
DefaultAuthenticationMethod: NotRequired[str],
Enabled: NotRequired[bool],
PrivateKey: NotRequired[str],
TeamId: NotRequired[str],
TokenKey: NotRequired[str],
TokenKeyId: NotRequired[str],APNSChannelResponseTypeDef#
# APNSChannelResponseTypeDef usage example
from mypy_boto3_pinpoint.type_defs import APNSChannelResponseTypeDef
def get_value() -> APNSChannelResponseTypeDef:
return {
"Platform": ...,
}# APNSChannelResponseTypeDef definition
class APNSChannelResponseTypeDef(TypedDict):
Platform: str,
ApplicationId: NotRequired[str],
CreationDate: NotRequired[str],
DefaultAuthenticationMethod: NotRequired[str],
Enabled: NotRequired[bool],
HasCredential: NotRequired[bool],
HasTokenKey: NotRequired[bool],
Id: NotRequired[str],
IsArchived: NotRequired[bool],
LastModifiedBy: NotRequired[str],
LastModifiedDate: NotRequired[str],
Version: NotRequired[int],APNSMessageTypeDef#
# APNSMessageTypeDef usage example
from mypy_boto3_pinpoint.type_defs import APNSMessageTypeDef
def get_value() -> APNSMessageTypeDef:
return {
"APNSPushType": ...,
}# APNSMessageTypeDef definition
class APNSMessageTypeDef(TypedDict):
APNSPushType: NotRequired[str],
Action: NotRequired[ActionType], # (1)
Badge: NotRequired[int],
Body: NotRequired[str],
Category: NotRequired[str],
CollapseId: NotRequired[str],
Data: NotRequired[Mapping[str, str]],
MediaUrl: NotRequired[str],
PreferredAuthenticationMethod: NotRequired[str],
Priority: NotRequired[str],
RawContent: NotRequired[str],
SilentPush: NotRequired[bool],
Sound: NotRequired[str],
Substitutions: NotRequired[Mapping[str, Sequence[str]]],
ThreadId: NotRequired[str],
TimeToLive: NotRequired[int],
Title: NotRequired[str],
Url: NotRequired[str],- See ActionType
APNSPushNotificationTemplateTypeDef#
# APNSPushNotificationTemplateTypeDef usage example
from mypy_boto3_pinpoint.type_defs import APNSPushNotificationTemplateTypeDef
def get_value() -> APNSPushNotificationTemplateTypeDef:
return {
"Action": ...,
}# APNSPushNotificationTemplateTypeDef definition
class APNSPushNotificationTemplateTypeDef(TypedDict):
Action: NotRequired[ActionType], # (1)
Body: NotRequired[str],
MediaUrl: NotRequired[str],
RawContent: NotRequired[str],
Sound: NotRequired[str],
Title: NotRequired[str],
Url: NotRequired[str],- See ActionType
APNSSandboxChannelRequestTypeDef#
# APNSSandboxChannelRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import APNSSandboxChannelRequestTypeDef
def get_value() -> APNSSandboxChannelRequestTypeDef:
return {
"BundleId": ...,
}# APNSSandboxChannelRequestTypeDef definition
class APNSSandboxChannelRequestTypeDef(TypedDict):
BundleId: NotRequired[str],
Certificate: NotRequired[str],
DefaultAuthenticationMethod: NotRequired[str],
Enabled: NotRequired[bool],
PrivateKey: NotRequired[str],
TeamId: NotRequired[str],
TokenKey: NotRequired[str],
TokenKeyId: NotRequired[str],APNSSandboxChannelResponseTypeDef#
# APNSSandboxChannelResponseTypeDef usage example
from mypy_boto3_pinpoint.type_defs import APNSSandboxChannelResponseTypeDef
def get_value() -> APNSSandboxChannelResponseTypeDef:
return {
"Platform": ...,
}# APNSSandboxChannelResponseTypeDef definition
class APNSSandboxChannelResponseTypeDef(TypedDict):
Platform: str,
ApplicationId: NotRequired[str],
CreationDate: NotRequired[str],
DefaultAuthenticationMethod: NotRequired[str],
Enabled: NotRequired[bool],
HasCredential: NotRequired[bool],
HasTokenKey: NotRequired[bool],
Id: NotRequired[str],
IsArchived: NotRequired[bool],
LastModifiedBy: NotRequired[str],
LastModifiedDate: NotRequired[str],
Version: NotRequired[int],APNSVoipChannelRequestTypeDef#
# APNSVoipChannelRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import APNSVoipChannelRequestTypeDef
def get_value() -> APNSVoipChannelRequestTypeDef:
return {
"BundleId": ...,
}# APNSVoipChannelRequestTypeDef definition
class APNSVoipChannelRequestTypeDef(TypedDict):
BundleId: NotRequired[str],
Certificate: NotRequired[str],
DefaultAuthenticationMethod: NotRequired[str],
Enabled: NotRequired[bool],
PrivateKey: NotRequired[str],
TeamId: NotRequired[str],
TokenKey: NotRequired[str],
TokenKeyId: NotRequired[str],APNSVoipChannelResponseTypeDef#
# APNSVoipChannelResponseTypeDef usage example
from mypy_boto3_pinpoint.type_defs import APNSVoipChannelResponseTypeDef
def get_value() -> APNSVoipChannelResponseTypeDef:
return {
"Platform": ...,
}# APNSVoipChannelResponseTypeDef definition
class APNSVoipChannelResponseTypeDef(TypedDict):
Platform: str,
ApplicationId: NotRequired[str],
CreationDate: NotRequired[str],
DefaultAuthenticationMethod: NotRequired[str],
Enabled: NotRequired[bool],
HasCredential: NotRequired[bool],
HasTokenKey: NotRequired[bool],
Id: NotRequired[str],
IsArchived: NotRequired[bool],
LastModifiedBy: NotRequired[str],
LastModifiedDate: NotRequired[str],
Version: NotRequired[int],APNSVoipSandboxChannelRequestTypeDef#
# APNSVoipSandboxChannelRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import APNSVoipSandboxChannelRequestTypeDef
def get_value() -> APNSVoipSandboxChannelRequestTypeDef:
return {
"BundleId": ...,
}# APNSVoipSandboxChannelRequestTypeDef definition
class APNSVoipSandboxChannelRequestTypeDef(TypedDict):
BundleId: NotRequired[str],
Certificate: NotRequired[str],
DefaultAuthenticationMethod: NotRequired[str],
Enabled: NotRequired[bool],
PrivateKey: NotRequired[str],
TeamId: NotRequired[str],
TokenKey: NotRequired[str],
TokenKeyId: NotRequired[str],APNSVoipSandboxChannelResponseTypeDef#
# APNSVoipSandboxChannelResponseTypeDef usage example
from mypy_boto3_pinpoint.type_defs import APNSVoipSandboxChannelResponseTypeDef
def get_value() -> APNSVoipSandboxChannelResponseTypeDef:
return {
"Platform": ...,
}# APNSVoipSandboxChannelResponseTypeDef definition
class APNSVoipSandboxChannelResponseTypeDef(TypedDict):
Platform: str,
ApplicationId: NotRequired[str],
CreationDate: NotRequired[str],
DefaultAuthenticationMethod: NotRequired[str],
Enabled: NotRequired[bool],
HasCredential: NotRequired[bool],
HasTokenKey: NotRequired[bool],
Id: NotRequired[str],
IsArchived: NotRequired[bool],
LastModifiedBy: NotRequired[str],
LastModifiedDate: NotRequired[str],
Version: NotRequired[int],ActivityResponseTypeDef#
# ActivityResponseTypeDef usage example
from mypy_boto3_pinpoint.type_defs import ActivityResponseTypeDef
def get_value() -> ActivityResponseTypeDef:
return {
"ApplicationId": ...,
"CampaignId": ...,
"Id": ...,
}# ActivityResponseTypeDef definition
class ActivityResponseTypeDef(TypedDict):
ApplicationId: str,
CampaignId: str,
Id: str,
End: NotRequired[str],
Result: NotRequired[str],
ScheduledStart: NotRequired[str],
Start: NotRequired[str],
State: NotRequired[str],
SuccessfulEndpointCount: NotRequired[int],
TimezonesCompletedCount: NotRequired[int],
TimezonesTotalCount: NotRequired[int],
TotalEndpointCount: NotRequired[int],
TreatmentId: NotRequired[str],
ExecutionMetrics: NotRequired[Dict[str, str]],ContactCenterActivityTypeDef#
# ContactCenterActivityTypeDef usage example
from mypy_boto3_pinpoint.type_defs import ContactCenterActivityTypeDef
def get_value() -> ContactCenterActivityTypeDef:
return {
"NextActivity": ...,
}# ContactCenterActivityTypeDef definition
class ContactCenterActivityTypeDef(TypedDict):
NextActivity: NotRequired[str],HoldoutActivityTypeDef#
# HoldoutActivityTypeDef usage example
from mypy_boto3_pinpoint.type_defs import HoldoutActivityTypeDef
def get_value() -> HoldoutActivityTypeDef:
return {
"Percentage": ...,
}# HoldoutActivityTypeDef definition
class HoldoutActivityTypeDef(TypedDict):
Percentage: int,
NextActivity: NotRequired[str],AddressConfigurationTypeDef#
# AddressConfigurationTypeDef usage example
from mypy_boto3_pinpoint.type_defs import AddressConfigurationTypeDef
def get_value() -> AddressConfigurationTypeDef:
return {
"BodyOverride": ...,
}# AddressConfigurationTypeDef definition
class AddressConfigurationTypeDef(TypedDict):
BodyOverride: NotRequired[str],
ChannelType: NotRequired[ChannelTypeType], # (1)
Context: NotRequired[Mapping[str, str]],
RawContent: NotRequired[str],
Substitutions: NotRequired[Mapping[str, Sequence[str]]],
TitleOverride: NotRequired[str],- See ChannelTypeType
AndroidPushNotificationTemplateTypeDef#
# AndroidPushNotificationTemplateTypeDef usage example
from mypy_boto3_pinpoint.type_defs import AndroidPushNotificationTemplateTypeDef
def get_value() -> AndroidPushNotificationTemplateTypeDef:
return {
"Action": ...,
}# AndroidPushNotificationTemplateTypeDef definition
class AndroidPushNotificationTemplateTypeDef(TypedDict):
Action: NotRequired[ActionType], # (1)
Body: NotRequired[str],
ImageIconUrl: NotRequired[str],
ImageUrl: NotRequired[str],
RawContent: NotRequired[str],
SmallImageIconUrl: NotRequired[str],
Sound: NotRequired[str],
Title: NotRequired[str],
Url: NotRequired[str],- See ActionType
ApplicationResponseTypeDef#
# ApplicationResponseTypeDef usage example
from mypy_boto3_pinpoint.type_defs import ApplicationResponseTypeDef
def get_value() -> ApplicationResponseTypeDef:
return {
"Arn": ...,
"Id": ...,
"Name": ...,
}# ApplicationResponseTypeDef definition
class ApplicationResponseTypeDef(TypedDict):
Arn: str,
Id: str,
Name: str,
tags: NotRequired[Dict[str, str]],
CreationDate: NotRequired[str],CampaignHookTypeDef#
# CampaignHookTypeDef usage example
from mypy_boto3_pinpoint.type_defs import CampaignHookTypeDef
def get_value() -> CampaignHookTypeDef:
return {
"LambdaFunctionName": ...,
}# CampaignHookTypeDef definition
class CampaignHookTypeDef(TypedDict):
LambdaFunctionName: NotRequired[str],
Mode: NotRequired[ModeType], # (1)
WebUrl: NotRequired[str],- See ModeType
CampaignLimitsTypeDef#
# CampaignLimitsTypeDef usage example
from mypy_boto3_pinpoint.type_defs import CampaignLimitsTypeDef
def get_value() -> CampaignLimitsTypeDef:
return {
"Daily": ...,
}# CampaignLimitsTypeDef definition
class CampaignLimitsTypeDef(TypedDict):
Daily: NotRequired[int],
MaximumDuration: NotRequired[int],
MessagesPerSecond: NotRequired[int],
Total: NotRequired[int],
Session: NotRequired[int],QuietTimeTypeDef#
# QuietTimeTypeDef usage example
from mypy_boto3_pinpoint.type_defs import QuietTimeTypeDef
def get_value() -> QuietTimeTypeDef:
return {
"End": ...,
}# QuietTimeTypeDef definition
class QuietTimeTypeDef(TypedDict):
End: NotRequired[str],
Start: NotRequired[str],AttributeDimensionTypeDef#
# AttributeDimensionTypeDef usage example
from mypy_boto3_pinpoint.type_defs import AttributeDimensionTypeDef
def get_value() -> AttributeDimensionTypeDef:
return {
"Values": ...,
}# AttributeDimensionTypeDef definition
class AttributeDimensionTypeDef(TypedDict):
Values: Sequence[str],
AttributeType: NotRequired[AttributeTypeType], # (1)AttributesResourceTypeDef#
# AttributesResourceTypeDef usage example
from mypy_boto3_pinpoint.type_defs import AttributesResourceTypeDef
def get_value() -> AttributesResourceTypeDef:
return {
"ApplicationId": ...,
"AttributeType": ...,
}# AttributesResourceTypeDef definition
class AttributesResourceTypeDef(TypedDict):
ApplicationId: str,
AttributeType: str,
Attributes: NotRequired[List[str]],BaiduChannelRequestTypeDef#
# BaiduChannelRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import BaiduChannelRequestTypeDef
def get_value() -> BaiduChannelRequestTypeDef:
return {
"ApiKey": ...,
"SecretKey": ...,
}# BaiduChannelRequestTypeDef definition
class BaiduChannelRequestTypeDef(TypedDict):
ApiKey: str,
SecretKey: str,
Enabled: NotRequired[bool],BaiduChannelResponseTypeDef#
# BaiduChannelResponseTypeDef usage example
from mypy_boto3_pinpoint.type_defs import BaiduChannelResponseTypeDef
def get_value() -> BaiduChannelResponseTypeDef:
return {
"Credential": ...,
"Platform": ...,
}# BaiduChannelResponseTypeDef definition
class BaiduChannelResponseTypeDef(TypedDict):
Credential: str,
Platform: str,
ApplicationId: NotRequired[str],
CreationDate: NotRequired[str],
Enabled: NotRequired[bool],
HasCredential: NotRequired[bool],
Id: NotRequired[str],
IsArchived: NotRequired[bool],
LastModifiedBy: NotRequired[str],
LastModifiedDate: NotRequired[str],
Version: NotRequired[int],BaiduMessageTypeDef#
# BaiduMessageTypeDef usage example
from mypy_boto3_pinpoint.type_defs import BaiduMessageTypeDef
def get_value() -> BaiduMessageTypeDef:
return {
"Action": ...,
}# BaiduMessageTypeDef definition
class BaiduMessageTypeDef(TypedDict):
Action: NotRequired[ActionType], # (1)
Body: NotRequired[str],
Data: NotRequired[Mapping[str, str]],
IconReference: NotRequired[str],
ImageIconUrl: NotRequired[str],
ImageUrl: NotRequired[str],
RawContent: NotRequired[str],
SilentPush: NotRequired[bool],
SmallImageIconUrl: NotRequired[str],
Sound: NotRequired[str],
Substitutions: NotRequired[Mapping[str, Sequence[str]]],
TimeToLive: NotRequired[int],
Title: NotRequired[str],
Url: NotRequired[str],- See ActionType
CampaignCustomMessageTypeDef#
# CampaignCustomMessageTypeDef usage example
from mypy_boto3_pinpoint.type_defs import CampaignCustomMessageTypeDef
def get_value() -> CampaignCustomMessageTypeDef:
return {
"Data": ...,
}# CampaignCustomMessageTypeDef definition
class CampaignCustomMessageTypeDef(TypedDict):
Data: NotRequired[str],CampaignEmailMessageTypeDef#
# CampaignEmailMessageTypeDef usage example
from mypy_boto3_pinpoint.type_defs import CampaignEmailMessageTypeDef
def get_value() -> CampaignEmailMessageTypeDef:
return {
"Body": ...,
}# CampaignEmailMessageTypeDef definition
class CampaignEmailMessageTypeDef(TypedDict):
Body: NotRequired[str],
FromAddress: NotRequired[str],
HtmlBody: NotRequired[str],
Title: NotRequired[str],CampaignStateTypeDef#
# CampaignStateTypeDef usage example
from mypy_boto3_pinpoint.type_defs import CampaignStateTypeDef
def get_value() -> CampaignStateTypeDef:
return {
"CampaignStatus": ...,
}# CampaignStateTypeDef definition
class CampaignStateTypeDef(TypedDict):
CampaignStatus: NotRequired[CampaignStatusType], # (1)CustomDeliveryConfigurationTypeDef#
# CustomDeliveryConfigurationTypeDef usage example
from mypy_boto3_pinpoint.type_defs import CustomDeliveryConfigurationTypeDef
def get_value() -> CustomDeliveryConfigurationTypeDef:
return {
"DeliveryUri": ...,
}# CustomDeliveryConfigurationTypeDef definition
class CustomDeliveryConfigurationTypeDef(TypedDict):
DeliveryUri: str,
EndpointTypes: NotRequired[Sequence[EndpointTypesElementType]], # (1)CampaignSmsMessageTypeDef#
# CampaignSmsMessageTypeDef usage example
from mypy_boto3_pinpoint.type_defs import CampaignSmsMessageTypeDef
def get_value() -> CampaignSmsMessageTypeDef:
return {
"Body": ...,
}# CampaignSmsMessageTypeDef definition
class CampaignSmsMessageTypeDef(TypedDict):
Body: NotRequired[str],
MessageType: NotRequired[MessageTypeType], # (1)
OriginationNumber: NotRequired[str],
SenderId: NotRequired[str],
EntityId: NotRequired[str],
TemplateId: NotRequired[str],- See MessageTypeType
ChannelResponseTypeDef#
# ChannelResponseTypeDef usage example
from mypy_boto3_pinpoint.type_defs import ChannelResponseTypeDef
def get_value() -> ChannelResponseTypeDef:
return {
"ApplicationId": ...,
}# ChannelResponseTypeDef definition
class ChannelResponseTypeDef(TypedDict):
ApplicationId: NotRequired[str],
CreationDate: NotRequired[str],
Enabled: NotRequired[bool],
HasCredential: NotRequired[bool],
Id: NotRequired[str],
IsArchived: NotRequired[bool],
LastModifiedBy: NotRequired[str],
LastModifiedDate: NotRequired[str],
Version: NotRequired[int],ClosedDaysRuleTypeDef#
# ClosedDaysRuleTypeDef usage example
from mypy_boto3_pinpoint.type_defs import ClosedDaysRuleTypeDef
def get_value() -> ClosedDaysRuleTypeDef:
return {
"Name": ...,
}# ClosedDaysRuleTypeDef definition
class ClosedDaysRuleTypeDef(TypedDict):
Name: NotRequired[str],
StartDateTime: NotRequired[str],
EndDateTime: NotRequired[str],WaitTimeTypeDef#
# WaitTimeTypeDef usage example
from mypy_boto3_pinpoint.type_defs import WaitTimeTypeDef
def get_value() -> WaitTimeTypeDef:
return {
"WaitFor": ...,
}# WaitTimeTypeDef definition
class WaitTimeTypeDef(TypedDict):
WaitFor: NotRequired[str],
WaitUntil: NotRequired[str],CreateApplicationRequestTypeDef#
# CreateApplicationRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import CreateApplicationRequestTypeDef
def get_value() -> CreateApplicationRequestTypeDef:
return {
"Name": ...,
}# CreateApplicationRequestTypeDef definition
class CreateApplicationRequestTypeDef(TypedDict):
Name: str,
tags: NotRequired[Mapping[str, str]],EmailTemplateRequestTypeDef#
# EmailTemplateRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import EmailTemplateRequestTypeDef
def get_value() -> EmailTemplateRequestTypeDef:
return {
"DefaultSubstitutions": ...,
}# EmailTemplateRequestTypeDef definition
class EmailTemplateRequestTypeDef(TypedDict):
DefaultSubstitutions: NotRequired[str],
HtmlPart: NotRequired[str],
RecommenderId: NotRequired[str],
Subject: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
TemplateDescription: NotRequired[str],
TextPart: NotRequired[str],CreateTemplateMessageBodyTypeDef#
# CreateTemplateMessageBodyTypeDef usage example
from mypy_boto3_pinpoint.type_defs import CreateTemplateMessageBodyTypeDef
def get_value() -> CreateTemplateMessageBodyTypeDef:
return {
"Arn": ...,
}# CreateTemplateMessageBodyTypeDef definition
class CreateTemplateMessageBodyTypeDef(TypedDict):
Arn: NotRequired[str],
Message: NotRequired[str],
RequestID: NotRequired[str],ExportJobRequestTypeDef#
# ExportJobRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import ExportJobRequestTypeDef
def get_value() -> ExportJobRequestTypeDef:
return {
"RoleArn": ...,
"S3UrlPrefix": ...,
}# ExportJobRequestTypeDef definition
class ExportJobRequestTypeDef(TypedDict):
RoleArn: str,
S3UrlPrefix: str,
SegmentId: NotRequired[str],
SegmentVersion: NotRequired[int],ImportJobRequestTypeDef#
# ImportJobRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import ImportJobRequestTypeDef
def get_value() -> ImportJobRequestTypeDef:
return {
"Format": ...,
"RoleArn": ...,
"S3Url": ...,
}# ImportJobRequestTypeDef definition
class ImportJobRequestTypeDef(TypedDict):
Format: FormatType, # (1)
RoleArn: str,
S3Url: str,
DefineSegment: NotRequired[bool],
ExternalId: NotRequired[str],
RegisterEndpoints: NotRequired[bool],
SegmentId: NotRequired[str],
SegmentName: NotRequired[str],- See FormatType
TemplateCreateMessageBodyTypeDef#
# TemplateCreateMessageBodyTypeDef usage example
from mypy_boto3_pinpoint.type_defs import TemplateCreateMessageBodyTypeDef
def get_value() -> TemplateCreateMessageBodyTypeDef:
return {
"Arn": ...,
}# TemplateCreateMessageBodyTypeDef definition
class TemplateCreateMessageBodyTypeDef(TypedDict):
Arn: NotRequired[str],
Message: NotRequired[str],
RequestID: NotRequired[str],CreateRecommenderConfigurationTypeDef#
# CreateRecommenderConfigurationTypeDef usage example
from mypy_boto3_pinpoint.type_defs import CreateRecommenderConfigurationTypeDef
def get_value() -> CreateRecommenderConfigurationTypeDef:
return {
"RecommendationProviderRoleArn": ...,
"RecommendationProviderUri": ...,
}# CreateRecommenderConfigurationTypeDef definition
class CreateRecommenderConfigurationTypeDef(TypedDict):
RecommendationProviderRoleArn: str,
RecommendationProviderUri: str,
Attributes: NotRequired[Mapping[str, str]],
Description: NotRequired[str],
Name: NotRequired[str],
RecommendationProviderIdType: NotRequired[str],
RecommendationTransformerUri: NotRequired[str],
RecommendationsDisplayName: NotRequired[str],
RecommendationsPerMessage: NotRequired[int],RecommenderConfigurationResponseTypeDef#
# RecommenderConfigurationResponseTypeDef usage example
from mypy_boto3_pinpoint.type_defs import RecommenderConfigurationResponseTypeDef
def get_value() -> RecommenderConfigurationResponseTypeDef:
return {
"CreationDate": ...,
"Id": ...,
"LastModifiedDate": ...,
"RecommendationProviderRoleArn": ...,
"RecommendationProviderUri": ...,
}# RecommenderConfigurationResponseTypeDef definition
class RecommenderConfigurationResponseTypeDef(TypedDict):
CreationDate: str,
Id: str,
LastModifiedDate: str,
RecommendationProviderRoleArn: str,
RecommendationProviderUri: str,
Attributes: NotRequired[Dict[str, str]],
Description: NotRequired[str],
Name: NotRequired[str],
RecommendationProviderIdType: NotRequired[str],
RecommendationTransformerUri: NotRequired[str],
RecommendationsDisplayName: NotRequired[str],
RecommendationsPerMessage: NotRequired[int],SMSTemplateRequestTypeDef#
# SMSTemplateRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import SMSTemplateRequestTypeDef
def get_value() -> SMSTemplateRequestTypeDef:
return {
"Body": ...,
}# SMSTemplateRequestTypeDef definition
class SMSTemplateRequestTypeDef(TypedDict):
Body: NotRequired[str],
DefaultSubstitutions: NotRequired[str],
RecommenderId: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
TemplateDescription: NotRequired[str],VoiceTemplateRequestTypeDef#
# VoiceTemplateRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import VoiceTemplateRequestTypeDef
def get_value() -> VoiceTemplateRequestTypeDef:
return {
"Body": ...,
}# VoiceTemplateRequestTypeDef definition
class VoiceTemplateRequestTypeDef(TypedDict):
Body: NotRequired[str],
DefaultSubstitutions: NotRequired[str],
LanguageCode: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
TemplateDescription: NotRequired[str],
VoiceId: NotRequired[str],JourneyCustomMessageTypeDef#
# JourneyCustomMessageTypeDef usage example
from mypy_boto3_pinpoint.type_defs import JourneyCustomMessageTypeDef
def get_value() -> JourneyCustomMessageTypeDef:
return {
"Data": ...,
}# JourneyCustomMessageTypeDef definition
class JourneyCustomMessageTypeDef(TypedDict):
Data: NotRequired[str],DefaultButtonConfigurationTypeDef#
# DefaultButtonConfigurationTypeDef usage example
from mypy_boto3_pinpoint.type_defs import DefaultButtonConfigurationTypeDef
def get_value() -> DefaultButtonConfigurationTypeDef:
return {
"ButtonAction": ...,
"Text": ...,
}# DefaultButtonConfigurationTypeDef definition
class DefaultButtonConfigurationTypeDef(TypedDict):
ButtonAction: ButtonActionType, # (1)
Text: str,
BackgroundColor: NotRequired[str],
BorderRadius: NotRequired[int],
Link: NotRequired[str],
TextColor: NotRequired[str],- See ButtonActionType
DefaultMessageTypeDef#
# DefaultMessageTypeDef usage example
from mypy_boto3_pinpoint.type_defs import DefaultMessageTypeDef
def get_value() -> DefaultMessageTypeDef:
return {
"Body": ...,
}# DefaultMessageTypeDef definition
class DefaultMessageTypeDef(TypedDict):
Body: NotRequired[str],
Substitutions: NotRequired[Mapping[str, Sequence[str]]],DefaultPushNotificationMessageTypeDef#
# DefaultPushNotificationMessageTypeDef usage example
from mypy_boto3_pinpoint.type_defs import DefaultPushNotificationMessageTypeDef
def get_value() -> DefaultPushNotificationMessageTypeDef:
return {
"Action": ...,
}# DefaultPushNotificationMessageTypeDef definition
class DefaultPushNotificationMessageTypeDef(TypedDict):
Action: NotRequired[ActionType], # (1)
Body: NotRequired[str],
Data: NotRequired[Mapping[str, str]],
SilentPush: NotRequired[bool],
Substitutions: NotRequired[Mapping[str, Sequence[str]]],
Title: NotRequired[str],
Url: NotRequired[str],- See ActionType
DefaultPushNotificationTemplateTypeDef#
# DefaultPushNotificationTemplateTypeDef usage example
from mypy_boto3_pinpoint.type_defs import DefaultPushNotificationTemplateTypeDef
def get_value() -> DefaultPushNotificationTemplateTypeDef:
return {
"Action": ...,
}# DefaultPushNotificationTemplateTypeDef definition
class DefaultPushNotificationTemplateTypeDef(TypedDict):
Action: NotRequired[ActionType], # (1)
Body: NotRequired[str],
Sound: NotRequired[str],
Title: NotRequired[str],
Url: NotRequired[str],- See ActionType
DeleteAdmChannelRequestRequestTypeDef#
# DeleteAdmChannelRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import DeleteAdmChannelRequestRequestTypeDef
def get_value() -> DeleteAdmChannelRequestRequestTypeDef:
return {
"ApplicationId": ...,
}# DeleteAdmChannelRequestRequestTypeDef definition
class DeleteAdmChannelRequestRequestTypeDef(TypedDict):
ApplicationId: str,DeleteApnsChannelRequestRequestTypeDef#
# DeleteApnsChannelRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import DeleteApnsChannelRequestRequestTypeDef
def get_value() -> DeleteApnsChannelRequestRequestTypeDef:
return {
"ApplicationId": ...,
}# DeleteApnsChannelRequestRequestTypeDef definition
class DeleteApnsChannelRequestRequestTypeDef(TypedDict):
ApplicationId: str,DeleteApnsSandboxChannelRequestRequestTypeDef#
# DeleteApnsSandboxChannelRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import DeleteApnsSandboxChannelRequestRequestTypeDef
def get_value() -> DeleteApnsSandboxChannelRequestRequestTypeDef:
return {
"ApplicationId": ...,
}# DeleteApnsSandboxChannelRequestRequestTypeDef definition
class DeleteApnsSandboxChannelRequestRequestTypeDef(TypedDict):
ApplicationId: str,DeleteApnsVoipChannelRequestRequestTypeDef#
# DeleteApnsVoipChannelRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import DeleteApnsVoipChannelRequestRequestTypeDef
def get_value() -> DeleteApnsVoipChannelRequestRequestTypeDef:
return {
"ApplicationId": ...,
}# DeleteApnsVoipChannelRequestRequestTypeDef definition
class DeleteApnsVoipChannelRequestRequestTypeDef(TypedDict):
ApplicationId: str,DeleteApnsVoipSandboxChannelRequestRequestTypeDef#
# DeleteApnsVoipSandboxChannelRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import DeleteApnsVoipSandboxChannelRequestRequestTypeDef
def get_value() -> DeleteApnsVoipSandboxChannelRequestRequestTypeDef:
return {
"ApplicationId": ...,
}# DeleteApnsVoipSandboxChannelRequestRequestTypeDef definition
class DeleteApnsVoipSandboxChannelRequestRequestTypeDef(TypedDict):
ApplicationId: str,DeleteAppRequestRequestTypeDef#
# DeleteAppRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import DeleteAppRequestRequestTypeDef
def get_value() -> DeleteAppRequestRequestTypeDef:
return {
"ApplicationId": ...,
}# DeleteAppRequestRequestTypeDef definition
class DeleteAppRequestRequestTypeDef(TypedDict):
ApplicationId: str,DeleteBaiduChannelRequestRequestTypeDef#
# DeleteBaiduChannelRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import DeleteBaiduChannelRequestRequestTypeDef
def get_value() -> DeleteBaiduChannelRequestRequestTypeDef:
return {
"ApplicationId": ...,
}# DeleteBaiduChannelRequestRequestTypeDef definition
class DeleteBaiduChannelRequestRequestTypeDef(TypedDict):
ApplicationId: str,DeleteCampaignRequestRequestTypeDef#
# DeleteCampaignRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import DeleteCampaignRequestRequestTypeDef
def get_value() -> DeleteCampaignRequestRequestTypeDef:
return {
"ApplicationId": ...,
"CampaignId": ...,
}# DeleteCampaignRequestRequestTypeDef definition
class DeleteCampaignRequestRequestTypeDef(TypedDict):
ApplicationId: str,
CampaignId: str,DeleteEmailChannelRequestRequestTypeDef#
# DeleteEmailChannelRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import DeleteEmailChannelRequestRequestTypeDef
def get_value() -> DeleteEmailChannelRequestRequestTypeDef:
return {
"ApplicationId": ...,
}# DeleteEmailChannelRequestRequestTypeDef definition
class DeleteEmailChannelRequestRequestTypeDef(TypedDict):
ApplicationId: str,EmailChannelResponseTypeDef#
# EmailChannelResponseTypeDef usage example
from mypy_boto3_pinpoint.type_defs import EmailChannelResponseTypeDef
def get_value() -> EmailChannelResponseTypeDef:
return {
"Platform": ...,
}# EmailChannelResponseTypeDef definition
class EmailChannelResponseTypeDef(TypedDict):
Platform: str,
ApplicationId: NotRequired[str],
ConfigurationSet: NotRequired[str],
CreationDate: NotRequired[str],
Enabled: NotRequired[bool],
FromAddress: NotRequired[str],
HasCredential: NotRequired[bool],
Id: NotRequired[str],
Identity: NotRequired[str],
IsArchived: NotRequired[bool],
LastModifiedBy: NotRequired[str],
LastModifiedDate: NotRequired[str],
MessagesPerSecond: NotRequired[int],
RoleArn: NotRequired[str],
Version: NotRequired[int],DeleteEmailTemplateRequestRequestTypeDef#
# DeleteEmailTemplateRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import DeleteEmailTemplateRequestRequestTypeDef
def get_value() -> DeleteEmailTemplateRequestRequestTypeDef:
return {
"TemplateName": ...,
}# DeleteEmailTemplateRequestRequestTypeDef definition
class DeleteEmailTemplateRequestRequestTypeDef(TypedDict):
TemplateName: str,
Version: NotRequired[str],MessageBodyTypeDef#
# MessageBodyTypeDef usage example
from mypy_boto3_pinpoint.type_defs import MessageBodyTypeDef
def get_value() -> MessageBodyTypeDef:
return {
"Message": ...,
}# MessageBodyTypeDef definition
class MessageBodyTypeDef(TypedDict):
Message: NotRequired[str],
RequestID: NotRequired[str],DeleteEndpointRequestRequestTypeDef#
# DeleteEndpointRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import DeleteEndpointRequestRequestTypeDef
def get_value() -> DeleteEndpointRequestRequestTypeDef:
return {
"ApplicationId": ...,
"EndpointId": ...,
}# DeleteEndpointRequestRequestTypeDef definition
class DeleteEndpointRequestRequestTypeDef(TypedDict):
ApplicationId: str,
EndpointId: str,DeleteEventStreamRequestRequestTypeDef#
# DeleteEventStreamRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import DeleteEventStreamRequestRequestTypeDef
def get_value() -> DeleteEventStreamRequestRequestTypeDef:
return {
"ApplicationId": ...,
}# DeleteEventStreamRequestRequestTypeDef definition
class DeleteEventStreamRequestRequestTypeDef(TypedDict):
ApplicationId: str,EventStreamTypeDef#
# EventStreamTypeDef usage example
from mypy_boto3_pinpoint.type_defs import EventStreamTypeDef
def get_value() -> EventStreamTypeDef:
return {
"ApplicationId": ...,
"DestinationStreamArn": ...,
"RoleArn": ...,
}# EventStreamTypeDef definition
class EventStreamTypeDef(TypedDict):
ApplicationId: str,
DestinationStreamArn: str,
RoleArn: str,
ExternalId: NotRequired[str],
LastModifiedDate: NotRequired[str],
LastUpdatedBy: NotRequired[str],DeleteGcmChannelRequestRequestTypeDef#
# DeleteGcmChannelRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import DeleteGcmChannelRequestRequestTypeDef
def get_value() -> DeleteGcmChannelRequestRequestTypeDef:
return {
"ApplicationId": ...,
}# DeleteGcmChannelRequestRequestTypeDef definition
class DeleteGcmChannelRequestRequestTypeDef(TypedDict):
ApplicationId: str,GCMChannelResponseTypeDef#
# GCMChannelResponseTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GCMChannelResponseTypeDef
def get_value() -> GCMChannelResponseTypeDef:
return {
"Credential": ...,
"Platform": ...,
}# GCMChannelResponseTypeDef definition
class GCMChannelResponseTypeDef(TypedDict):
Credential: str,
Platform: str,
ApplicationId: NotRequired[str],
CreationDate: NotRequired[str],
Enabled: NotRequired[bool],
HasCredential: NotRequired[bool],
Id: NotRequired[str],
IsArchived: NotRequired[bool],
LastModifiedBy: NotRequired[str],
LastModifiedDate: NotRequired[str],
Version: NotRequired[int],DeleteInAppTemplateRequestRequestTypeDef#
# DeleteInAppTemplateRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import DeleteInAppTemplateRequestRequestTypeDef
def get_value() -> DeleteInAppTemplateRequestRequestTypeDef:
return {
"TemplateName": ...,
}# DeleteInAppTemplateRequestRequestTypeDef definition
class DeleteInAppTemplateRequestRequestTypeDef(TypedDict):
TemplateName: str,
Version: NotRequired[str],DeleteJourneyRequestRequestTypeDef#
# DeleteJourneyRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import DeleteJourneyRequestRequestTypeDef
def get_value() -> DeleteJourneyRequestRequestTypeDef:
return {
"ApplicationId": ...,
"JourneyId": ...,
}# DeleteJourneyRequestRequestTypeDef definition
class DeleteJourneyRequestRequestTypeDef(TypedDict):
ApplicationId: str,
JourneyId: str,DeletePushTemplateRequestRequestTypeDef#
# DeletePushTemplateRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import DeletePushTemplateRequestRequestTypeDef
def get_value() -> DeletePushTemplateRequestRequestTypeDef:
return {
"TemplateName": ...,
}# DeletePushTemplateRequestRequestTypeDef definition
class DeletePushTemplateRequestRequestTypeDef(TypedDict):
TemplateName: str,
Version: NotRequired[str],DeleteRecommenderConfigurationRequestRequestTypeDef#
# DeleteRecommenderConfigurationRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import DeleteRecommenderConfigurationRequestRequestTypeDef
def get_value() -> DeleteRecommenderConfigurationRequestRequestTypeDef:
return {
"RecommenderId": ...,
}# DeleteRecommenderConfigurationRequestRequestTypeDef definition
class DeleteRecommenderConfigurationRequestRequestTypeDef(TypedDict):
RecommenderId: str,DeleteSegmentRequestRequestTypeDef#
# DeleteSegmentRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import DeleteSegmentRequestRequestTypeDef
def get_value() -> DeleteSegmentRequestRequestTypeDef:
return {
"ApplicationId": ...,
"SegmentId": ...,
}# DeleteSegmentRequestRequestTypeDef definition
class DeleteSegmentRequestRequestTypeDef(TypedDict):
ApplicationId: str,
SegmentId: str,DeleteSmsChannelRequestRequestTypeDef#
# DeleteSmsChannelRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import DeleteSmsChannelRequestRequestTypeDef
def get_value() -> DeleteSmsChannelRequestRequestTypeDef:
return {
"ApplicationId": ...,
}# DeleteSmsChannelRequestRequestTypeDef definition
class DeleteSmsChannelRequestRequestTypeDef(TypedDict):
ApplicationId: str,SMSChannelResponseTypeDef#
# SMSChannelResponseTypeDef usage example
from mypy_boto3_pinpoint.type_defs import SMSChannelResponseTypeDef
def get_value() -> SMSChannelResponseTypeDef:
return {
"Platform": ...,
}# SMSChannelResponseTypeDef definition
class SMSChannelResponseTypeDef(TypedDict):
Platform: str,
ApplicationId: NotRequired[str],
CreationDate: NotRequired[str],
Enabled: NotRequired[bool],
HasCredential: NotRequired[bool],
Id: NotRequired[str],
IsArchived: NotRequired[bool],
LastModifiedBy: NotRequired[str],
LastModifiedDate: NotRequired[str],
PromotionalMessagesPerSecond: NotRequired[int],
SenderId: NotRequired[str],
ShortCode: NotRequired[str],
TransactionalMessagesPerSecond: NotRequired[int],
Version: NotRequired[int],DeleteSmsTemplateRequestRequestTypeDef#
# DeleteSmsTemplateRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import DeleteSmsTemplateRequestRequestTypeDef
def get_value() -> DeleteSmsTemplateRequestRequestTypeDef:
return {
"TemplateName": ...,
}# DeleteSmsTemplateRequestRequestTypeDef definition
class DeleteSmsTemplateRequestRequestTypeDef(TypedDict):
TemplateName: str,
Version: NotRequired[str],DeleteUserEndpointsRequestRequestTypeDef#
# DeleteUserEndpointsRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import DeleteUserEndpointsRequestRequestTypeDef
def get_value() -> DeleteUserEndpointsRequestRequestTypeDef:
return {
"ApplicationId": ...,
"UserId": ...,
}# DeleteUserEndpointsRequestRequestTypeDef definition
class DeleteUserEndpointsRequestRequestTypeDef(TypedDict):
ApplicationId: str,
UserId: str,DeleteVoiceChannelRequestRequestTypeDef#
# DeleteVoiceChannelRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import DeleteVoiceChannelRequestRequestTypeDef
def get_value() -> DeleteVoiceChannelRequestRequestTypeDef:
return {
"ApplicationId": ...,
}# DeleteVoiceChannelRequestRequestTypeDef definition
class DeleteVoiceChannelRequestRequestTypeDef(TypedDict):
ApplicationId: str,VoiceChannelResponseTypeDef#
# VoiceChannelResponseTypeDef usage example
from mypy_boto3_pinpoint.type_defs import VoiceChannelResponseTypeDef
def get_value() -> VoiceChannelResponseTypeDef:
return {
"Platform": ...,
}# VoiceChannelResponseTypeDef definition
class VoiceChannelResponseTypeDef(TypedDict):
Platform: str,
ApplicationId: NotRequired[str],
CreationDate: NotRequired[str],
Enabled: NotRequired[bool],
HasCredential: NotRequired[bool],
Id: NotRequired[str],
IsArchived: NotRequired[bool],
LastModifiedBy: NotRequired[str],
LastModifiedDate: NotRequired[str],
Version: NotRequired[int],DeleteVoiceTemplateRequestRequestTypeDef#
# DeleteVoiceTemplateRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import DeleteVoiceTemplateRequestRequestTypeDef
def get_value() -> DeleteVoiceTemplateRequestRequestTypeDef:
return {
"TemplateName": ...,
}# DeleteVoiceTemplateRequestRequestTypeDef definition
class DeleteVoiceTemplateRequestRequestTypeDef(TypedDict):
TemplateName: str,
Version: NotRequired[str],GCMMessageTypeDef#
# GCMMessageTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GCMMessageTypeDef
def get_value() -> GCMMessageTypeDef:
return {
"Action": ...,
}# GCMMessageTypeDef definition
class GCMMessageTypeDef(TypedDict):
Action: NotRequired[ActionType], # (1)
Body: NotRequired[str],
CollapseKey: NotRequired[str],
Data: NotRequired[Mapping[str, str]],
IconReference: NotRequired[str],
ImageIconUrl: NotRequired[str],
ImageUrl: NotRequired[str],
Priority: NotRequired[str],
RawContent: NotRequired[str],
RestrictedPackageName: NotRequired[str],
SilentPush: NotRequired[bool],
SmallImageIconUrl: NotRequired[str],
Sound: NotRequired[str],
Substitutions: NotRequired[Mapping[str, Sequence[str]]],
TimeToLive: NotRequired[int],
Title: NotRequired[str],
Url: NotRequired[str],- See ActionType
SMSMessageTypeDef#
# SMSMessageTypeDef usage example
from mypy_boto3_pinpoint.type_defs import SMSMessageTypeDef
def get_value() -> SMSMessageTypeDef:
return {
"Body": ...,
}# SMSMessageTypeDef definition
class SMSMessageTypeDef(TypedDict):
Body: NotRequired[str],
Keyword: NotRequired[str],
MediaUrl: NotRequired[str],
MessageType: NotRequired[MessageTypeType], # (1)
OriginationNumber: NotRequired[str],
SenderId: NotRequired[str],
Substitutions: NotRequired[Mapping[str, Sequence[str]]],
EntityId: NotRequired[str],
TemplateId: NotRequired[str],- See MessageTypeType
VoiceMessageTypeDef#
# VoiceMessageTypeDef usage example
from mypy_boto3_pinpoint.type_defs import VoiceMessageTypeDef
def get_value() -> VoiceMessageTypeDef:
return {
"Body": ...,
}# VoiceMessageTypeDef definition
class VoiceMessageTypeDef(TypedDict):
Body: NotRequired[str],
LanguageCode: NotRequired[str],
OriginationNumber: NotRequired[str],
Substitutions: NotRequired[Mapping[str, Sequence[str]]],
VoiceId: NotRequired[str],EmailChannelRequestTypeDef#
# EmailChannelRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import EmailChannelRequestTypeDef
def get_value() -> EmailChannelRequestTypeDef:
return {
"FromAddress": ...,
"Identity": ...,
}# EmailChannelRequestTypeDef definition
class EmailChannelRequestTypeDef(TypedDict):
FromAddress: str,
Identity: str,
ConfigurationSet: NotRequired[str],
Enabled: NotRequired[bool],
RoleArn: NotRequired[str],JourneyEmailMessageTypeDef#
# JourneyEmailMessageTypeDef usage example
from mypy_boto3_pinpoint.type_defs import JourneyEmailMessageTypeDef
def get_value() -> JourneyEmailMessageTypeDef:
return {
"FromAddress": ...,
}# JourneyEmailMessageTypeDef definition
class JourneyEmailMessageTypeDef(TypedDict):
FromAddress: NotRequired[str],RawEmailTypeDef#
# RawEmailTypeDef usage example
from mypy_boto3_pinpoint.type_defs import RawEmailTypeDef
def get_value() -> RawEmailTypeDef:
return {
"Data": ...,
}# RawEmailTypeDef definition
class RawEmailTypeDef(TypedDict):
Data: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],EmailTemplateResponseTypeDef#
# EmailTemplateResponseTypeDef usage example
from mypy_boto3_pinpoint.type_defs import EmailTemplateResponseTypeDef
def get_value() -> EmailTemplateResponseTypeDef:
return {
"CreationDate": ...,
"LastModifiedDate": ...,
"TemplateName": ...,
"TemplateType": ...,
}# EmailTemplateResponseTypeDef definition
class EmailTemplateResponseTypeDef(TypedDict):
CreationDate: str,
LastModifiedDate: str,
TemplateName: str,
TemplateType: TemplateTypeType, # (1)
Arn: NotRequired[str],
DefaultSubstitutions: NotRequired[str],
HtmlPart: NotRequired[str],
RecommenderId: NotRequired[str],
Subject: NotRequired[str],
tags: NotRequired[Dict[str, str]],
TemplateDescription: NotRequired[str],
TextPart: NotRequired[str],
Version: NotRequired[str],- See TemplateTypeType
EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef usage example
from mypy_boto3_pinpoint.type_defs import EmptyResponseMetadataTypeDef
def get_value() -> EmptyResponseMetadataTypeDef:
return {
"ResponseMetadata": ...,
}# EmptyResponseMetadataTypeDef definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)EndpointDemographicTypeDef#
# EndpointDemographicTypeDef usage example
from mypy_boto3_pinpoint.type_defs import EndpointDemographicTypeDef
def get_value() -> EndpointDemographicTypeDef:
return {
"AppVersion": ...,
}# EndpointDemographicTypeDef definition
class EndpointDemographicTypeDef(TypedDict):
AppVersion: NotRequired[str],
Locale: NotRequired[str],
Make: NotRequired[str],
Model: NotRequired[str],
ModelVersion: NotRequired[str],
Platform: NotRequired[str],
PlatformVersion: NotRequired[str],
Timezone: NotRequired[str],EndpointLocationTypeDef#
# EndpointLocationTypeDef usage example
from mypy_boto3_pinpoint.type_defs import EndpointLocationTypeDef
def get_value() -> EndpointLocationTypeDef:
return {
"City": ...,
}# EndpointLocationTypeDef definition
class EndpointLocationTypeDef(TypedDict):
City: NotRequired[str],
Country: NotRequired[str],
Latitude: NotRequired[float],
Longitude: NotRequired[float],
PostalCode: NotRequired[str],
Region: NotRequired[str],EndpointUserTypeDef#
# EndpointUserTypeDef usage example
from mypy_boto3_pinpoint.type_defs import EndpointUserTypeDef
def get_value() -> EndpointUserTypeDef:
return {
"UserAttributes": ...,
}# EndpointUserTypeDef definition
class EndpointUserTypeDef(TypedDict):
UserAttributes: NotRequired[Dict[str, List[str]]],
UserId: NotRequired[str],EndpointItemResponseTypeDef#
# EndpointItemResponseTypeDef usage example
from mypy_boto3_pinpoint.type_defs import EndpointItemResponseTypeDef
def get_value() -> EndpointItemResponseTypeDef:
return {
"Message": ...,
}# EndpointItemResponseTypeDef definition
class EndpointItemResponseTypeDef(TypedDict):
Message: NotRequired[str],
StatusCode: NotRequired[int],EndpointMessageResultTypeDef#
# EndpointMessageResultTypeDef usage example
from mypy_boto3_pinpoint.type_defs import EndpointMessageResultTypeDef
def get_value() -> EndpointMessageResultTypeDef:
return {
"DeliveryStatus": ...,
"StatusCode": ...,
}# EndpointMessageResultTypeDef definition
class EndpointMessageResultTypeDef(TypedDict):
DeliveryStatus: DeliveryStatusType, # (1)
StatusCode: int,
Address: NotRequired[str],
MessageId: NotRequired[str],
StatusMessage: NotRequired[str],
UpdatedToken: NotRequired[str],EndpointSendConfigurationTypeDef#
# EndpointSendConfigurationTypeDef usage example
from mypy_boto3_pinpoint.type_defs import EndpointSendConfigurationTypeDef
def get_value() -> EndpointSendConfigurationTypeDef:
return {
"BodyOverride": ...,
}# EndpointSendConfigurationTypeDef definition
class EndpointSendConfigurationTypeDef(TypedDict):
BodyOverride: NotRequired[str],
Context: NotRequired[Mapping[str, str]],
RawContent: NotRequired[str],
Substitutions: NotRequired[Mapping[str, Sequence[str]]],
TitleOverride: NotRequired[str],MetricDimensionTypeDef#
# MetricDimensionTypeDef usage example
from mypy_boto3_pinpoint.type_defs import MetricDimensionTypeDef
def get_value() -> MetricDimensionTypeDef:
return {
"ComparisonOperator": ...,
"Value": ...,
}# MetricDimensionTypeDef definition
class MetricDimensionTypeDef(TypedDict):
ComparisonOperator: str,
Value: float,SetDimensionTypeDef#
# SetDimensionTypeDef usage example
from mypy_boto3_pinpoint.type_defs import SetDimensionTypeDef
def get_value() -> SetDimensionTypeDef:
return {
"Values": ...,
}# SetDimensionTypeDef definition
class SetDimensionTypeDef(TypedDict):
Values: Sequence[str],
DimensionType: NotRequired[DimensionTypeType], # (1)EventItemResponseTypeDef#
# EventItemResponseTypeDef usage example
from mypy_boto3_pinpoint.type_defs import EventItemResponseTypeDef
def get_value() -> EventItemResponseTypeDef:
return {
"Message": ...,
}# EventItemResponseTypeDef definition
class EventItemResponseTypeDef(TypedDict):
Message: NotRequired[str],
StatusCode: NotRequired[int],SessionTypeDef#
# SessionTypeDef usage example
from mypy_boto3_pinpoint.type_defs import SessionTypeDef
def get_value() -> SessionTypeDef:
return {
"Id": ...,
"StartTimestamp": ...,
}# SessionTypeDef definition
class SessionTypeDef(TypedDict):
Id: str,
StartTimestamp: str,
Duration: NotRequired[int],
StopTimestamp: NotRequired[str],ExportJobResourceTypeDef#
# ExportJobResourceTypeDef usage example
from mypy_boto3_pinpoint.type_defs import ExportJobResourceTypeDef
def get_value() -> ExportJobResourceTypeDef:
return {
"RoleArn": ...,
"S3UrlPrefix": ...,
}# ExportJobResourceTypeDef definition
class ExportJobResourceTypeDef(TypedDict):
RoleArn: str,
S3UrlPrefix: str,
SegmentId: NotRequired[str],
SegmentVersion: NotRequired[int],GCMChannelRequestTypeDef#
# GCMChannelRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GCMChannelRequestTypeDef
def get_value() -> GCMChannelRequestTypeDef:
return {
"ApiKey": ...,
}# GCMChannelRequestTypeDef definition
class GCMChannelRequestTypeDef(TypedDict):
ApiKey: str,
Enabled: NotRequired[bool],GPSCoordinatesTypeDef#
# GPSCoordinatesTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GPSCoordinatesTypeDef
def get_value() -> GPSCoordinatesTypeDef:
return {
"Latitude": ...,
"Longitude": ...,
}# GPSCoordinatesTypeDef definition
class GPSCoordinatesTypeDef(TypedDict):
Latitude: float,
Longitude: float,GetAdmChannelRequestRequestTypeDef#
# GetAdmChannelRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetAdmChannelRequestRequestTypeDef
def get_value() -> GetAdmChannelRequestRequestTypeDef:
return {
"ApplicationId": ...,
}# GetAdmChannelRequestRequestTypeDef definition
class GetAdmChannelRequestRequestTypeDef(TypedDict):
ApplicationId: str,GetApnsChannelRequestRequestTypeDef#
# GetApnsChannelRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetApnsChannelRequestRequestTypeDef
def get_value() -> GetApnsChannelRequestRequestTypeDef:
return {
"ApplicationId": ...,
}# GetApnsChannelRequestRequestTypeDef definition
class GetApnsChannelRequestRequestTypeDef(TypedDict):
ApplicationId: str,GetApnsSandboxChannelRequestRequestTypeDef#
# GetApnsSandboxChannelRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetApnsSandboxChannelRequestRequestTypeDef
def get_value() -> GetApnsSandboxChannelRequestRequestTypeDef:
return {
"ApplicationId": ...,
}# GetApnsSandboxChannelRequestRequestTypeDef definition
class GetApnsSandboxChannelRequestRequestTypeDef(TypedDict):
ApplicationId: str,GetApnsVoipChannelRequestRequestTypeDef#
# GetApnsVoipChannelRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetApnsVoipChannelRequestRequestTypeDef
def get_value() -> GetApnsVoipChannelRequestRequestTypeDef:
return {
"ApplicationId": ...,
}# GetApnsVoipChannelRequestRequestTypeDef definition
class GetApnsVoipChannelRequestRequestTypeDef(TypedDict):
ApplicationId: str,GetApnsVoipSandboxChannelRequestRequestTypeDef#
# GetApnsVoipSandboxChannelRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetApnsVoipSandboxChannelRequestRequestTypeDef
def get_value() -> GetApnsVoipSandboxChannelRequestRequestTypeDef:
return {
"ApplicationId": ...,
}# GetApnsVoipSandboxChannelRequestRequestTypeDef definition
class GetApnsVoipSandboxChannelRequestRequestTypeDef(TypedDict):
ApplicationId: str,GetAppRequestRequestTypeDef#
# GetAppRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetAppRequestRequestTypeDef
def get_value() -> GetAppRequestRequestTypeDef:
return {
"ApplicationId": ...,
}# GetAppRequestRequestTypeDef definition
class GetAppRequestRequestTypeDef(TypedDict):
ApplicationId: str,GetApplicationDateRangeKpiRequestRequestTypeDef#
# GetApplicationDateRangeKpiRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetApplicationDateRangeKpiRequestRequestTypeDef
def get_value() -> GetApplicationDateRangeKpiRequestRequestTypeDef:
return {
"ApplicationId": ...,
"KpiName": ...,
}# GetApplicationDateRangeKpiRequestRequestTypeDef definition
class GetApplicationDateRangeKpiRequestRequestTypeDef(TypedDict):
ApplicationId: str,
KpiName: str,
EndTime: NotRequired[Union[datetime, str]],
NextToken: NotRequired[str],
PageSize: NotRequired[str],
StartTime: NotRequired[Union[datetime, str]],GetApplicationSettingsRequestRequestTypeDef#
# GetApplicationSettingsRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetApplicationSettingsRequestRequestTypeDef
def get_value() -> GetApplicationSettingsRequestRequestTypeDef:
return {
"ApplicationId": ...,
}# GetApplicationSettingsRequestRequestTypeDef definition
class GetApplicationSettingsRequestRequestTypeDef(TypedDict):
ApplicationId: str,GetAppsRequestRequestTypeDef#
# GetAppsRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetAppsRequestRequestTypeDef
def get_value() -> GetAppsRequestRequestTypeDef:
return {
"PageSize": ...,
}# GetAppsRequestRequestTypeDef definition
class GetAppsRequestRequestTypeDef(TypedDict):
PageSize: NotRequired[str],
Token: NotRequired[str],GetBaiduChannelRequestRequestTypeDef#
# GetBaiduChannelRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetBaiduChannelRequestRequestTypeDef
def get_value() -> GetBaiduChannelRequestRequestTypeDef:
return {
"ApplicationId": ...,
}# GetBaiduChannelRequestRequestTypeDef definition
class GetBaiduChannelRequestRequestTypeDef(TypedDict):
ApplicationId: str,GetCampaignActivitiesRequestRequestTypeDef#
# GetCampaignActivitiesRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetCampaignActivitiesRequestRequestTypeDef
def get_value() -> GetCampaignActivitiesRequestRequestTypeDef:
return {
"ApplicationId": ...,
"CampaignId": ...,
}# GetCampaignActivitiesRequestRequestTypeDef definition
class GetCampaignActivitiesRequestRequestTypeDef(TypedDict):
ApplicationId: str,
CampaignId: str,
PageSize: NotRequired[str],
Token: NotRequired[str],GetCampaignDateRangeKpiRequestRequestTypeDef#
# GetCampaignDateRangeKpiRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetCampaignDateRangeKpiRequestRequestTypeDef
def get_value() -> GetCampaignDateRangeKpiRequestRequestTypeDef:
return {
"ApplicationId": ...,
"CampaignId": ...,
"KpiName": ...,
}# GetCampaignDateRangeKpiRequestRequestTypeDef definition
class GetCampaignDateRangeKpiRequestRequestTypeDef(TypedDict):
ApplicationId: str,
CampaignId: str,
KpiName: str,
EndTime: NotRequired[Union[datetime, str]],
NextToken: NotRequired[str],
PageSize: NotRequired[str],
StartTime: NotRequired[Union[datetime, str]],GetCampaignRequestRequestTypeDef#
# GetCampaignRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetCampaignRequestRequestTypeDef
def get_value() -> GetCampaignRequestRequestTypeDef:
return {
"ApplicationId": ...,
"CampaignId": ...,
}# GetCampaignRequestRequestTypeDef definition
class GetCampaignRequestRequestTypeDef(TypedDict):
ApplicationId: str,
CampaignId: str,GetCampaignVersionRequestRequestTypeDef#
# GetCampaignVersionRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetCampaignVersionRequestRequestTypeDef
def get_value() -> GetCampaignVersionRequestRequestTypeDef:
return {
"ApplicationId": ...,
"CampaignId": ...,
"Version": ...,
}# GetCampaignVersionRequestRequestTypeDef definition
class GetCampaignVersionRequestRequestTypeDef(TypedDict):
ApplicationId: str,
CampaignId: str,
Version: str,GetCampaignVersionsRequestRequestTypeDef#
# GetCampaignVersionsRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetCampaignVersionsRequestRequestTypeDef
def get_value() -> GetCampaignVersionsRequestRequestTypeDef:
return {
"ApplicationId": ...,
"CampaignId": ...,
}# GetCampaignVersionsRequestRequestTypeDef definition
class GetCampaignVersionsRequestRequestTypeDef(TypedDict):
ApplicationId: str,
CampaignId: str,
PageSize: NotRequired[str],
Token: NotRequired[str],GetCampaignsRequestRequestTypeDef#
# GetCampaignsRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetCampaignsRequestRequestTypeDef
def get_value() -> GetCampaignsRequestRequestTypeDef:
return {
"ApplicationId": ...,
}# GetCampaignsRequestRequestTypeDef definition
class GetCampaignsRequestRequestTypeDef(TypedDict):
ApplicationId: str,
PageSize: NotRequired[str],
Token: NotRequired[str],GetChannelsRequestRequestTypeDef#
# GetChannelsRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetChannelsRequestRequestTypeDef
def get_value() -> GetChannelsRequestRequestTypeDef:
return {
"ApplicationId": ...,
}# GetChannelsRequestRequestTypeDef definition
class GetChannelsRequestRequestTypeDef(TypedDict):
ApplicationId: str,GetEmailChannelRequestRequestTypeDef#
# GetEmailChannelRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetEmailChannelRequestRequestTypeDef
def get_value() -> GetEmailChannelRequestRequestTypeDef:
return {
"ApplicationId": ...,
}# GetEmailChannelRequestRequestTypeDef definition
class GetEmailChannelRequestRequestTypeDef(TypedDict):
ApplicationId: str,GetEmailTemplateRequestRequestTypeDef#
# GetEmailTemplateRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetEmailTemplateRequestRequestTypeDef
def get_value() -> GetEmailTemplateRequestRequestTypeDef:
return {
"TemplateName": ...,
}# GetEmailTemplateRequestRequestTypeDef definition
class GetEmailTemplateRequestRequestTypeDef(TypedDict):
TemplateName: str,
Version: NotRequired[str],GetEndpointRequestRequestTypeDef#
# GetEndpointRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetEndpointRequestRequestTypeDef
def get_value() -> GetEndpointRequestRequestTypeDef:
return {
"ApplicationId": ...,
"EndpointId": ...,
}# GetEndpointRequestRequestTypeDef definition
class GetEndpointRequestRequestTypeDef(TypedDict):
ApplicationId: str,
EndpointId: str,GetEventStreamRequestRequestTypeDef#
# GetEventStreamRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetEventStreamRequestRequestTypeDef
def get_value() -> GetEventStreamRequestRequestTypeDef:
return {
"ApplicationId": ...,
}# GetEventStreamRequestRequestTypeDef definition
class GetEventStreamRequestRequestTypeDef(TypedDict):
ApplicationId: str,GetExportJobRequestRequestTypeDef#
# GetExportJobRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetExportJobRequestRequestTypeDef
def get_value() -> GetExportJobRequestRequestTypeDef:
return {
"ApplicationId": ...,
"JobId": ...,
}# GetExportJobRequestRequestTypeDef definition
class GetExportJobRequestRequestTypeDef(TypedDict):
ApplicationId: str,
JobId: str,GetExportJobsRequestRequestTypeDef#
# GetExportJobsRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetExportJobsRequestRequestTypeDef
def get_value() -> GetExportJobsRequestRequestTypeDef:
return {
"ApplicationId": ...,
}# GetExportJobsRequestRequestTypeDef definition
class GetExportJobsRequestRequestTypeDef(TypedDict):
ApplicationId: str,
PageSize: NotRequired[str],
Token: NotRequired[str],GetGcmChannelRequestRequestTypeDef#
# GetGcmChannelRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetGcmChannelRequestRequestTypeDef
def get_value() -> GetGcmChannelRequestRequestTypeDef:
return {
"ApplicationId": ...,
}# GetGcmChannelRequestRequestTypeDef definition
class GetGcmChannelRequestRequestTypeDef(TypedDict):
ApplicationId: str,GetImportJobRequestRequestTypeDef#
# GetImportJobRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetImportJobRequestRequestTypeDef
def get_value() -> GetImportJobRequestRequestTypeDef:
return {
"ApplicationId": ...,
"JobId": ...,
}# GetImportJobRequestRequestTypeDef definition
class GetImportJobRequestRequestTypeDef(TypedDict):
ApplicationId: str,
JobId: str,GetImportJobsRequestRequestTypeDef#
# GetImportJobsRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetImportJobsRequestRequestTypeDef
def get_value() -> GetImportJobsRequestRequestTypeDef:
return {
"ApplicationId": ...,
}# GetImportJobsRequestRequestTypeDef definition
class GetImportJobsRequestRequestTypeDef(TypedDict):
ApplicationId: str,
PageSize: NotRequired[str],
Token: NotRequired[str],GetInAppMessagesRequestRequestTypeDef#
# GetInAppMessagesRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetInAppMessagesRequestRequestTypeDef
def get_value() -> GetInAppMessagesRequestRequestTypeDef:
return {
"ApplicationId": ...,
"EndpointId": ...,
}# GetInAppMessagesRequestRequestTypeDef definition
class GetInAppMessagesRequestRequestTypeDef(TypedDict):
ApplicationId: str,
EndpointId: str,GetInAppTemplateRequestRequestTypeDef#
# GetInAppTemplateRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetInAppTemplateRequestRequestTypeDef
def get_value() -> GetInAppTemplateRequestRequestTypeDef:
return {
"TemplateName": ...,
}# GetInAppTemplateRequestRequestTypeDef definition
class GetInAppTemplateRequestRequestTypeDef(TypedDict):
TemplateName: str,
Version: NotRequired[str],GetJourneyDateRangeKpiRequestRequestTypeDef#
# GetJourneyDateRangeKpiRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetJourneyDateRangeKpiRequestRequestTypeDef
def get_value() -> GetJourneyDateRangeKpiRequestRequestTypeDef:
return {
"ApplicationId": ...,
"JourneyId": ...,
"KpiName": ...,
}# GetJourneyDateRangeKpiRequestRequestTypeDef definition
class GetJourneyDateRangeKpiRequestRequestTypeDef(TypedDict):
ApplicationId: str,
JourneyId: str,
KpiName: str,
EndTime: NotRequired[Union[datetime, str]],
NextToken: NotRequired[str],
PageSize: NotRequired[str],
StartTime: NotRequired[Union[datetime, str]],GetJourneyExecutionActivityMetricsRequestRequestTypeDef#
# GetJourneyExecutionActivityMetricsRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetJourneyExecutionActivityMetricsRequestRequestTypeDef
def get_value() -> GetJourneyExecutionActivityMetricsRequestRequestTypeDef:
return {
"ApplicationId": ...,
"JourneyActivityId": ...,
"JourneyId": ...,
}# GetJourneyExecutionActivityMetricsRequestRequestTypeDef definition
class GetJourneyExecutionActivityMetricsRequestRequestTypeDef(TypedDict):
ApplicationId: str,
JourneyActivityId: str,
JourneyId: str,
NextToken: NotRequired[str],
PageSize: NotRequired[str],JourneyExecutionActivityMetricsResponseTypeDef#
# JourneyExecutionActivityMetricsResponseTypeDef usage example
from mypy_boto3_pinpoint.type_defs import JourneyExecutionActivityMetricsResponseTypeDef
def get_value() -> JourneyExecutionActivityMetricsResponseTypeDef:
return {
"ActivityType": ...,
"ApplicationId": ...,
"JourneyActivityId": ...,
"JourneyId": ...,
"LastEvaluatedTime": ...,
"Metrics": ...,
}# JourneyExecutionActivityMetricsResponseTypeDef definition
class JourneyExecutionActivityMetricsResponseTypeDef(TypedDict):
ActivityType: str,
ApplicationId: str,
JourneyActivityId: str,
JourneyId: str,
LastEvaluatedTime: str,
Metrics: Dict[str, str],GetJourneyExecutionMetricsRequestRequestTypeDef#
# GetJourneyExecutionMetricsRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetJourneyExecutionMetricsRequestRequestTypeDef
def get_value() -> GetJourneyExecutionMetricsRequestRequestTypeDef:
return {
"ApplicationId": ...,
"JourneyId": ...,
}# GetJourneyExecutionMetricsRequestRequestTypeDef definition
class GetJourneyExecutionMetricsRequestRequestTypeDef(TypedDict):
ApplicationId: str,
JourneyId: str,
NextToken: NotRequired[str],
PageSize: NotRequired[str],JourneyExecutionMetricsResponseTypeDef#
# JourneyExecutionMetricsResponseTypeDef usage example
from mypy_boto3_pinpoint.type_defs import JourneyExecutionMetricsResponseTypeDef
def get_value() -> JourneyExecutionMetricsResponseTypeDef:
return {
"ApplicationId": ...,
"JourneyId": ...,
"LastEvaluatedTime": ...,
"Metrics": ...,
}# JourneyExecutionMetricsResponseTypeDef definition
class JourneyExecutionMetricsResponseTypeDef(TypedDict):
ApplicationId: str,
JourneyId: str,
LastEvaluatedTime: str,
Metrics: Dict[str, str],GetJourneyRequestRequestTypeDef#
# GetJourneyRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetJourneyRequestRequestTypeDef
def get_value() -> GetJourneyRequestRequestTypeDef:
return {
"ApplicationId": ...,
"JourneyId": ...,
}# GetJourneyRequestRequestTypeDef definition
class GetJourneyRequestRequestTypeDef(TypedDict):
ApplicationId: str,
JourneyId: str,GetJourneyRunExecutionActivityMetricsRequestRequestTypeDef#
# GetJourneyRunExecutionActivityMetricsRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetJourneyRunExecutionActivityMetricsRequestRequestTypeDef
def get_value() -> GetJourneyRunExecutionActivityMetricsRequestRequestTypeDef:
return {
"ApplicationId": ...,
"JourneyActivityId": ...,
"JourneyId": ...,
"RunId": ...,
}# GetJourneyRunExecutionActivityMetricsRequestRequestTypeDef definition
class GetJourneyRunExecutionActivityMetricsRequestRequestTypeDef(TypedDict):
ApplicationId: str,
JourneyActivityId: str,
JourneyId: str,
RunId: str,
NextToken: NotRequired[str],
PageSize: NotRequired[str],JourneyRunExecutionActivityMetricsResponseTypeDef#
# JourneyRunExecutionActivityMetricsResponseTypeDef usage example
from mypy_boto3_pinpoint.type_defs import JourneyRunExecutionActivityMetricsResponseTypeDef
def get_value() -> JourneyRunExecutionActivityMetricsResponseTypeDef:
return {
"ActivityType": ...,
"ApplicationId": ...,
"JourneyActivityId": ...,
"JourneyId": ...,
"LastEvaluatedTime": ...,
"Metrics": ...,
"RunId": ...,
}# JourneyRunExecutionActivityMetricsResponseTypeDef definition
class JourneyRunExecutionActivityMetricsResponseTypeDef(TypedDict):
ActivityType: str,
ApplicationId: str,
JourneyActivityId: str,
JourneyId: str,
LastEvaluatedTime: str,
Metrics: Dict[str, str],
RunId: str,GetJourneyRunExecutionMetricsRequestRequestTypeDef#
# GetJourneyRunExecutionMetricsRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetJourneyRunExecutionMetricsRequestRequestTypeDef
def get_value() -> GetJourneyRunExecutionMetricsRequestRequestTypeDef:
return {
"ApplicationId": ...,
"JourneyId": ...,
"RunId": ...,
}# GetJourneyRunExecutionMetricsRequestRequestTypeDef definition
class GetJourneyRunExecutionMetricsRequestRequestTypeDef(TypedDict):
ApplicationId: str,
JourneyId: str,
RunId: str,
NextToken: NotRequired[str],
PageSize: NotRequired[str],JourneyRunExecutionMetricsResponseTypeDef#
# JourneyRunExecutionMetricsResponseTypeDef usage example
from mypy_boto3_pinpoint.type_defs import JourneyRunExecutionMetricsResponseTypeDef
def get_value() -> JourneyRunExecutionMetricsResponseTypeDef:
return {
"ApplicationId": ...,
"JourneyId": ...,
"LastEvaluatedTime": ...,
"Metrics": ...,
"RunId": ...,
}# JourneyRunExecutionMetricsResponseTypeDef definition
class JourneyRunExecutionMetricsResponseTypeDef(TypedDict):
ApplicationId: str,
JourneyId: str,
LastEvaluatedTime: str,
Metrics: Dict[str, str],
RunId: str,GetJourneyRunsRequestRequestTypeDef#
# GetJourneyRunsRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetJourneyRunsRequestRequestTypeDef
def get_value() -> GetJourneyRunsRequestRequestTypeDef:
return {
"ApplicationId": ...,
"JourneyId": ...,
}# GetJourneyRunsRequestRequestTypeDef definition
class GetJourneyRunsRequestRequestTypeDef(TypedDict):
ApplicationId: str,
JourneyId: str,
PageSize: NotRequired[str],
Token: NotRequired[str],GetPushTemplateRequestRequestTypeDef#
# GetPushTemplateRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetPushTemplateRequestRequestTypeDef
def get_value() -> GetPushTemplateRequestRequestTypeDef:
return {
"TemplateName": ...,
}# GetPushTemplateRequestRequestTypeDef definition
class GetPushTemplateRequestRequestTypeDef(TypedDict):
TemplateName: str,
Version: NotRequired[str],GetRecommenderConfigurationRequestRequestTypeDef#
# GetRecommenderConfigurationRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetRecommenderConfigurationRequestRequestTypeDef
def get_value() -> GetRecommenderConfigurationRequestRequestTypeDef:
return {
"RecommenderId": ...,
}# GetRecommenderConfigurationRequestRequestTypeDef definition
class GetRecommenderConfigurationRequestRequestTypeDef(TypedDict):
RecommenderId: str,GetRecommenderConfigurationsRequestRequestTypeDef#
# GetRecommenderConfigurationsRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetRecommenderConfigurationsRequestRequestTypeDef
def get_value() -> GetRecommenderConfigurationsRequestRequestTypeDef:
return {
"PageSize": ...,
}# GetRecommenderConfigurationsRequestRequestTypeDef definition
class GetRecommenderConfigurationsRequestRequestTypeDef(TypedDict):
PageSize: NotRequired[str],
Token: NotRequired[str],GetSegmentExportJobsRequestRequestTypeDef#
# GetSegmentExportJobsRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetSegmentExportJobsRequestRequestTypeDef
def get_value() -> GetSegmentExportJobsRequestRequestTypeDef:
return {
"ApplicationId": ...,
"SegmentId": ...,
}# GetSegmentExportJobsRequestRequestTypeDef definition
class GetSegmentExportJobsRequestRequestTypeDef(TypedDict):
ApplicationId: str,
SegmentId: str,
PageSize: NotRequired[str],
Token: NotRequired[str],GetSegmentImportJobsRequestRequestTypeDef#
# GetSegmentImportJobsRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetSegmentImportJobsRequestRequestTypeDef
def get_value() -> GetSegmentImportJobsRequestRequestTypeDef:
return {
"ApplicationId": ...,
"SegmentId": ...,
}# GetSegmentImportJobsRequestRequestTypeDef definition
class GetSegmentImportJobsRequestRequestTypeDef(TypedDict):
ApplicationId: str,
SegmentId: str,
PageSize: NotRequired[str],
Token: NotRequired[str],GetSegmentRequestRequestTypeDef#
# GetSegmentRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetSegmentRequestRequestTypeDef
def get_value() -> GetSegmentRequestRequestTypeDef:
return {
"ApplicationId": ...,
"SegmentId": ...,
}# GetSegmentRequestRequestTypeDef definition
class GetSegmentRequestRequestTypeDef(TypedDict):
ApplicationId: str,
SegmentId: str,GetSegmentVersionRequestRequestTypeDef#
# GetSegmentVersionRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetSegmentVersionRequestRequestTypeDef
def get_value() -> GetSegmentVersionRequestRequestTypeDef:
return {
"ApplicationId": ...,
"SegmentId": ...,
"Version": ...,
}# GetSegmentVersionRequestRequestTypeDef definition
class GetSegmentVersionRequestRequestTypeDef(TypedDict):
ApplicationId: str,
SegmentId: str,
Version: str,GetSegmentVersionsRequestRequestTypeDef#
# GetSegmentVersionsRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetSegmentVersionsRequestRequestTypeDef
def get_value() -> GetSegmentVersionsRequestRequestTypeDef:
return {
"ApplicationId": ...,
"SegmentId": ...,
}# GetSegmentVersionsRequestRequestTypeDef definition
class GetSegmentVersionsRequestRequestTypeDef(TypedDict):
ApplicationId: str,
SegmentId: str,
PageSize: NotRequired[str],
Token: NotRequired[str],GetSegmentsRequestRequestTypeDef#
# GetSegmentsRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetSegmentsRequestRequestTypeDef
def get_value() -> GetSegmentsRequestRequestTypeDef:
return {
"ApplicationId": ...,
}# GetSegmentsRequestRequestTypeDef definition
class GetSegmentsRequestRequestTypeDef(TypedDict):
ApplicationId: str,
PageSize: NotRequired[str],
Token: NotRequired[str],GetSmsChannelRequestRequestTypeDef#
# GetSmsChannelRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetSmsChannelRequestRequestTypeDef
def get_value() -> GetSmsChannelRequestRequestTypeDef:
return {
"ApplicationId": ...,
}# GetSmsChannelRequestRequestTypeDef definition
class GetSmsChannelRequestRequestTypeDef(TypedDict):
ApplicationId: str,GetSmsTemplateRequestRequestTypeDef#
# GetSmsTemplateRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetSmsTemplateRequestRequestTypeDef
def get_value() -> GetSmsTemplateRequestRequestTypeDef:
return {
"TemplateName": ...,
}# GetSmsTemplateRequestRequestTypeDef definition
class GetSmsTemplateRequestRequestTypeDef(TypedDict):
TemplateName: str,
Version: NotRequired[str],SMSTemplateResponseTypeDef#
# SMSTemplateResponseTypeDef usage example
from mypy_boto3_pinpoint.type_defs import SMSTemplateResponseTypeDef
def get_value() -> SMSTemplateResponseTypeDef:
return {
"CreationDate": ...,
"LastModifiedDate": ...,
"TemplateName": ...,
"TemplateType": ...,
}# SMSTemplateResponseTypeDef definition
class SMSTemplateResponseTypeDef(TypedDict):
CreationDate: str,
LastModifiedDate: str,
TemplateName: str,
TemplateType: TemplateTypeType, # (1)
Arn: NotRequired[str],
Body: NotRequired[str],
DefaultSubstitutions: NotRequired[str],
RecommenderId: NotRequired[str],
tags: NotRequired[Dict[str, str]],
TemplateDescription: NotRequired[str],
Version: NotRequired[str],- See TemplateTypeType
GetUserEndpointsRequestRequestTypeDef#
# GetUserEndpointsRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetUserEndpointsRequestRequestTypeDef
def get_value() -> GetUserEndpointsRequestRequestTypeDef:
return {
"ApplicationId": ...,
"UserId": ...,
}# GetUserEndpointsRequestRequestTypeDef definition
class GetUserEndpointsRequestRequestTypeDef(TypedDict):
ApplicationId: str,
UserId: str,GetVoiceChannelRequestRequestTypeDef#
# GetVoiceChannelRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetVoiceChannelRequestRequestTypeDef
def get_value() -> GetVoiceChannelRequestRequestTypeDef:
return {
"ApplicationId": ...,
}# GetVoiceChannelRequestRequestTypeDef definition
class GetVoiceChannelRequestRequestTypeDef(TypedDict):
ApplicationId: str,GetVoiceTemplateRequestRequestTypeDef#
# GetVoiceTemplateRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetVoiceTemplateRequestRequestTypeDef
def get_value() -> GetVoiceTemplateRequestRequestTypeDef:
return {
"TemplateName": ...,
}# GetVoiceTemplateRequestRequestTypeDef definition
class GetVoiceTemplateRequestRequestTypeDef(TypedDict):
TemplateName: str,
Version: NotRequired[str],VoiceTemplateResponseTypeDef#
# VoiceTemplateResponseTypeDef usage example
from mypy_boto3_pinpoint.type_defs import VoiceTemplateResponseTypeDef
def get_value() -> VoiceTemplateResponseTypeDef:
return {
"CreationDate": ...,
"LastModifiedDate": ...,
"TemplateName": ...,
"TemplateType": ...,
}# VoiceTemplateResponseTypeDef definition
class VoiceTemplateResponseTypeDef(TypedDict):
CreationDate: str,
LastModifiedDate: str,
TemplateName: str,
TemplateType: TemplateTypeType, # (1)
Arn: NotRequired[str],
Body: NotRequired[str],
DefaultSubstitutions: NotRequired[str],
LanguageCode: NotRequired[str],
tags: NotRequired[Dict[str, str]],
TemplateDescription: NotRequired[str],
Version: NotRequired[str],
VoiceId: NotRequired[str],- See TemplateTypeType
ImportJobResourceTypeDef#
# ImportJobResourceTypeDef usage example
from mypy_boto3_pinpoint.type_defs import ImportJobResourceTypeDef
def get_value() -> ImportJobResourceTypeDef:
return {
"Format": ...,
"RoleArn": ...,
"S3Url": ...,
}# ImportJobResourceTypeDef definition
class ImportJobResourceTypeDef(TypedDict):
Format: FormatType, # (1)
RoleArn: str,
S3Url: str,
DefineSegment: NotRequired[bool],
ExternalId: NotRequired[str],
RegisterEndpoints: NotRequired[bool],
SegmentId: NotRequired[str],
SegmentName: NotRequired[str],- See FormatType
InAppMessageBodyConfigTypeDef#
# InAppMessageBodyConfigTypeDef usage example
from mypy_boto3_pinpoint.type_defs import InAppMessageBodyConfigTypeDef
def get_value() -> InAppMessageBodyConfigTypeDef:
return {
"Alignment": ...,
"Body": ...,
"TextColor": ...,
}# InAppMessageBodyConfigTypeDef definition
class InAppMessageBodyConfigTypeDef(TypedDict):
Alignment: AlignmentType, # (1)
Body: str,
TextColor: str,- See AlignmentType
OverrideButtonConfigurationTypeDef#
# OverrideButtonConfigurationTypeDef usage example
from mypy_boto3_pinpoint.type_defs import OverrideButtonConfigurationTypeDef
def get_value() -> OverrideButtonConfigurationTypeDef:
return {
"ButtonAction": ...,
}# OverrideButtonConfigurationTypeDef definition
class OverrideButtonConfigurationTypeDef(TypedDict):
ButtonAction: ButtonActionType, # (1)
Link: NotRequired[str],- See ButtonActionType
InAppMessageHeaderConfigTypeDef#
# InAppMessageHeaderConfigTypeDef usage example
from mypy_boto3_pinpoint.type_defs import InAppMessageHeaderConfigTypeDef
def get_value() -> InAppMessageHeaderConfigTypeDef:
return {
"Alignment": ...,
"Header": ...,
"TextColor": ...,
}# InAppMessageHeaderConfigTypeDef definition
class InAppMessageHeaderConfigTypeDef(TypedDict):
Alignment: AlignmentType, # (1)
Header: str,
TextColor: str,- See AlignmentType
JourneyChannelSettingsTypeDef#
# JourneyChannelSettingsTypeDef usage example
from mypy_boto3_pinpoint.type_defs import JourneyChannelSettingsTypeDef
def get_value() -> JourneyChannelSettingsTypeDef:
return {
"ConnectCampaignArn": ...,
}# JourneyChannelSettingsTypeDef definition
class JourneyChannelSettingsTypeDef(TypedDict):
ConnectCampaignArn: NotRequired[str],
ConnectCampaignExecutionRoleArn: NotRequired[str],JourneyLimitsTypeDef#
# JourneyLimitsTypeDef usage example
from mypy_boto3_pinpoint.type_defs import JourneyLimitsTypeDef
def get_value() -> JourneyLimitsTypeDef:
return {
"DailyCap": ...,
}# JourneyLimitsTypeDef definition
class JourneyLimitsTypeDef(TypedDict):
DailyCap: NotRequired[int],
EndpointReentryCap: NotRequired[int],
MessagesPerSecond: NotRequired[int],
EndpointReentryInterval: NotRequired[str],JourneyPushMessageTypeDef#
# JourneyPushMessageTypeDef usage example
from mypy_boto3_pinpoint.type_defs import JourneyPushMessageTypeDef
def get_value() -> JourneyPushMessageTypeDef:
return {
"TimeToLive": ...,
}# JourneyPushMessageTypeDef definition
class JourneyPushMessageTypeDef(TypedDict):
TimeToLive: NotRequired[str],JourneyScheduleTypeDef#
# JourneyScheduleTypeDef usage example
from mypy_boto3_pinpoint.type_defs import JourneyScheduleTypeDef
def get_value() -> JourneyScheduleTypeDef:
return {
"EndTime": ...,
}# JourneyScheduleTypeDef definition
class JourneyScheduleTypeDef(TypedDict):
EndTime: NotRequired[Union[datetime, str]],
StartTime: NotRequired[Union[datetime, str]],
Timezone: NotRequired[str],JourneyRunResponseTypeDef#
# JourneyRunResponseTypeDef usage example
from mypy_boto3_pinpoint.type_defs import JourneyRunResponseTypeDef
def get_value() -> JourneyRunResponseTypeDef:
return {
"CreationTime": ...,
"LastUpdateTime": ...,
"RunId": ...,
"Status": ...,
}# JourneyRunResponseTypeDef definition
class JourneyRunResponseTypeDef(TypedDict):
CreationTime: str,
LastUpdateTime: str,
RunId: str,
Status: JourneyRunStatusType, # (1)JourneySMSMessageTypeDef#
# JourneySMSMessageTypeDef usage example
from mypy_boto3_pinpoint.type_defs import JourneySMSMessageTypeDef
def get_value() -> JourneySMSMessageTypeDef:
return {
"MessageType": ...,
}# JourneySMSMessageTypeDef definition
class JourneySMSMessageTypeDef(TypedDict):
MessageType: NotRequired[MessageTypeType], # (1)
OriginationNumber: NotRequired[str],
SenderId: NotRequired[str],
EntityId: NotRequired[str],
TemplateId: NotRequired[str],- See MessageTypeType
JourneyStateRequestTypeDef#
# JourneyStateRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import JourneyStateRequestTypeDef
def get_value() -> JourneyStateRequestTypeDef:
return {
"State": ...,
}# JourneyStateRequestTypeDef definition
class JourneyStateRequestTypeDef(TypedDict):
State: NotRequired[StateType], # (1)- See StateType
ListJourneysRequestRequestTypeDef#
# ListJourneysRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import ListJourneysRequestRequestTypeDef
def get_value() -> ListJourneysRequestRequestTypeDef:
return {
"ApplicationId": ...,
}# ListJourneysRequestRequestTypeDef definition
class ListJourneysRequestRequestTypeDef(TypedDict):
ApplicationId: str,
PageSize: NotRequired[str],
Token: NotRequired[str],ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import ListTagsForResourceRequestRequestTypeDef
def get_value() -> ListTagsForResourceRequestRequestTypeDef:
return {
"ResourceArn": ...,
}# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
ResourceArn: str,TagsModelTypeDef#
# TagsModelTypeDef usage example
from mypy_boto3_pinpoint.type_defs import TagsModelTypeDef
def get_value() -> TagsModelTypeDef:
return {
"tags": ...,
}# TagsModelTypeDef definition
class TagsModelTypeDef(TypedDict):
tags: Dict[str, str],ListTemplateVersionsRequestRequestTypeDef#
# ListTemplateVersionsRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import ListTemplateVersionsRequestRequestTypeDef
def get_value() -> ListTemplateVersionsRequestRequestTypeDef:
return {
"TemplateName": ...,
"TemplateType": ...,
}# ListTemplateVersionsRequestRequestTypeDef definition
class ListTemplateVersionsRequestRequestTypeDef(TypedDict):
TemplateName: str,
TemplateType: str,
NextToken: NotRequired[str],
PageSize: NotRequired[str],ListTemplatesRequestRequestTypeDef#
# ListTemplatesRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import ListTemplatesRequestRequestTypeDef
def get_value() -> ListTemplatesRequestRequestTypeDef:
return {
"NextToken": ...,
}# ListTemplatesRequestRequestTypeDef definition
class ListTemplatesRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
PageSize: NotRequired[str],
Prefix: NotRequired[str],
TemplateType: NotRequired[str],MessageTypeDef#
# MessageTypeDef usage example
from mypy_boto3_pinpoint.type_defs import MessageTypeDef
def get_value() -> MessageTypeDef:
return {
"Action": ...,
}# MessageTypeDef definition
class MessageTypeDef(TypedDict):
Action: NotRequired[ActionType], # (1)
Body: NotRequired[str],
ImageIconUrl: NotRequired[str],
ImageSmallIconUrl: NotRequired[str],
ImageUrl: NotRequired[str],
JsonBody: NotRequired[str],
MediaUrl: NotRequired[str],
RawContent: NotRequired[str],
SilentPush: NotRequired[bool],
TimeToLive: NotRequired[int],
Title: NotRequired[str],
Url: NotRequired[str],- See ActionType
MessageResultTypeDef#
# MessageResultTypeDef usage example
from mypy_boto3_pinpoint.type_defs import MessageResultTypeDef
def get_value() -> MessageResultTypeDef:
return {
"DeliveryStatus": ...,
"StatusCode": ...,
}# MessageResultTypeDef definition
class MessageResultTypeDef(TypedDict):
DeliveryStatus: DeliveryStatusType, # (1)
StatusCode: int,
MessageId: NotRequired[str],
StatusMessage: NotRequired[str],
UpdatedToken: NotRequired[str],NumberValidateRequestTypeDef#
# NumberValidateRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import NumberValidateRequestTypeDef
def get_value() -> NumberValidateRequestTypeDef:
return {
"IsoCountryCode": ...,
}# NumberValidateRequestTypeDef definition
class NumberValidateRequestTypeDef(TypedDict):
IsoCountryCode: NotRequired[str],
PhoneNumber: NotRequired[str],NumberValidateResponseTypeDef#
# NumberValidateResponseTypeDef usage example
from mypy_boto3_pinpoint.type_defs import NumberValidateResponseTypeDef
def get_value() -> NumberValidateResponseTypeDef:
return {
"Carrier": ...,
}# NumberValidateResponseTypeDef definition
class NumberValidateResponseTypeDef(TypedDict):
Carrier: NotRequired[str],
City: NotRequired[str],
CleansedPhoneNumberE164: NotRequired[str],
CleansedPhoneNumberNational: NotRequired[str],
Country: NotRequired[str],
CountryCodeIso2: NotRequired[str],
CountryCodeNumeric: NotRequired[str],
County: NotRequired[str],
OriginalCountryCodeIso2: NotRequired[str],
OriginalPhoneNumber: NotRequired[str],
PhoneType: NotRequired[str],
PhoneTypeCode: NotRequired[int],
Timezone: NotRequired[str],
ZipCode: NotRequired[str],OpenHoursRuleTypeDef#
# OpenHoursRuleTypeDef usage example
from mypy_boto3_pinpoint.type_defs import OpenHoursRuleTypeDef
def get_value() -> OpenHoursRuleTypeDef:
return {
"StartTime": ...,
}# OpenHoursRuleTypeDef definition
class OpenHoursRuleTypeDef(TypedDict):
StartTime: NotRequired[str],
EndTime: NotRequired[str],WriteEventStreamTypeDef#
# WriteEventStreamTypeDef usage example
from mypy_boto3_pinpoint.type_defs import WriteEventStreamTypeDef
def get_value() -> WriteEventStreamTypeDef:
return {
"DestinationStreamArn": ...,
"RoleArn": ...,
}# WriteEventStreamTypeDef definition
class WriteEventStreamTypeDef(TypedDict):
DestinationStreamArn: str,
RoleArn: str,RandomSplitEntryTypeDef#
# RandomSplitEntryTypeDef usage example
from mypy_boto3_pinpoint.type_defs import RandomSplitEntryTypeDef
def get_value() -> RandomSplitEntryTypeDef:
return {
"NextActivity": ...,
}# RandomSplitEntryTypeDef definition
class RandomSplitEntryTypeDef(TypedDict):
NextActivity: NotRequired[str],
Percentage: NotRequired[int],RecencyDimensionTypeDef#
# RecencyDimensionTypeDef usage example
from mypy_boto3_pinpoint.type_defs import RecencyDimensionTypeDef
def get_value() -> RecencyDimensionTypeDef:
return {
"Duration": ...,
"RecencyType": ...,
}# RecencyDimensionTypeDef definition
class RecencyDimensionTypeDef(TypedDict):
Duration: DurationType, # (1)
RecencyType: RecencyTypeType, # (2)- See DurationType
- See RecencyTypeType
UpdateAttributesRequestTypeDef#
# UpdateAttributesRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import UpdateAttributesRequestTypeDef
def get_value() -> UpdateAttributesRequestTypeDef:
return {
"Blacklist": ...,
}# UpdateAttributesRequestTypeDef definition
class UpdateAttributesRequestTypeDef(TypedDict):
Blacklist: NotRequired[Sequence[str]],ResponseMetadataTypeDef#
# ResponseMetadataTypeDef usage example
from mypy_boto3_pinpoint.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,ResultRowValueTypeDef#
# ResultRowValueTypeDef usage example
from mypy_boto3_pinpoint.type_defs import ResultRowValueTypeDef
def get_value() -> ResultRowValueTypeDef:
return {
"Key": ...,
"Type": ...,
"Value": ...,
}# ResultRowValueTypeDef definition
class ResultRowValueTypeDef(TypedDict):
Key: str,
Type: str,
Value: str,SMSChannelRequestTypeDef#
# SMSChannelRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import SMSChannelRequestTypeDef
def get_value() -> SMSChannelRequestTypeDef:
return {
"Enabled": ...,
}# SMSChannelRequestTypeDef definition
class SMSChannelRequestTypeDef(TypedDict):
Enabled: NotRequired[bool],
SenderId: NotRequired[str],
ShortCode: NotRequired[str],SegmentConditionTypeDef#
# SegmentConditionTypeDef usage example
from mypy_boto3_pinpoint.type_defs import SegmentConditionTypeDef
def get_value() -> SegmentConditionTypeDef:
return {
"SegmentId": ...,
}# SegmentConditionTypeDef definition
class SegmentConditionTypeDef(TypedDict):
SegmentId: str,SegmentReferenceTypeDef#
# SegmentReferenceTypeDef usage example
from mypy_boto3_pinpoint.type_defs import SegmentReferenceTypeDef
def get_value() -> SegmentReferenceTypeDef:
return {
"Id": ...,
}# SegmentReferenceTypeDef definition
class SegmentReferenceTypeDef(TypedDict):
Id: str,
Version: NotRequired[int],SegmentImportResourceTypeDef#
# SegmentImportResourceTypeDef usage example
from mypy_boto3_pinpoint.type_defs import SegmentImportResourceTypeDef
def get_value() -> SegmentImportResourceTypeDef:
return {
"ExternalId": ...,
"Format": ...,
"RoleArn": ...,
"S3Url": ...,
"Size": ...,
}# SegmentImportResourceTypeDef definition
class SegmentImportResourceTypeDef(TypedDict):
ExternalId: str,
Format: FormatType, # (1)
RoleArn: str,
S3Url: str,
Size: int,
ChannelCounts: NotRequired[Dict[str, int]],- See FormatType
SendOTPMessageRequestParametersTypeDef#
# SendOTPMessageRequestParametersTypeDef usage example
from mypy_boto3_pinpoint.type_defs import SendOTPMessageRequestParametersTypeDef
def get_value() -> SendOTPMessageRequestParametersTypeDef:
return {
"BrandName": ...,
"Channel": ...,
"DestinationIdentity": ...,
"OriginationIdentity": ...,
"ReferenceId": ...,
}# SendOTPMessageRequestParametersTypeDef definition
class SendOTPMessageRequestParametersTypeDef(TypedDict):
BrandName: str,
Channel: str,
DestinationIdentity: str,
OriginationIdentity: str,
ReferenceId: str,
AllowedAttempts: NotRequired[int],
CodeLength: NotRequired[int],
EntityId: NotRequired[str],
Language: NotRequired[str],
TemplateId: NotRequired[str],
ValidityPeriod: NotRequired[int],SimpleEmailPartTypeDef#
# SimpleEmailPartTypeDef usage example
from mypy_boto3_pinpoint.type_defs import SimpleEmailPartTypeDef
def get_value() -> SimpleEmailPartTypeDef:
return {
"Charset": ...,
}# SimpleEmailPartTypeDef definition
class SimpleEmailPartTypeDef(TypedDict):
Charset: NotRequired[str],
Data: NotRequired[str],TemplateActiveVersionRequestTypeDef#
# TemplateActiveVersionRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import TemplateActiveVersionRequestTypeDef
def get_value() -> TemplateActiveVersionRequestTypeDef:
return {
"Version": ...,
}# TemplateActiveVersionRequestTypeDef definition
class TemplateActiveVersionRequestTypeDef(TypedDict):
Version: NotRequired[str],TemplateTypeDef#
# TemplateTypeDef usage example
from mypy_boto3_pinpoint.type_defs import TemplateTypeDef
def get_value() -> TemplateTypeDef:
return {
"Name": ...,
}# TemplateTypeDef definition
class TemplateTypeDef(TypedDict):
Name: NotRequired[str],
Version: NotRequired[str],TemplateResponseTypeDef#
# TemplateResponseTypeDef usage example
from mypy_boto3_pinpoint.type_defs import TemplateResponseTypeDef
def get_value() -> TemplateResponseTypeDef:
return {
"CreationDate": ...,
"LastModifiedDate": ...,
"TemplateName": ...,
"TemplateType": ...,
}# TemplateResponseTypeDef definition
class TemplateResponseTypeDef(TypedDict):
CreationDate: str,
LastModifiedDate: str,
TemplateName: str,
TemplateType: TemplateTypeType, # (1)
Arn: NotRequired[str],
DefaultSubstitutions: NotRequired[str],
tags: NotRequired[Dict[str, str]],
TemplateDescription: NotRequired[str],
Version: NotRequired[str],- See TemplateTypeType
TemplateVersionResponseTypeDef#
# TemplateVersionResponseTypeDef usage example
from mypy_boto3_pinpoint.type_defs import TemplateVersionResponseTypeDef
def get_value() -> TemplateVersionResponseTypeDef:
return {
"CreationDate": ...,
"LastModifiedDate": ...,
"TemplateName": ...,
"TemplateType": ...,
}# TemplateVersionResponseTypeDef definition
class TemplateVersionResponseTypeDef(TypedDict):
CreationDate: str,
LastModifiedDate: str,
TemplateName: str,
TemplateType: str,
DefaultSubstitutions: NotRequired[str],
TemplateDescription: NotRequired[str],
Version: NotRequired[str],UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import UntagResourceRequestRequestTypeDef
def get_value() -> UntagResourceRequestRequestTypeDef:
return {
"ResourceArn": ...,
"TagKeys": ...,
}# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
ResourceArn: str,
TagKeys: Sequence[str],UpdateRecommenderConfigurationTypeDef#
# UpdateRecommenderConfigurationTypeDef usage example
from mypy_boto3_pinpoint.type_defs import UpdateRecommenderConfigurationTypeDef
def get_value() -> UpdateRecommenderConfigurationTypeDef:
return {
"RecommendationProviderRoleArn": ...,
"RecommendationProviderUri": ...,
}# UpdateRecommenderConfigurationTypeDef definition
class UpdateRecommenderConfigurationTypeDef(TypedDict):
RecommendationProviderRoleArn: str,
RecommendationProviderUri: str,
Attributes: NotRequired[Mapping[str, str]],
Description: NotRequired[str],
Name: NotRequired[str],
RecommendationProviderIdType: NotRequired[str],
RecommendationTransformerUri: NotRequired[str],
RecommendationsDisplayName: NotRequired[str],
RecommendationsPerMessage: NotRequired[int],VoiceChannelRequestTypeDef#
# VoiceChannelRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import VoiceChannelRequestTypeDef
def get_value() -> VoiceChannelRequestTypeDef:
return {
"Enabled": ...,
}# VoiceChannelRequestTypeDef definition
class VoiceChannelRequestTypeDef(TypedDict):
Enabled: NotRequired[bool],VerificationResponseTypeDef#
# VerificationResponseTypeDef usage example
from mypy_boto3_pinpoint.type_defs import VerificationResponseTypeDef
def get_value() -> VerificationResponseTypeDef:
return {
"Valid": ...,
}# VerificationResponseTypeDef definition
class VerificationResponseTypeDef(TypedDict):
Valid: NotRequired[bool],VerifyOTPMessageRequestParametersTypeDef#
# VerifyOTPMessageRequestParametersTypeDef usage example
from mypy_boto3_pinpoint.type_defs import VerifyOTPMessageRequestParametersTypeDef
def get_value() -> VerifyOTPMessageRequestParametersTypeDef:
return {
"DestinationIdentity": ...,
"Otp": ...,
"ReferenceId": ...,
}# VerifyOTPMessageRequestParametersTypeDef definition
class VerifyOTPMessageRequestParametersTypeDef(TypedDict):
DestinationIdentity: str,
Otp: str,
ReferenceId: str,UpdateAdmChannelRequestRequestTypeDef#
# UpdateAdmChannelRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import UpdateAdmChannelRequestRequestTypeDef
def get_value() -> UpdateAdmChannelRequestRequestTypeDef:
return {
"ADMChannelRequest": ...,
"ApplicationId": ...,
}# UpdateAdmChannelRequestRequestTypeDef definition
class UpdateAdmChannelRequestRequestTypeDef(TypedDict):
ADMChannelRequest: ADMChannelRequestTypeDef, # (1)
ApplicationId: str,DeleteAdmChannelResponseTypeDef#
# DeleteAdmChannelResponseTypeDef usage example
from mypy_boto3_pinpoint.type_defs import DeleteAdmChannelResponseTypeDef
def get_value() -> DeleteAdmChannelResponseTypeDef:
return {
"ADMChannelResponse": ...,
"ResponseMetadata": ...,
}# DeleteAdmChannelResponseTypeDef definition
class DeleteAdmChannelResponseTypeDef(TypedDict):
ADMChannelResponse: ADMChannelResponseTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)GetAdmChannelResponseTypeDef#
# GetAdmChannelResponseTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetAdmChannelResponseTypeDef
def get_value() -> GetAdmChannelResponseTypeDef:
return {
"ADMChannelResponse": ...,
"ResponseMetadata": ...,
}# GetAdmChannelResponseTypeDef definition
class GetAdmChannelResponseTypeDef(TypedDict):
ADMChannelResponse: ADMChannelResponseTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)UpdateAdmChannelResponseTypeDef#
# UpdateAdmChannelResponseTypeDef usage example
from mypy_boto3_pinpoint.type_defs import UpdateAdmChannelResponseTypeDef
def get_value() -> UpdateAdmChannelResponseTypeDef:
return {
"ADMChannelResponse": ...,
"ResponseMetadata": ...,
}# UpdateAdmChannelResponseTypeDef definition
class UpdateAdmChannelResponseTypeDef(TypedDict):
ADMChannelResponse: ADMChannelResponseTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)UpdateApnsChannelRequestRequestTypeDef#
# UpdateApnsChannelRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import UpdateApnsChannelRequestRequestTypeDef
def get_value() -> UpdateApnsChannelRequestRequestTypeDef:
return {
"APNSChannelRequest": ...,
"ApplicationId": ...,
}# UpdateApnsChannelRequestRequestTypeDef definition
class UpdateApnsChannelRequestRequestTypeDef(TypedDict):
APNSChannelRequest: APNSChannelRequestTypeDef, # (1)
ApplicationId: str,DeleteApnsChannelResponseTypeDef#
# DeleteApnsChannelResponseTypeDef usage example
from mypy_boto3_pinpoint.type_defs import DeleteApnsChannelResponseTypeDef
def get_value() -> DeleteApnsChannelResponseTypeDef:
return {
"APNSChannelResponse": ...,
"ResponseMetadata": ...,
}# DeleteApnsChannelResponseTypeDef definition
class DeleteApnsChannelResponseTypeDef(TypedDict):
APNSChannelResponse: APNSChannelResponseTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)GetApnsChannelResponseTypeDef#
# GetApnsChannelResponseTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetApnsChannelResponseTypeDef
def get_value() -> GetApnsChannelResponseTypeDef:
return {
"APNSChannelResponse": ...,
"ResponseMetadata": ...,
}# GetApnsChannelResponseTypeDef definition
class GetApnsChannelResponseTypeDef(TypedDict):
APNSChannelResponse: APNSChannelResponseTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)UpdateApnsChannelResponseTypeDef#
# UpdateApnsChannelResponseTypeDef usage example
from mypy_boto3_pinpoint.type_defs import UpdateApnsChannelResponseTypeDef
def get_value() -> UpdateApnsChannelResponseTypeDef:
return {
"APNSChannelResponse": ...,
"ResponseMetadata": ...,
}# UpdateApnsChannelResponseTypeDef definition
class UpdateApnsChannelResponseTypeDef(TypedDict):
APNSChannelResponse: APNSChannelResponseTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)UpdateApnsSandboxChannelRequestRequestTypeDef#
# UpdateApnsSandboxChannelRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import UpdateApnsSandboxChannelRequestRequestTypeDef
def get_value() -> UpdateApnsSandboxChannelRequestRequestTypeDef:
return {
"APNSSandboxChannelRequest": ...,
"ApplicationId": ...,
}# UpdateApnsSandboxChannelRequestRequestTypeDef definition
class UpdateApnsSandboxChannelRequestRequestTypeDef(TypedDict):
APNSSandboxChannelRequest: APNSSandboxChannelRequestTypeDef, # (1)
ApplicationId: str,DeleteApnsSandboxChannelResponseTypeDef#
# DeleteApnsSandboxChannelResponseTypeDef usage example
from mypy_boto3_pinpoint.type_defs import DeleteApnsSandboxChannelResponseTypeDef
def get_value() -> DeleteApnsSandboxChannelResponseTypeDef:
return {
"APNSSandboxChannelResponse": ...,
"ResponseMetadata": ...,
}# DeleteApnsSandboxChannelResponseTypeDef definition
class DeleteApnsSandboxChannelResponseTypeDef(TypedDict):
APNSSandboxChannelResponse: APNSSandboxChannelResponseTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)GetApnsSandboxChannelResponseTypeDef#
# GetApnsSandboxChannelResponseTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetApnsSandboxChannelResponseTypeDef
def get_value() -> GetApnsSandboxChannelResponseTypeDef:
return {
"APNSSandboxChannelResponse": ...,
"ResponseMetadata": ...,
}# GetApnsSandboxChannelResponseTypeDef definition
class GetApnsSandboxChannelResponseTypeDef(TypedDict):
APNSSandboxChannelResponse: APNSSandboxChannelResponseTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)UpdateApnsSandboxChannelResponseTypeDef#
# UpdateApnsSandboxChannelResponseTypeDef usage example
from mypy_boto3_pinpoint.type_defs import UpdateApnsSandboxChannelResponseTypeDef
def get_value() -> UpdateApnsSandboxChannelResponseTypeDef:
return {
"APNSSandboxChannelResponse": ...,
"ResponseMetadata": ...,
}# UpdateApnsSandboxChannelResponseTypeDef definition
class UpdateApnsSandboxChannelResponseTypeDef(TypedDict):
APNSSandboxChannelResponse: APNSSandboxChannelResponseTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)UpdateApnsVoipChannelRequestRequestTypeDef#
# UpdateApnsVoipChannelRequestRequestTypeDef usage example
from mypy_boto3_pinpoint.type_defs import UpdateApnsVoipChannelRequestRequestTypeDef
def get_value() -> UpdateApnsVoipChannelRequestRequestTypeDef:
return {
"APNSVoipChannelRequest": ...,
"ApplicationId": ...,
}# UpdateApnsVoipChannelRequestRequestTypeDef definition
class UpdateApnsVoipChannelRequestRequestTypeDef(TypedDict):
APNSVoipChannelRequest: APNSVoipChannelRequestTypeDef, # (1)
ApplicationId: str,DeleteApnsVoipChannelResponseTypeDef#
# DeleteApnsVoipChannelResponseTypeDef usage example
from mypy_boto3_pinpoint.type_defs import DeleteApnsVoipChannelResponseTypeDef
def get_value() -> DeleteApnsVoipChannelResponseTypeDef:
return {
"APNSVoipChannelResponse": ...,
"ResponseMetadata": ...,
}# DeleteApnsVoipChannelResponseTypeDef definition
class DeleteApnsVoipChannelResponseTypeDef(TypedDict):
APNSVoipChannelResponse: APNSVoipChannelResponseTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)GetApnsVoipChannelResponseTypeDef#
# GetApnsVoipChannelResponseTypeDef usage example
from mypy_boto3_pinpoint.type_defs import GetApnsVoipChannelResponseTypeDef
def get_value() -> GetApnsVoipChannelResponseTypeDef:
return {
"APNSVoipChannelResponse": ...,
"ResponseMetadata": ...,
}# GetApnsVoipChannelResponseTypeDef definition
class GetApnsVoipChannelResponseTypeDef(TypedDict):
APNSVoipChannelResponse: APNSVoipChannelResponseTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)UpdateApnsVoipChannelResponseTypeDef#
# UpdateApnsVoipChannelResponseTypeDef usage example
from mypy_boto3_pinpoint.type_defs import UpdateApnsVoipChannelResponseTypeDef
def get_value() -> UpdateApnsVoipChannelResponseTypeDef:
return {
"APNSVoipChannelResponse": ...,
"ResponseMetadata": ...,
}# UpdateApnsVoipChannelResponseTypeDef definition
class UpdateApnsVoipChannelResponseTypeDef(TypedDict):
APNSVoipChannelResponse: APNSVoipChannelResponseTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)