Skip to content

Typed dictionaries

Index > Pinpoint > 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],
  1. 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],
  1. 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],
  1. 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": ...,
    }
Definition
class ContactCenterActivityTypeDef(TypedDict):
    NextActivity: NotRequired[str],

HoldoutActivityTypeDef

Usage Example
from mypy_boto3_pinpoint.type_defs import HoldoutActivityTypeDef

def get_value() -> HoldoutActivityTypeDef:
    return {
        "Percentage": ...,
    }
Definition
class HoldoutActivityTypeDef(TypedDict):
    Percentage: int,
    NextActivity: NotRequired[str],

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],
  1. 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],
  1. 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],
  1. 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": ...,
    }
Definition
class QuietTimeTypeDef(TypedDict):
    End: NotRequired[str],
    Start: NotRequired[str],

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)
  1. See AttributeTypeType

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],
  1. See ActionType

CampaignCustomMessageTypeDef

Usage Example
from mypy_boto3_pinpoint.type_defs import CampaignCustomMessageTypeDef

def get_value() -> CampaignCustomMessageTypeDef:
    return {
        "Data": ...,
    }
Definition
class CampaignCustomMessageTypeDef(TypedDict):
    Data: NotRequired[str],

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)
  1. See CampaignStatusType

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)
  1. See EndpointTypesElementType

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],
  1. 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": ...,
    }
Definition
class WaitTimeTypeDef(TypedDict):
    WaitFor: NotRequired[str],
    WaitUntil: NotRequired[str],

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],
  1. 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": ...,
    }
Definition
class JourneyCustomMessageTypeDef(TypedDict):
    Data: NotRequired[str],

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],
  1. 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],
  1. 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],
  1. See ActionType

DeleteAdmChannelRequestRequestTypeDef

Usage Example
from mypy_boto3_pinpoint.type_defs import DeleteAdmChannelRequestRequestTypeDef

def get_value() -> DeleteAdmChannelRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
    }
Definition
class DeleteAdmChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

DeleteApnsChannelRequestRequestTypeDef

Usage Example
from mypy_boto3_pinpoint.type_defs import DeleteApnsChannelRequestRequestTypeDef

def get_value() -> DeleteApnsChannelRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
    }
Definition
class DeleteApnsChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

DeleteApnsSandboxChannelRequestRequestTypeDef

Usage Example
from mypy_boto3_pinpoint.type_defs import DeleteApnsSandboxChannelRequestRequestTypeDef

def get_value() -> DeleteApnsSandboxChannelRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
    }
Definition
class DeleteApnsSandboxChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

DeleteApnsVoipChannelRequestRequestTypeDef

Usage Example
from mypy_boto3_pinpoint.type_defs import DeleteApnsVoipChannelRequestRequestTypeDef

def get_value() -> DeleteApnsVoipChannelRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
    }
Definition
class DeleteApnsVoipChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

DeleteApnsVoipSandboxChannelRequestRequestTypeDef

Usage Example
from mypy_boto3_pinpoint.type_defs import DeleteApnsVoipSandboxChannelRequestRequestTypeDef

def get_value() -> DeleteApnsVoipSandboxChannelRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
    }
Definition
class DeleteApnsVoipSandboxChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

DeleteAppRequestRequestTypeDef

Usage Example
from mypy_boto3_pinpoint.type_defs import DeleteAppRequestRequestTypeDef

def get_value() -> DeleteAppRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
    }
Definition
class DeleteAppRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

DeleteBaiduChannelRequestRequestTypeDef

Usage Example
from mypy_boto3_pinpoint.type_defs import DeleteBaiduChannelRequestRequestTypeDef

def get_value() -> DeleteBaiduChannelRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
    }
Definition
class DeleteBaiduChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

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": ...,
    }
Definition
class DeleteEmailChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

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,

DeleteEventStreamRequestRequestTypeDef

Usage Example
from mypy_boto3_pinpoint.type_defs import DeleteEventStreamRequestRequestTypeDef

def get_value() -> DeleteEventStreamRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
    }
Definition
class DeleteEventStreamRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

EventStreamTypeDef

Usage Example
from mypy_boto3_pinpoint.type_defs import EventStreamTypeDef

def get_value() -> EventStreamTypeDef:
    return {
        "ApplicationId": ...,
        "DestinationStreamArn": ...,
        "RoleArn": ...,
    }
Definition
class EventStreamTypeDef(TypedDict):
    ApplicationId: str,
    DestinationStreamArn: str,
    RoleArn: str,
    ExternalId: NotRequired[str],
    LastModifiedDate: NotRequired[str],
    LastUpdatedBy: NotRequired[str],

DeleteGcmChannelRequestRequestTypeDef

Usage Example
from mypy_boto3_pinpoint.type_defs import DeleteGcmChannelRequestRequestTypeDef

def get_value() -> DeleteGcmChannelRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
    }
Definition
class DeleteGcmChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

GCMChannelResponseTypeDef

Usage Example
from mypy_boto3_pinpoint.type_defs import GCMChannelResponseTypeDef

def get_value() -> GCMChannelResponseTypeDef:
    return {
        "Credential": ...,
        "Platform": ...,
    }
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

Usage Example
from mypy_boto3_pinpoint.type_defs import DeleteInAppTemplateRequestRequestTypeDef

def get_value() -> DeleteInAppTemplateRequestRequestTypeDef:
    return {
        "TemplateName": ...,
    }
Definition
class DeleteInAppTemplateRequestRequestTypeDef(TypedDict):
    TemplateName: str,
    Version: NotRequired[str],

DeleteJourneyRequestRequestTypeDef

Usage Example
from mypy_boto3_pinpoint.type_defs import DeleteJourneyRequestRequestTypeDef

