Typed dictionaries
Auto-generated documentation for Pinpoint type annotations stubs module mypy-boto3-pinpoint.
ADMChannelRequestTypeDef
Usage Example
from mypy_boto3_pinpoint.type_defs import ADMChannelRequestTypeDef
def get_value() -> ADMChannelRequestTypeDef:
return {
"ClientId": ...,
"ClientSecret": ...,
}
Definition
class ADMChannelRequestTypeDef(TypedDict):
ClientId: str,
ClientSecret: str,
Enabled: NotRequired[bool],
ADMChannelResponseTypeDef
Usage Example
from mypy_boto3_pinpoint.type_defs import ADMChannelResponseTypeDef
def get_value() -> ADMChannelResponseTypeDef:
return {
"Platform": ...,
}
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
Usage Example
from mypy_boto3_pinpoint.type_defs import ADMMessageTypeDef
def get_value() -> ADMMessageTypeDef:
return {
"Action": ...,
}
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
Usage Example
from mypy_boto3_pinpoint.type_defs import APNSChannelRequestTypeDef
def get_value() -> APNSChannelRequestTypeDef:
return {
"BundleId": ...,
}
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
Usage Example
from mypy_boto3_pinpoint.type_defs import APNSChannelResponseTypeDef
def get_value() -> APNSChannelResponseTypeDef:
return {
"Platform": ...,
}
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
Usage Example
from mypy_boto3_pinpoint.type_defs import APNSMessageTypeDef
def get_value() -> APNSMessageTypeDef:
return {
"APNSPushType": ...,
}
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
Usage Example
from mypy_boto3_pinpoint.type_defs import APNSPushNotificationTemplateTypeDef
def get_value() -> APNSPushNotificationTemplateTypeDef:
return {
"Action": ...,
}
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
Usage Example
from mypy_boto3_pinpoint.type_defs import APNSSandboxChannelRequestTypeDef
def get_value() -> APNSSandboxChannelRequestTypeDef:
return {
"BundleId": ...,
}
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
Usage Example
from mypy_boto3_pinpoint.type_defs import APNSSandboxChannelResponseTypeDef
def get_value() -> APNSSandboxChannelResponseTypeDef:
return {
"Platform": ...,
}
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
Usage Example
from mypy_boto3_pinpoint.type_defs import APNSVoipChannelRequestTypeDef
def get_value() -> APNSVoipChannelRequestTypeDef:
return {
"BundleId": ...,
}
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
Usage Example
from mypy_boto3_pinpoint.type_defs import APNSVoipChannelResponseTypeDef
def get_value() -> APNSVoipChannelResponseTypeDef:
return {
"Platform": ...,
}
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
Usage Example
from mypy_boto3_pinpoint.type_defs import APNSVoipSandboxChannelRequestTypeDef
def get_value() -> APNSVoipSandboxChannelRequestTypeDef:
return {
"BundleId": ...,
}
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
Usage Example
from mypy_boto3_pinpoint.type_defs import APNSVoipSandboxChannelResponseTypeDef
def get_value() -> APNSVoipSandboxChannelResponseTypeDef:
return {
"Platform": ...,
}
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
Usage Example
from mypy_boto3_pinpoint.type_defs import ActivityResponseTypeDef
def get_value() -> ActivityResponseTypeDef:
return {
"ApplicationId": ...,
"CampaignId": ...,
"Id": ...,
}
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],
ContactCenterActivityTypeDef
Usage Example
from mypy_boto3_pinpoint.type_defs import ContactCenterActivityTypeDef
def get_value() -> ContactCenterActivityTypeDef:
return {
"NextActivity": ...,
}
HoldoutActivityTypeDef
Usage Example
from mypy_boto3_pinpoint.type_defs import HoldoutActivityTypeDef
def get_value() -> HoldoutActivityTypeDef:
return {
"Percentage": ...,
}
AddressConfigurationTypeDef
Usage Example
from mypy_boto3_pinpoint.type_defs import AddressConfigurationTypeDef
def get_value() -> AddressConfigurationTypeDef:
return {
"BodyOverride": ...,
}
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
Usage Example
from mypy_boto3_pinpoint.type_defs import AndroidPushNotificationTemplateTypeDef
def get_value() -> AndroidPushNotificationTemplateTypeDef:
return {
"Action": ...,
}
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
Usage Example
from mypy_boto3_pinpoint.type_defs import ApplicationResponseTypeDef
def get_value() -> ApplicationResponseTypeDef:
return {
"Arn": ...,
"Id": ...,
"Name": ...,
}
Definition
class ApplicationResponseTypeDef(TypedDict):
Arn: str,
Id: str,
Name: str,
tags: NotRequired[Dict[str, str]],
CreationDate: NotRequired[str],
CampaignHookTypeDef
Usage Example
from mypy_boto3_pinpoint.type_defs import CampaignHookTypeDef
def get_value() -> CampaignHookTypeDef:
return {
"LambdaFunctionName": ...,
}
Definition
class CampaignHookTypeDef(TypedDict):
LambdaFunctionName: NotRequired[str],
Mode: NotRequired[ModeType], # (1)
WebUrl: NotRequired[str],
- See ModeType
CampaignLimitsTypeDef
Usage Example
from mypy_boto3_pinpoint.type_defs import CampaignLimitsTypeDef
def get_value() -> CampaignLimitsTypeDef:
return {
"Daily": ...,
}
Definition
class CampaignLimitsTypeDef(TypedDict):
Daily: NotRequired[int],
MaximumDuration: NotRequired[int],
MessagesPerSecond: NotRequired[int],
Total: NotRequired[int],
Session: NotRequired[int],
QuietTimeTypeDef
Usage Example
from mypy_boto3_pinpoint.type_defs import QuietTimeTypeDef
def get_value() -> QuietTimeTypeDef:
return {
"End": ...,
}
AttributeDimensionTypeDef
Usage Example
from mypy_boto3_pinpoint.type_defs import AttributeDimensionTypeDef
def get_value() -> AttributeDimensionTypeDef:
return {
"Values": ...,
}
Definition
class AttributeDimensionTypeDef(TypedDict):
Values: Sequence[str],
AttributeType: NotRequired[AttributeTypeType], # (1)
AttributesResourceTypeDef
Usage Example
from mypy_boto3_pinpoint.type_defs import AttributesResourceTypeDef
def get_value() -> AttributesResourceTypeDef:
return {
"ApplicationId": ...,
"AttributeType": ...,
}
Definition
class AttributesResourceTypeDef(TypedDict):
ApplicationId: str,
AttributeType: str,
Attributes: NotRequired[List[str]],
BaiduChannelRequestTypeDef
Usage Example
from mypy_boto3_pinpoint.type_defs import BaiduChannelRequestTypeDef
def get_value() -> BaiduChannelRequestTypeDef:
return {
"ApiKey": ...,
"SecretKey": ...,
}
Definition
class BaiduChannelRequestTypeDef(TypedDict):
ApiKey: str,
SecretKey: str,
Enabled: NotRequired[bool],
BaiduChannelResponseTypeDef
Usage Example
from mypy_boto3_pinpoint.type_defs import BaiduChannelResponseTypeDef
def get_value() -> BaiduChannelResponseTypeDef:
return {
"Credential": ...,
"Platform": ...,
}
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
Usage Example
from mypy_boto3_pinpoint.type_defs import BaiduMessageTypeDef
def get_value() -> BaiduMessageTypeDef:
return {
"Action": ...,
}
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
Usage Example
from mypy_boto3_pinpoint.type_defs import CampaignCustomMessageTypeDef
def get_value() -> CampaignCustomMessageTypeDef:
return {
"Data": ...,
}
CampaignEmailMessageTypeDef
Usage Example
from mypy_boto3_pinpoint.type_defs import CampaignEmailMessageTypeDef
def get_value() -> CampaignEmailMessageTypeDef:
return {
"Body": ...,
}
Definition
class CampaignEmailMessageTypeDef(TypedDict):
Body: NotRequired[str],
FromAddress: NotRequired[str],
HtmlBody: NotRequired[str],
Title: NotRequired[str],
CampaignStateTypeDef
Usage Example
from mypy_boto3_pinpoint.type_defs import CampaignStateTypeDef
def get_value() -> CampaignStateTypeDef:
return {
"CampaignStatus": ...,
}
Definition
class CampaignStateTypeDef(TypedDict):
CampaignStatus: NotRequired[CampaignStatusType], # (1)
CustomDeliveryConfigurationTypeDef
Usage Example
from mypy_boto3_pinpoint.type_defs import CustomDeliveryConfigurationTypeDef
def get_value() -> CustomDeliveryConfigurationTypeDef:
return {
"DeliveryUri": ...,
}
Definition
class CustomDeliveryConfigurationTypeDef(TypedDict):
DeliveryUri: str,
EndpointTypes: NotRequired[Sequence[EndpointTypesElementType]], # (1)
CampaignSmsMessageTypeDef
Usage Example
from mypy_boto3_pinpoint.type_defs import CampaignSmsMessageTypeDef
def get_value() -> CampaignSmsMessageTypeDef:
return {
"Body": ...,
}
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
Usage Example
from mypy_boto3_pinpoint.type_defs import ChannelResponseTypeDef
def get_value() -> ChannelResponseTypeDef:
return {
"ApplicationId": ...,
}
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
Usage Example
from mypy_boto3_pinpoint.type_defs import ClosedDaysRuleTypeDef
def get_value() -> ClosedDaysRuleTypeDef:
return {
"Name": ...,
}
Definition
class ClosedDaysRuleTypeDef(TypedDict):
Name: NotRequired[str],
StartDateTime: NotRequired[str],
EndDateTime: NotRequired[str],
WaitTimeTypeDef
Usage Example
from mypy_boto3_pinpoint.type_defs import WaitTimeTypeDef
def get_value() -> WaitTimeTypeDef:
return {
"WaitFor": ...,
}
CreateApplicationRequestTypeDef
Usage Example
from mypy_boto3_pinpoint.type_defs import CreateApplicationRequestTypeDef
def get_value() -> CreateApplicationRequestTypeDef:
return {
"Name": ...,
}
Definition
class CreateApplicationRequestTypeDef(TypedDict):
Name: str,
tags: NotRequired[Mapping[str, str]],
ResponseMetadataTypeDef
Usage Example
from mypy_boto3_pinpoint.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
Definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
EmailTemplateRequestTypeDef
Usage Example
from mypy_boto3_pinpoint.type_defs import EmailTemplateRequestTypeDef
def get_value() -> EmailTemplateRequestTypeDef:
return {
"DefaultSubstitutions": ...,
}
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
Usage Example
from mypy_boto3_pinpoint.type_defs import CreateTemplateMessageBodyTypeDef
def get_value() -> CreateTemplateMessageBodyTypeDef:
return {
"Arn": ...,
}
Definition
class CreateTemplateMessageBodyTypeDef(TypedDict):
Arn: NotRequired[str],
Message: NotRequired[str],
RequestID: NotRequired[str],
ExportJobRequestTypeDef
Usage Example
from mypy_boto3_pinpoint.type_defs import ExportJobRequestTypeDef
def get_value() -> ExportJobRequestTypeDef:
return {
"RoleArn": ...,
"S3UrlPrefix": ...,
}
Definition
class ExportJobRequestTypeDef(TypedDict):
RoleArn: str,
S3UrlPrefix: str,
SegmentId: NotRequired[str],
SegmentVersion: NotRequired[int],
ImportJobRequestTypeDef
Usage Example
from mypy_boto3_pinpoint.type_defs import ImportJobRequestTypeDef
def get_value() -> ImportJobRequestTypeDef:
return {
"Format": ...,
"RoleArn": ...,
"S3Url": ...,
}
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
Usage Example
from mypy_boto3_pinpoint.type_defs import TemplateCreateMessageBodyTypeDef
def get_value() -> TemplateCreateMessageBodyTypeDef:
return {
"Arn": ...,
}
Definition
class TemplateCreateMessageBodyTypeDef(TypedDict):
Arn: NotRequired[str],
Message: NotRequired[str],
RequestID: NotRequired[str],
CreateRecommenderConfigurationTypeDef
Usage Example
from mypy_boto3_pinpoint.type_defs import CreateRecommenderConfigurationTypeDef
def get_value() -> CreateRecommenderConfigurationTypeDef:
return {
"RecommendationProviderRoleArn": ...,
"RecommendationProviderUri": ...,
}
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
Usage Example
from mypy_boto3_pinpoint.type_defs import RecommenderConfigurationResponseTypeDef
def get_value() -> RecommenderConfigurationResponseTypeDef:
return {
"CreationDate": ...,
"Id": ...,
"LastModifiedDate": ...,
"RecommendationProviderRoleArn": ...,
"RecommendationProviderUri": ...,
}
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
Usage Example
from mypy_boto3_pinpoint.type_defs import SMSTemplateRequestTypeDef
def get_value() -> SMSTemplateRequestTypeDef:
return {
"Body": ...,
}
Definition
class SMSTemplateRequestTypeDef(TypedDict):
Body: NotRequired[str],
DefaultSubstitutions: NotRequired[str],
RecommenderId: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
TemplateDescription: NotRequired[str],
VoiceTemplateRequestTypeDef
Usage Example
from mypy_boto3_pinpoint.type_defs import VoiceTemplateRequestTypeDef
def get_value() -> VoiceTemplateRequestTypeDef:
return {
"Body": ...,
}
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
Usage Example
from mypy_boto3_pinpoint.type_defs import JourneyCustomMessageTypeDef
def get_value() -> JourneyCustomMessageTypeDef:
return {
"Data": ...,
}
DefaultButtonConfigurationTypeDef
Usage Example
from mypy_boto3_pinpoint.type_defs import DefaultButtonConfigurationTypeDef
def get_value() -> DefaultButtonConfigurationTypeDef:
return {
"ButtonAction": ...,
"Text": ...,
}
Definition
class DefaultButtonConfigurationTypeDef(TypedDict):
ButtonAction: ButtonActionType, # (1)
Text: str,
BackgroundColor: NotRequired[str],
BorderRadius: NotRequired[int],
Link: NotRequired[str],
TextColor: NotRequired[str],
- See ButtonActionType
DefaultMessageTypeDef
Usage Example
from mypy_boto3_pinpoint.type_defs import DefaultMessageTypeDef
def get_value() -> DefaultMessageTypeDef:
return {
"Body": ...,
}
Definition
class DefaultMessageTypeDef(TypedDict):
Body: NotRequired[str],
Substitutions: NotRequired[Mapping[str, Sequence[str]]],
DefaultPushNotificationMessageTypeDef
Usage Example
from mypy_boto3_pinpoint.type_defs import DefaultPushNotificationMessageTypeDef
def get_value() -> DefaultPushNotificationMessageTypeDef:
return {
"Action": ...,
}
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
Usage Example
from mypy_boto3_pinpoint.type_defs import DefaultPushNotificationTemplateTypeDef
def get_value() -> DefaultPushNotificationTemplateTypeDef:
return {
"Action": ...,
}
Definition
class DefaultPushNotificationTemplateTypeDef(TypedDict):
Action: NotRequired[ActionType], # (1)
Body: NotRequired[str],
Sound: NotRequired[str],
Title: NotRequired[str],
Url: NotRequired[str],
- See ActionType
DeleteAdmChannelRequestRequestTypeDef
Usage Example
from mypy_boto3_pinpoint.type_defs import DeleteAdmChannelRequestRequestTypeDef
def get_value() -> DeleteAdmChannelRequestRequestTypeDef:
return {
"ApplicationId": ...,
}
DeleteApnsChannelRequestRequestTypeDef
Usage Example
from mypy_boto3_pinpoint.type_defs import DeleteApnsChannelRequestRequestTypeDef
def get_value() -> DeleteApnsChannelRequestRequestTypeDef:
return {
"ApplicationId": ...,
}
DeleteApnsSandboxChannelRequestRequestTypeDef
Usage Example
from mypy_boto3_pinpoint.type_defs import DeleteApnsSandboxChannelRequestRequestTypeDef
def get_value() -> DeleteApnsSandboxChannelRequestRequestTypeDef:
return {
"ApplicationId": ...,
}
DeleteApnsVoipChannelRequestRequestTypeDef
Usage Example
from mypy_boto3_pinpoint.type_defs import DeleteApnsVoipChannelRequestRequestTypeDef
def get_value() -> DeleteApnsVoipChannelRequestRequestTypeDef:
return {
"ApplicationId": ...,
}
DeleteApnsVoipSandboxChannelRequestRequestTypeDef
Usage Example
from mypy_boto3_pinpoint.type_defs import DeleteApnsVoipSandboxChannelRequestRequestTypeDef
def get_value() -> DeleteApnsVoipSandboxChannelRequestRequestTypeDef:
return {
"ApplicationId": ...,
}
DeleteAppRequestRequestTypeDef
Usage Example
from mypy_boto3_pinpoint.type_defs import DeleteAppRequestRequestTypeDef
def get_value() -> DeleteAppRequestRequestTypeDef:
return {
"ApplicationId": ...,
}
DeleteBaiduChannelRequestRequestTypeDef
Usage Example
from mypy_boto3_pinpoint.type_defs import DeleteBaiduChannelRequestRequestTypeDef
def get_value() -> DeleteBaiduChannelRequestRequestTypeDef:
return {
"ApplicationId": ...,
}
DeleteCampaignRequestRequestTypeDef
Usage Example
from mypy_boto3_pinpoint.type_defs import DeleteCampaignRequestRequestTypeDef
def get_value() -> DeleteCampaignRequestRequestTypeDef:
return {
"ApplicationId": ...,
"CampaignId": ...,
}
Definition
class DeleteCampaignRequestRequestTypeDef(TypedDict):
ApplicationId: str,
CampaignId: str,
DeleteEmailChannelRequestRequestTypeDef
Usage Example
from mypy_boto3_pinpoint.type_defs import DeleteEmailChannelRequestRequestTypeDef
def get_value() -> DeleteEmailChannelRequestRequestTypeDef:
return {
"ApplicationId": ...,
}
EmailChannelResponseTypeDef
Usage Example
from mypy_boto3_pinpoint.type_defs import EmailChannelResponseTypeDef
def get_value() -> EmailChannelResponseTypeDef:
return {
"Platform": ...,
}
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
Usage Example
from mypy_boto3_pinpoint.type_defs import DeleteEmailTemplateRequestRequestTypeDef
def get_value() -> DeleteEmailTemplateRequestRequestTypeDef:
return {
"TemplateName": ...,
}
Definition
class DeleteEmailTemplateRequestRequestTypeDef(TypedDict):
TemplateName: str,
Version: NotRequired[str],
MessageBodyTypeDef
Usage Example
from mypy_boto3_pinpoint.type_defs import MessageBodyTypeDef
def get_value() -> MessageBodyTypeDef:
return {
"Message": ...,
}
Definition
class MessageBodyTypeDef(TypedDict):
Message: NotRequired[str],
RequestID: NotRequired[str],
DeleteEndpointRequestRequestTypeDef
Usage Example
from mypy_boto3_pinpoint.type_defs import DeleteEndpointRequestRequestTypeDef
def get_value() -> DeleteEndpointRequestRequestTypeDef:
return {
"ApplicationId": ...,
"EndpointId": ...,
}
Definition
class DeleteEndpointRequestRequestTypeDef(TypedDict):
ApplicationId: str,
EndpointId: str,