def get_value() -> DeleteJourneyRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "JourneyId": ...,
    }
Definition
class DeleteJourneyRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    JourneyId: str,

DeletePushTemplateRequestRequestTypeDef

Usage Example
from mypy_boto3_pinpoint.type_defs import DeletePushTemplateRequestRequestTypeDef

def get_value() -> DeletePushTemplateRequestRequestTypeDef:
    return {
        "TemplateName": ...,
    }
Definition
class DeletePushTemplateRequestRequestTypeDef(TypedDict):
    TemplateName: str,
    Version: NotRequired[str],

DeleteRecommenderConfigurationRequestRequestTypeDef

Usage Example
from mypy_boto3_pinpoint.type_defs import DeleteRecommenderConfigurationRequestRequestTypeDef

def get_value() -> DeleteRecommenderConfigurationRequestRequestTypeDef:
    return {
        "RecommenderId": ...,
    }
Definition
class DeleteRecommenderConfigurationRequestRequestTypeDef(TypedDict):
    RecommenderId: str,

DeleteSegmentRequestRequestTypeDef

Usage Example
from mypy_boto3_pinpoint.type_defs import DeleteSegmentRequestRequestTypeDef

def get_value() -> DeleteSegmentRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "SegmentId": ...,
    }
Definition
class DeleteSegmentRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    SegmentId: str,

DeleteSmsChannelRequestRequestTypeDef

Usage Example
from mypy_boto3_pinpoint.type_defs import DeleteSmsChannelRequestRequestTypeDef

def get_value() -> DeleteSmsChannelRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
    }
Definition
class DeleteSmsChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

SMSChannelResponseTypeDef

Usage Example
from mypy_boto3_pinpoint.type_defs import SMSChannelResponseTypeDef

def get_value() -> SMSChannelResponseTypeDef:
    return {
        "Platform": ...,
    }
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

Usage Example
from mypy_boto3_pinpoint.type_defs import DeleteSmsTemplateRequestRequestTypeDef

def get_value() -> DeleteSmsTemplateRequestRequestTypeDef:
    return {
        "TemplateName": ...,
    }
Definition
class DeleteSmsTemplateRequestRequestTypeDef(TypedDict):
    TemplateName: str,
    Version: NotRequired[str],

DeleteUserEndpointsRequestRequestTypeDef

Usage Example
from mypy_boto3_pinpoint.type_defs import DeleteUserEndpointsRequestRequestTypeDef

def get_value() -> DeleteUserEndpointsRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "UserId": ...,
    }
Definition
class DeleteUserEndpointsRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    UserId: str,

DeleteVoiceChannelRequestRequestTypeDef

Usage Example
from mypy_boto3_pinpoint.type_defs import DeleteVoiceChannelRequestRequestTypeDef

def get_value() -> DeleteVoiceChannelRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
    }
Definition
class DeleteVoiceChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

VoiceChannelResponseTypeDef

Usage Example
from mypy_boto3_pinpoint.type_defs import VoiceChannelResponseTypeDef

def get_value() -> VoiceChannelResponseTypeDef:
    return {
        "Platform": ...,
    }
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

Usage Example
from mypy_boto3_pinpoint.type_defs import DeleteVoiceTemplateRequestRequestTypeDef

def get_value() -> DeleteVoiceTemplateRequestRequestTypeDef:
    return {
        "TemplateName": ...,
    }
Definition
class DeleteVoiceTemplateRequestRequestTypeDef(TypedDict):
    TemplateName: str,
    Version: NotRequired[str],

GCMMessageTypeDef

Usage Example
from mypy_boto3_pinpoint.type_defs import GCMMessageTypeDef

def get_value() -> GCMMessageTypeDef:
    return {
        "Action": ...,
    }
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],
  1. See ActionType

SMSMessageTypeDef

Usage Example
from mypy_boto3_pinpoint.type_defs import SMSMessageTypeDef

def get_value() -> SMSMessageTypeDef:
    return {
        "Body": ...,
    }
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],
  1. See MessageTypeType

VoiceMessageTypeDef

Usage Example
from mypy_boto3_pinpoint.type_defs import VoiceMessageTypeDef

def get_value() -> VoiceMessageTypeDef:
    return {
        "Body": ...,
    }
Definition
class VoiceMessageTypeDef(TypedDict):
    Body: NotRequired[str],
    LanguageCode: NotRequired[str],
    OriginationNumber: NotRequired[str],
    Substitutions: NotRequired[Mapping[str, Sequence[str]]],
    VoiceId: NotRequired[str],

EmailChannelRequestTypeDef

Usage Example
from mypy_boto3_pinpoint.type_defs import EmailChannelRequestTypeDef

def get_value() -> EmailChannelRequestTypeDef:
    return {
        "FromAddress": ...,
        "Identity": ...,
    }
Definition
class EmailChannelRequestTypeDef(TypedDict):
    FromAddress: str,
    Identity: str,
    ConfigurationSet: NotRequired[str],
    Enabled: NotRequired[bool],
    RoleArn: NotRequired[str],

JourneyEmailMessageTypeDef

Usage Example
from mypy_boto3_pinpoint.type_defs import JourneyEmailMessageTypeDef

def get_value() -> JourneyEmailMessageTypeDef:
    return {
        "FromAddress": ...,
    }
Definition
class JourneyEmailMessageTypeDef(TypedDict):
    FromAddress: NotRequired[str],

RawEmailTypeDef

Usage Example
from mypy_boto3_pinpoint.type_defs import RawEmailTypeDef

def get_value() -> RawEmailTypeDef:
    return {
        "Data": ...,
    }
Definition
class RawEmailTypeDef(TypedDict):