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):
    Data: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],

EmailTemplateResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import EmailTemplateResponseTypeDef

def get_value() -> EmailTemplateResponseTypeDef:
    return {
        "CreationDate": ...,
        "LastModifiedDate": ...,
        "TemplateName": ...,
        "TemplateType": ...,
    }

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],

1. See TemplateTypeType

EndpointDemographicTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import EndpointDemographicTypeDef

def get_value() -> EndpointDemographicTypeDef:
    return {
        "AppVersion": ...,
    }

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

Usage Example

from mypy_boto3_pinpoint.type_defs import EndpointLocationTypeDef

def get_value() -> EndpointLocationTypeDef:
    return {
        "City": ...,
    }

Definition

class EndpointLocationTypeDef(TypedDict):
    City: NotRequired[str],
    Country: NotRequired[str],
    Latitude: NotRequired[float],
    Longitude: NotRequired[float],
    PostalCode: NotRequired[str],
    Region: NotRequired[str],

EndpointUserTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import EndpointUserTypeDef

def get_value() -> EndpointUserTypeDef:
    return {
        "UserAttributes": ...,
    }

Definition

class EndpointUserTypeDef(TypedDict):
    UserAttributes: NotRequired[Dict[str, List[str]]],
    UserId: NotRequired[str],

EndpointItemResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import EndpointItemResponseTypeDef

def get_value() -> EndpointItemResponseTypeDef:
    return {
        "Message": ...,
    }

Definition

class EndpointItemResponseTypeDef(TypedDict):
    Message: NotRequired[str],
    StatusCode: NotRequired[int],

EndpointMessageResultTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import EndpointMessageResultTypeDef

def get_value() -> EndpointMessageResultTypeDef:
    return {
        "DeliveryStatus": ...,
        "StatusCode": ...,
    }

Definition

class EndpointMessageResultTypeDef(TypedDict):
    DeliveryStatus: DeliveryStatusType,  # (1)
    StatusCode: int,
    Address: NotRequired[str],
    MessageId: NotRequired[str],
    StatusMessage: NotRequired[str],
    UpdatedToken: NotRequired[str],

1. See DeliveryStatusType

EndpointSendConfigurationTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import EndpointSendConfigurationTypeDef

def get_value() -> EndpointSendConfigurationTypeDef:
    return {
        "BodyOverride": ...,
    }

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

Usage Example

from mypy_boto3_pinpoint.type_defs import MetricDimensionTypeDef

def get_value() -> MetricDimensionTypeDef:
    return {
        "ComparisonOperator": ...,
        "Value": ...,
    }

Definition

class MetricDimensionTypeDef(TypedDict):
    ComparisonOperator: str,
    Value: float,

SetDimensionTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import SetDimensionTypeDef

def get_value() -> SetDimensionTypeDef:
    return {
        "Values": ...,
    }

Definition

class SetDimensionTypeDef(TypedDict):
    Values: Sequence[str],
    DimensionType: NotRequired[DimensionTypeType],  # (1)

1. See DimensionTypeType

EventItemResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import EventItemResponseTypeDef

def get_value() -> EventItemResponseTypeDef:
    return {
        "Message": ...,
    }

Definition

class EventItemResponseTypeDef(TypedDict):
    Message: NotRequired[str],
    StatusCode: NotRequired[int],

SessionTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import SessionTypeDef

def get_value() -> SessionTypeDef:
    return {
        "Id": ...,
        "StartTimestamp": ...,
    }

Definition

class SessionTypeDef(TypedDict):
    Id: str,
    StartTimestamp: str,
    Duration: NotRequired[int],
    StopTimestamp: NotRequired[str],

ExportJobResourceTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import ExportJobResourceTypeDef

def get_value() -> ExportJobResourceTypeDef:
    return {
        "RoleArn": ...,
        "S3UrlPrefix": ...,
    }

Definition

class ExportJobResourceTypeDef(TypedDict):
    RoleArn: str,
    S3UrlPrefix: str,
    SegmentId: NotRequired[str],
    SegmentVersion: NotRequired[int],

GCMChannelRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GCMChannelRequestTypeDef

def get_value() -> GCMChannelRequestTypeDef:
    return {
        "ApiKey": ...,
    }

Definition

class GCMChannelRequestTypeDef(TypedDict):
    ApiKey: str,
    Enabled: NotRequired[bool],

GPSCoordinatesTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GPSCoordinatesTypeDef

def get_value() -> GPSCoordinatesTypeDef:
    return {
        "Latitude": ...,
        "Longitude": ...,
    }

Definition

class GPSCoordinatesTypeDef(TypedDict):
    Latitude: float,
    Longitude: float,

GetAdmChannelRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetAdmChannelRequestRequestTypeDef

def get_value() -> GetAdmChannelRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
    }

Definition

class GetAdmChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

GetApnsChannelRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetApnsChannelRequestRequestTypeDef

def get_value() -> GetApnsChannelRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
    }

Definition

class GetApnsChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

GetApnsSandboxChannelRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetApnsSandboxChannelRequestRequestTypeDef

def get_value() -> GetApnsSandboxChannelRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
    }

Definition

class GetApnsSandboxChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

GetApnsVoipChannelRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetApnsVoipChannelRequestRequestTypeDef

def get_value() -> GetApnsVoipChannelRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
    }

Definition

class GetApnsVoipChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

GetApnsVoipSandboxChannelRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetApnsVoipSandboxChannelRequestRequestTypeDef

def get_value() -> GetApnsVoipSandboxChannelRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
    }

Definition

class GetApnsVoipSandboxChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

GetAppRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetAppRequestRequestTypeDef

def get_value() -> GetAppRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
    }

Definition

class GetAppRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

GetApplicationDateRangeKpiRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetApplicationDateRangeKpiRequestRequestTypeDef

def get_value() -> GetApplicationDateRangeKpiRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "KpiName": ...,
    }

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

Usage Example

from mypy_boto3_pinpoint.type_defs import GetApplicationSettingsRequestRequestTypeDef

def get_value() -> GetApplicationSettingsRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
    }

Definition

class GetApplicationSettingsRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

GetAppsRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetAppsRequestRequestTypeDef

def get_value() -> GetAppsRequestRequestTypeDef:
    return {
        "PageSize": ...,
    }

Definition

class GetAppsRequestRequestTypeDef(TypedDict):
    PageSize: NotRequired[str],
    Token: NotRequired[str],

GetBaiduChannelRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetBaiduChannelRequestRequestTypeDef

def get_value() -> GetBaiduChannelRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
    }

Definition

class GetBaiduChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

GetCampaignActivitiesRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetCampaignActivitiesRequestRequestTypeDef

def get_value() -> GetCampaignActivitiesRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "CampaignId": ...,
    }

Definition

class GetCampaignActivitiesRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    CampaignId: str,
    PageSize: NotRequired[str],
    Token: NotRequired[str],

GetCampaignDateRangeKpiRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetCampaignDateRangeKpiRequestRequestTypeDef

def get_value() -> GetCampaignDateRangeKpiRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "CampaignId": ...,
        "KpiName": ...,
    }

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

Usage Example

from mypy_boto3_pinpoint.type_defs import GetCampaignRequestRequestTypeDef

def get_value() -> GetCampaignRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "CampaignId": ...,
    }

Definition

class GetCampaignRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    CampaignId: str,

GetCampaignVersionRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetCampaignVersionRequestRequestTypeDef

def get_value() -> GetCampaignVersionRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "CampaignId": ...,
        "Version": ...,
    }

Definition

class GetCampaignVersionRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    CampaignId: str,
    Version: str,

GetCampaignVersionsRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetCampaignVersionsRequestRequestTypeDef

def get_value() -> GetCampaignVersionsRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "CampaignId": ...,
    }

Definition

class GetCampaignVersionsRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    CampaignId: str,
    PageSize: NotRequired[str],
    Token: NotRequired[str],

GetCampaignsRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetCampaignsRequestRequestTypeDef

def get_value() -> GetCampaignsRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
    }

Definition

class GetCampaignsRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    PageSize: NotRequired[str],
    Token: NotRequired[str],

GetChannelsRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetChannelsRequestRequestTypeDef

def get_value() -> GetChannelsRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
    }

Definition

class GetChannelsRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

GetEmailChannelRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetEmailChannelRequestRequestTypeDef

def get_value() -> GetEmailChannelRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
    }

Definition

class GetEmailChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

GetEmailTemplateRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetEmailTemplateRequestRequestTypeDef

def get_value() -> GetEmailTemplateRequestRequestTypeDef:
    return {
        "TemplateName": ...,
    }

Definition

class GetEmailTemplateRequestRequestTypeDef(TypedDict):
    TemplateName: str,
    Version: NotRequired[str],

GetEndpointRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetEndpointRequestRequestTypeDef

def get_value() -> GetEndpointRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "EndpointId": ...,
    }

Definition

class GetEndpointRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    EndpointId: str,

GetEventStreamRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetEventStreamRequestRequestTypeDef

def get_value() -> GetEventStreamRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
    }

Definition

class GetEventStreamRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

GetExportJobRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetExportJobRequestRequestTypeDef

def get_value() -> GetExportJobRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "JobId": ...,
    }

Definition

class GetExportJobRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    JobId: str,

GetExportJobsRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetExportJobsRequestRequestTypeDef

def get_value() -> GetExportJobsRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
    }

Definition

class GetExportJobsRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    PageSize: NotRequired[str],
    Token: NotRequired[str],

GetGcmChannelRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetGcmChannelRequestRequestTypeDef

def get_value() -> GetGcmChannelRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
    }

Definition

class GetGcmChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

GetImportJobRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetImportJobRequestRequestTypeDef

def get_value() -> GetImportJobRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "JobId": ...,
    }

Definition

class GetImportJobRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    JobId: str,

GetImportJobsRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetImportJobsRequestRequestTypeDef

def get_value() -> GetImportJobsRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
    }

Definition

class GetImportJobsRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    PageSize: NotRequired[str],
    Token: NotRequired[str],

GetInAppMessagesRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetInAppMessagesRequestRequestTypeDef

def get_value() -> GetInAppMessagesRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "EndpointId": ...,
    }

Definition

class GetInAppMessagesRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    EndpointId: str,

GetInAppTemplateRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetInAppTemplateRequestRequestTypeDef

def get_value() -> GetInAppTemplateRequestRequestTypeDef:
    return {
        "TemplateName": ...,
    }

Definition

class GetInAppTemplateRequestRequestTypeDef(TypedDict):
    TemplateName: str,
    Version: NotRequired[str],

GetJourneyDateRangeKpiRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetJourneyDateRangeKpiRequestRequestTypeDef

def get_value() -> GetJourneyDateRangeKpiRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "JourneyId": ...,
        "KpiName": ...,
    }

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

Usage Example

from mypy_boto3_pinpoint.type_defs import GetJourneyExecutionActivityMetricsRequestRequestTypeDef

def get_value() -> GetJourneyExecutionActivityMetricsRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "JourneyActivityId": ...,
        "JourneyId": ...,
    }

Definition

class GetJourneyExecutionActivityMetricsRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    JourneyActivityId: str,
    JourneyId: str,
    NextToken: NotRequired[str],
    PageSize: NotRequired[str],

JourneyExecutionActivityMetricsResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import JourneyExecutionActivityMetricsResponseTypeDef

def get_value() -> JourneyExecutionActivityMetricsResponseTypeDef:
    return {
        "ActivityType": ...,
        "ApplicationId": ...,
        "JourneyActivityId": ...,
        "JourneyId": ...,
        "LastEvaluatedTime": ...,
        "Metrics": ...,
    }

Definition

class JourneyExecutionActivityMetricsResponseTypeDef(TypedDict):
    ActivityType: str,
    ApplicationId: str,
    JourneyActivityId: str,
    JourneyId: str,
    LastEvaluatedTime: str,
    Metrics: Dict[str, str],

GetJourneyExecutionMetricsRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetJourneyExecutionMetricsRequestRequestTypeDef

def get_value() -> GetJourneyExecutionMetricsRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "JourneyId": ...,
    }

Definition

class GetJourneyExecutionMetricsRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    JourneyId: str,
    NextToken: NotRequired[str],
    PageSize: NotRequired[str],

JourneyExecutionMetricsResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import JourneyExecutionMetricsResponseTypeDef

def get_value() -> JourneyExecutionMetricsResponseTypeDef:
    return {
        "ApplicationId": ...,
        "JourneyId": ...,
        "LastEvaluatedTime": ...,
        "Metrics": ...,
    }

Definition

class JourneyExecutionMetricsResponseTypeDef(TypedDict):
    ApplicationId: str,
    JourneyId: str,
    LastEvaluatedTime: str,
    Metrics: Dict[str, str],

GetJourneyRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetJourneyRequestRequestTypeDef

def get_value() -> GetJourneyRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "JourneyId": ...,
    }

Definition

class GetJourneyRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    JourneyId: str,

GetPushTemplateRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetPushTemplateRequestRequestTypeDef

def get_value() -> GetPushTemplateRequestRequestTypeDef:
    return {
        "TemplateName": ...,
    }

Definition

class GetPushTemplateRequestRequestTypeDef(TypedDict):
    TemplateName: str,
    Version: NotRequired[str],

GetRecommenderConfigurationRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetRecommenderConfigurationRequestRequestTypeDef

def get_value() -> GetRecommenderConfigurationRequestRequestTypeDef:
    return {
        "RecommenderId": ...,
    }

Definition

class GetRecommenderConfigurationRequestRequestTypeDef(TypedDict):
    RecommenderId: str,

GetRecommenderConfigurationsRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetRecommenderConfigurationsRequestRequestTypeDef

def get_value() -> GetRecommenderConfigurationsRequestRequestTypeDef:
    return {
        "PageSize": ...,
    }

Definition

class GetRecommenderConfigurationsRequestRequestTypeDef(TypedDict):
    PageSize: NotRequired[str],
    Token: NotRequired[str],

GetSegmentExportJobsRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetSegmentExportJobsRequestRequestTypeDef

def get_value() -> GetSegmentExportJobsRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "SegmentId": ...,
    }

Definition

class GetSegmentExportJobsRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    SegmentId: str,
    PageSize: NotRequired[str],
    Token: NotRequired[str],

GetSegmentImportJobsRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetSegmentImportJobsRequestRequestTypeDef

def get_value() -> GetSegmentImportJobsRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "SegmentId": ...,
    }

Definition

class GetSegmentImportJobsRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    SegmentId: str,
    PageSize: NotRequired[str],
    Token: NotRequired[str],

GetSegmentRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetSegmentRequestRequestTypeDef

def get_value() -> GetSegmentRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "SegmentId": ...,
    }

Definition

class GetSegmentRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    SegmentId: str,

GetSegmentVersionRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetSegmentVersionRequestRequestTypeDef

def get_value() -> GetSegmentVersionRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "SegmentId": ...,
        "Version": ...,
    }

Definition

class GetSegmentVersionRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    SegmentId: str,
    Version: str,

GetSegmentVersionsRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetSegmentVersionsRequestRequestTypeDef

def get_value() -> GetSegmentVersionsRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "SegmentId": ...,
    }

Definition

class GetSegmentVersionsRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    SegmentId: str,
    PageSize: NotRequired[str],
    Token: NotRequired[str],

GetSegmentsRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetSegmentsRequestRequestTypeDef

def get_value() -> GetSegmentsRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
    }

Definition

class GetSegmentsRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    PageSize: NotRequired[str],
    Token: NotRequired[str],

GetSmsChannelRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetSmsChannelRequestRequestTypeDef

def get_value() -> GetSmsChannelRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
    }

Definition

class GetSmsChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

GetSmsTemplateRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetSmsTemplateRequestRequestTypeDef

def get_value() -> GetSmsTemplateRequestRequestTypeDef:
    return {
        "TemplateName": ...,
    }

Definition

class GetSmsTemplateRequestRequestTypeDef(TypedDict):
    TemplateName: str,
    Version: NotRequired[str],

SMSTemplateResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import SMSTemplateResponseTypeDef

def get_value() -> SMSTemplateResponseTypeDef:
    return {
        "CreationDate": ...,
        "LastModifiedDate": ...,
        "TemplateName": ...,
        "TemplateType": ...,
    }

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],

1. See TemplateTypeType

GetUserEndpointsRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetUserEndpointsRequestRequestTypeDef

def get_value() -> GetUserEndpointsRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "UserId": ...,
    }

Definition

class GetUserEndpointsRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    UserId: str,

GetVoiceChannelRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetVoiceChannelRequestRequestTypeDef

def get_value() -> GetVoiceChannelRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
    }

Definition

class GetVoiceChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

GetVoiceTemplateRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetVoiceTemplateRequestRequestTypeDef

def get_value() -> GetVoiceTemplateRequestRequestTypeDef:
    return {
        "TemplateName": ...,
    }

Definition

class GetVoiceTemplateRequestRequestTypeDef(TypedDict):
    TemplateName: str,
    Version: NotRequired[str],

VoiceTemplateResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import VoiceTemplateResponseTypeDef

def get_value() -> VoiceTemplateResponseTypeDef:
    return {
        "CreationDate": ...,
        "LastModifiedDate": ...,
        "TemplateName": ...,
        "TemplateType": ...,
    }

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],

1. See TemplateTypeType

ImportJobResourceTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import ImportJobResourceTypeDef

def get_value() -> ImportJobResourceTypeDef:
    return {
        "Format": ...,
        "RoleArn": ...,
        "S3Url": ...,
    }

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],

1. See FormatType

InAppMessageBodyConfigTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import InAppMessageBodyConfigTypeDef

def get_value() -> InAppMessageBodyConfigTypeDef:
    return {
        "Alignment": ...,
        "Body": ...,
        "TextColor": ...,
    }

Definition

class InAppMessageBodyConfigTypeDef(TypedDict):
    Alignment: AlignmentType,  # (1)
    Body: str,
    TextColor: str,

1. See AlignmentType

OverrideButtonConfigurationTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import OverrideButtonConfigurationTypeDef

def get_value() -> OverrideButtonConfigurationTypeDef:
    return {
        "ButtonAction": ...,
    }

Definition

class OverrideButtonConfigurationTypeDef(TypedDict):
    ButtonAction: ButtonActionType,  # (1)
    Link: NotRequired[str],

1. See ButtonActionType

InAppMessageHeaderConfigTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import InAppMessageHeaderConfigTypeDef

def get_value() -> InAppMessageHeaderConfigTypeDef:
    return {
        "Alignment": ...,
        "Header": ...,
        "TextColor": ...,
    }

Definition

class InAppMessageHeaderConfigTypeDef(TypedDict):
    Alignment: AlignmentType,  # (1)
    Header: str,
    TextColor: str,

1. See AlignmentType

JourneyChannelSettingsTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import JourneyChannelSettingsTypeDef

def get_value() -> JourneyChannelSettingsTypeDef:
    return {
        "ConnectCampaignArn": ...,
    }

Definition

class JourneyChannelSettingsTypeDef(TypedDict):
    ConnectCampaignArn: NotRequired[str],
    ConnectCampaignExecutionRoleArn: NotRequired[str],

JourneyLimitsTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import JourneyLimitsTypeDef

def get_value() -> JourneyLimitsTypeDef:
    return {
        "DailyCap": ...,
    }

Definition

class JourneyLimitsTypeDef(TypedDict):
    DailyCap: NotRequired[int],
    EndpointReentryCap: NotRequired[int],
    MessagesPerSecond: NotRequired[int],
    EndpointReentryInterval: NotRequired[str],

JourneyPushMessageTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import JourneyPushMessageTypeDef

def get_value() -> JourneyPushMessageTypeDef:
    return {
        "TimeToLive": ...,
    }

Definition

class JourneyPushMessageTypeDef(TypedDict):
    TimeToLive: NotRequired[str],

JourneyScheduleTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import JourneyScheduleTypeDef

def get_value() -> JourneyScheduleTypeDef:
    return {
        "EndTime": ...,
    }

Definition

class JourneyScheduleTypeDef(TypedDict):
    EndTime: NotRequired[Union[datetime, str]],
    StartTime: NotRequired[Union[datetime, str]],
    Timezone: NotRequired[str],

JourneySMSMessageTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import JourneySMSMessageTypeDef

def get_value() -> JourneySMSMessageTypeDef:
    return {
        "MessageType": ...,
    }

Definition

class JourneySMSMessageTypeDef(TypedDict):
    MessageType: NotRequired[MessageTypeType],  # (1)
    OriginationNumber: NotRequired[str],
    SenderId: NotRequired[str],
    EntityId: NotRequired[str],
    TemplateId: NotRequired[str],

1. See MessageTypeType

JourneyStateRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import JourneyStateRequestTypeDef

def get_value() -> JourneyStateRequestTypeDef:
    return {
        "State": ...,
    }

Definition

class JourneyStateRequestTypeDef(TypedDict):
    State: NotRequired[StateType],  # (1)

1. See StateType

ListJourneysRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import ListJourneysRequestRequestTypeDef

def get_value() -> ListJourneysRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
    }

Definition

class ListJourneysRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    PageSize: NotRequired[str],
    Token: NotRequired[str],

ListTagsForResourceRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import ListTagsForResourceRequestRequestTypeDef

def get_value() -> ListTagsForResourceRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
    }

Definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

TagsModelTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import TagsModelTypeDef

def get_value() -> TagsModelTypeDef:
    return {
        "tags": ...,
    }

Definition

class TagsModelTypeDef(TypedDict):
    tags: Dict[str, str],

ListTemplateVersionsRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import ListTemplateVersionsRequestRequestTypeDef

def get_value() -> ListTemplateVersionsRequestRequestTypeDef:
    return {
        "TemplateName": ...,
        "TemplateType": ...,
    }

Definition

class ListTemplateVersionsRequestRequestTypeDef(TypedDict):
    TemplateName: str,
    TemplateType: str,
    NextToken: NotRequired[str],
    PageSize: NotRequired[str],

ListTemplatesRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import ListTemplatesRequestRequestTypeDef

def get_value() -> ListTemplatesRequestRequestTypeDef:
    return {
        "NextToken": ...,
    }

Definition

class ListTemplatesRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    PageSize: NotRequired[str],
    Prefix: NotRequired[str],
    TemplateType: NotRequired[str],

MessageTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import MessageTypeDef

def get_value() -> MessageTypeDef:
    return {
        "Action": ...,
    }

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],

1. See ActionType

MessageResultTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import MessageResultTypeDef

def get_value() -> MessageResultTypeDef:
    return {
        "DeliveryStatus": ...,
        "StatusCode": ...,
    }

Definition

class MessageResultTypeDef(TypedDict):
    DeliveryStatus: DeliveryStatusType,  # (1)
    StatusCode: int,
    MessageId: NotRequired[str],
    StatusMessage: NotRequired[str],
    UpdatedToken: NotRequired[str],

1. See DeliveryStatusType

NumberValidateRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import NumberValidateRequestTypeDef

def get_value() -> NumberValidateRequestTypeDef:
    return {
        "IsoCountryCode": ...,
    }

Definition

class NumberValidateRequestTypeDef(TypedDict):
    IsoCountryCode: NotRequired[str],
    PhoneNumber: NotRequired[str],

NumberValidateResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import NumberValidateResponseTypeDef

def get_value() -> NumberValidateResponseTypeDef:
    return {
        "Carrier": ...,
    }

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

Usage Example

from mypy_boto3_pinpoint.type_defs import OpenHoursRuleTypeDef

def get_value() -> OpenHoursRuleTypeDef:
    return {
        "StartTime": ...,
    }

Definition

class OpenHoursRuleTypeDef(TypedDict):
    StartTime: NotRequired[str],
    EndTime: NotRequired[str],

WriteEventStreamTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import WriteEventStreamTypeDef

def get_value() -> WriteEventStreamTypeDef:
    return {
        "DestinationStreamArn": ...,
        "RoleArn": ...,
    }

Definition

class WriteEventStreamTypeDef(TypedDict):
    DestinationStreamArn: str,
    RoleArn: str,

RandomSplitEntryTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import RandomSplitEntryTypeDef

def get_value() -> RandomSplitEntryTypeDef:
    return {
        "NextActivity": ...,
    }

Definition

class RandomSplitEntryTypeDef(TypedDict):
    NextActivity: NotRequired[str],
    Percentage: NotRequired[int],

RecencyDimensionTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import RecencyDimensionTypeDef

def get_value() -> RecencyDimensionTypeDef:
    return {
        "Duration": ...,
        "RecencyType": ...,
    }

Definition

class RecencyDimensionTypeDef(TypedDict):
    Duration: DurationType,  # (1)
    RecencyType: RecencyTypeType,  # (2)

1. See DurationType
2. See RecencyTypeType

UpdateAttributesRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateAttributesRequestTypeDef

def get_value() -> UpdateAttributesRequestTypeDef:
    return {
        "Blacklist": ...,
    }

Definition

class UpdateAttributesRequestTypeDef(TypedDict):
    Blacklist: NotRequired[Sequence[str]],

ResultRowValueTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import ResultRowValueTypeDef

def get_value() -> ResultRowValueTypeDef:
    return {
        "Key": ...,
        "Type": ...,
        "Value": ...,
    }

Definition

class ResultRowValueTypeDef(TypedDict):
    Key: str,
    Type: str,
    Value: str,

SMSChannelRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import SMSChannelRequestTypeDef

def get_value() -> SMSChannelRequestTypeDef:
    return {
        "Enabled": ...,
    }

Definition

class SMSChannelRequestTypeDef(TypedDict):
    Enabled: NotRequired[bool],
    SenderId: NotRequired[str],
    ShortCode: NotRequired[str],

SegmentConditionTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import SegmentConditionTypeDef

def get_value() -> SegmentConditionTypeDef:
    return {
        "SegmentId": ...,
    }

Definition

class SegmentConditionTypeDef(TypedDict):
    SegmentId: str,

SegmentReferenceTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import SegmentReferenceTypeDef

def get_value() -> SegmentReferenceTypeDef:
    return {
        "Id": ...,
    }

Definition

class SegmentReferenceTypeDef(TypedDict):
    Id: str,
    Version: NotRequired[int],

SegmentImportResourceTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import SegmentImportResourceTypeDef

def get_value() -> SegmentImportResourceTypeDef:
    return {
        "ExternalId": ...,
        "Format": ...,
        "RoleArn": ...,
        "S3Url": ...,
        "Size": ...,
    }

Definition

class SegmentImportResourceTypeDef(TypedDict):
    ExternalId: str,
    Format: FormatType,  # (1)
    RoleArn: str,
    S3Url: str,
    Size: int,
    ChannelCounts: NotRequired[Dict[str, int]],

1. See FormatType

SendOTPMessageRequestParametersTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import SendOTPMessageRequestParametersTypeDef

def get_value() -> SendOTPMessageRequestParametersTypeDef:
    return {
        "BrandName": ...,
        "Channel": ...,
        "DestinationIdentity": ...,
        "OriginationIdentity": ...,
        "ReferenceId": ...,
    }

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

Usage Example

from mypy_boto3_pinpoint.type_defs import SimpleEmailPartTypeDef

def get_value() -> SimpleEmailPartTypeDef:
    return {
        "Charset": ...,
    }

Definition

class SimpleEmailPartTypeDef(TypedDict):
    Charset: NotRequired[str],
    Data: NotRequired[str],

TemplateActiveVersionRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import TemplateActiveVersionRequestTypeDef

def get_value() -> TemplateActiveVersionRequestTypeDef:
    return {
        "Version": ...,
    }

Definition

class TemplateActiveVersionRequestTypeDef(TypedDict):
    Version: NotRequired[str],

TemplateTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import TemplateTypeDef

def get_value() -> TemplateTypeDef:
    return {
        "Name": ...,
    }

Definition

class TemplateTypeDef(TypedDict):
    Name: NotRequired[str],
    Version: NotRequired[str],

TemplateResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import TemplateResponseTypeDef

def get_value() -> TemplateResponseTypeDef:
    return {
        "CreationDate": ...,
        "LastModifiedDate": ...,
        "TemplateName": ...,
        "TemplateType": ...,
    }

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],

1. See TemplateTypeType

TemplateVersionResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import TemplateVersionResponseTypeDef

def get_value() -> TemplateVersionResponseTypeDef:
    return {
        "CreationDate": ...,
        "LastModifiedDate": ...,
        "TemplateName": ...,
        "TemplateType": ...,
    }

Definition

class TemplateVersionResponseTypeDef(TypedDict):
    CreationDate: str,
    LastModifiedDate: str,
    TemplateName: str,
    TemplateType: str,
    DefaultSubstitutions: NotRequired[str],
    TemplateDescription: NotRequired[str],
    Version: NotRequired[str],

UntagResourceRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UntagResourceRequestRequestTypeDef

def get_value() -> UntagResourceRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
        "TagKeys": ...,
    }

Definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    TagKeys: Sequence[str],

UpdateRecommenderConfigurationTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateRecommenderConfigurationTypeDef

def get_value() -> UpdateRecommenderConfigurationTypeDef:
    return {
        "RecommendationProviderRoleArn": ...,
        "RecommendationProviderUri": ...,
    }

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

Usage Example

from mypy_boto3_pinpoint.type_defs import VoiceChannelRequestTypeDef

def get_value() -> VoiceChannelRequestTypeDef:
    return {
        "Enabled": ...,
    }

Definition

class VoiceChannelRequestTypeDef(TypedDict):
    Enabled: NotRequired[bool],

VerificationResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import VerificationResponseTypeDef

def get_value() -> VerificationResponseTypeDef:
    return {
        "Valid": ...,
    }

Definition

class VerificationResponseTypeDef(TypedDict):
    Valid: NotRequired[bool],

VerifyOTPMessageRequestParametersTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import VerifyOTPMessageRequestParametersTypeDef

def get_value() -> VerifyOTPMessageRequestParametersTypeDef:
    return {
        "DestinationIdentity": ...,
        "Otp": ...,
        "ReferenceId": ...,
    }

Definition

class VerifyOTPMessageRequestParametersTypeDef(TypedDict):
    DestinationIdentity: str,
    Otp: str,
    ReferenceId: str,

UpdateAdmChannelRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateAdmChannelRequestRequestTypeDef

def get_value() -> UpdateAdmChannelRequestRequestTypeDef:
    return {
        "ADMChannelRequest": ...,
        "ApplicationId": ...,
    }

Definition

class UpdateAdmChannelRequestRequestTypeDef(TypedDict):
    ADMChannelRequest: ADMChannelRequestTypeDef,  # (1)
    ApplicationId: str,

1. See ADMChannelRequestTypeDef

UpdateApnsChannelRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateApnsChannelRequestRequestTypeDef

def get_value() -> UpdateApnsChannelRequestRequestTypeDef:
    return {
        "APNSChannelRequest": ...,
        "ApplicationId": ...,
    }

Definition

class UpdateApnsChannelRequestRequestTypeDef(TypedDict):
    APNSChannelRequest: APNSChannelRequestTypeDef,  # (1)
    ApplicationId: str,

1. See APNSChannelRequestTypeDef

UpdateApnsSandboxChannelRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateApnsSandboxChannelRequestRequestTypeDef

def get_value() -> UpdateApnsSandboxChannelRequestRequestTypeDef:
    return {
        "APNSSandboxChannelRequest": ...,
        "ApplicationId": ...,
    }

Definition

class UpdateApnsSandboxChannelRequestRequestTypeDef(TypedDict):
    APNSSandboxChannelRequest: APNSSandboxChannelRequestTypeDef,  # (1)
    ApplicationId: str,

1. See APNSSandboxChannelRequestTypeDef

UpdateApnsVoipChannelRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateApnsVoipChannelRequestRequestTypeDef

def get_value() -> UpdateApnsVoipChannelRequestRequestTypeDef:
    return {
        "APNSVoipChannelRequest": ...,
        "ApplicationId": ...,
    }

Definition

class UpdateApnsVoipChannelRequestRequestTypeDef(TypedDict):
    APNSVoipChannelRequest: APNSVoipChannelRequestTypeDef,  # (1)
    ApplicationId: str,

1. See APNSVoipChannelRequestTypeDef

UpdateApnsVoipSandboxChannelRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateApnsVoipSandboxChannelRequestRequestTypeDef

def get_value() -> UpdateApnsVoipSandboxChannelRequestRequestTypeDef:
    return {
        "APNSVoipSandboxChannelRequest": ...,
        "ApplicationId": ...,
    }

Definition

class UpdateApnsVoipSandboxChannelRequestRequestTypeDef(TypedDict):
    APNSVoipSandboxChannelRequest: APNSVoipSandboxChannelRequestTypeDef,  # (1)
    ApplicationId: str,

1. See APNSVoipSandboxChannelRequestTypeDef

ActivitiesResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import ActivitiesResponseTypeDef

def get_value() -> ActivitiesResponseTypeDef:
    return {
        "Item": ...,
    }

Definition

class ActivitiesResponseTypeDef(TypedDict):
    Item: List[ActivityResponseTypeDef],  # (1)
    NextToken: NotRequired[str],

1. See ActivityResponseTypeDef

ApplicationsResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import ApplicationsResponseTypeDef

def get_value() -> ApplicationsResponseTypeDef:
    return {
        "Item": ...,
    }

Definition

class ApplicationsResponseTypeDef(TypedDict):
    Item: NotRequired[List[ApplicationResponseTypeDef]],  # (1)
    NextToken: NotRequired[str],

1. See ApplicationResponseTypeDef

ApplicationSettingsResourceTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import ApplicationSettingsResourceTypeDef

def get_value() -> ApplicationSettingsResourceTypeDef:
    return {
        "ApplicationId": ...,
    }

Definition

class ApplicationSettingsResourceTypeDef(TypedDict):
    ApplicationId: str,
    CampaignHook: NotRequired[CampaignHookTypeDef],  # (1)
    LastModifiedDate: NotRequired[str],
    Limits: NotRequired[CampaignLimitsTypeDef],  # (2)
    QuietTime: NotRequired[QuietTimeTypeDef],  # (3)

1. See CampaignHookTypeDef
2. See CampaignLimitsTypeDef
3. See QuietTimeTypeDef

WriteApplicationSettingsRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import WriteApplicationSettingsRequestTypeDef

def get_value() -> WriteApplicationSettingsRequestTypeDef:
    return {
        "CampaignHook": ...,
    }

Definition

class WriteApplicationSettingsRequestTypeDef(TypedDict):
    CampaignHook: NotRequired[CampaignHookTypeDef],  # (1)
    CloudWatchMetricsEnabled: NotRequired[bool],
    EventTaggingEnabled: NotRequired[bool],
    Limits: NotRequired[CampaignLimitsTypeDef],  # (2)
    QuietTime: NotRequired[QuietTimeTypeDef],  # (3)

1. See CampaignHookTypeDef
2. See CampaignLimitsTypeDef
3. See QuietTimeTypeDef

UpdateBaiduChannelRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateBaiduChannelRequestRequestTypeDef

def get_value() -> UpdateBaiduChannelRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "BaiduChannelRequest": ...,
    }

Definition

class UpdateBaiduChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    BaiduChannelRequest: BaiduChannelRequestTypeDef,  # (1)

1. See BaiduChannelRequestTypeDef

ChannelsResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import ChannelsResponseTypeDef

def get_value() -> ChannelsResponseTypeDef:
    return {
        "Channels": ...,
    }

Definition

class ChannelsResponseTypeDef(TypedDict):
    Channels: Dict[str, ChannelResponseTypeDef],  # (1)

1. See ChannelResponseTypeDef

ClosedDaysTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import ClosedDaysTypeDef

def get_value() -> ClosedDaysTypeDef:
    return {
        "EMAIL": ...,
    }

Definition

class ClosedDaysTypeDef(TypedDict):
    EMAIL: NotRequired[Sequence[ClosedDaysRuleTypeDef]],  # (1)
    SMS: NotRequired[Sequence[ClosedDaysRuleTypeDef]],  # (1)
    PUSH: NotRequired[Sequence[ClosedDaysRuleTypeDef]],  # (1)
    VOICE: NotRequired[Sequence[ClosedDaysRuleTypeDef]],  # (1)
    CUSTOM: NotRequired[Sequence[ClosedDaysRuleTypeDef]],  # (1)

1. See ClosedDaysRuleTypeDef
2. See ClosedDaysRuleTypeDef
3. See ClosedDaysRuleTypeDef
4. See ClosedDaysRuleTypeDef
5. See ClosedDaysRuleTypeDef

WaitActivityTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import WaitActivityTypeDef

def get_value() -> WaitActivityTypeDef:
    return {
        "NextActivity": ...,
    }

Definition

class WaitActivityTypeDef(TypedDict):
    NextActivity: NotRequired[str],
    WaitTime: NotRequired[WaitTimeTypeDef],  # (1)

1. See WaitTimeTypeDef

CreateAppRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import CreateAppRequestRequestTypeDef

def get_value() -> CreateAppRequestRequestTypeDef:
    return {
        "CreateApplicationRequest": ...,
    }

Definition

class CreateAppRequestRequestTypeDef(TypedDict):
    CreateApplicationRequest: CreateApplicationRequestTypeDef,  # (1)

1. See CreateApplicationRequestTypeDef

CreateAppResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import CreateAppResponseTypeDef

def get_value() -> CreateAppResponseTypeDef:
    return {
        "ApplicationResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class CreateAppResponseTypeDef(TypedDict):
    ApplicationResponse: ApplicationResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ApplicationResponseTypeDef
2. See ResponseMetadataTypeDef

DeleteAdmChannelResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import DeleteAdmChannelResponseTypeDef

def get_value() -> DeleteAdmChannelResponseTypeDef:
    return {
        "ADMChannelResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class DeleteAdmChannelResponseTypeDef(TypedDict):
    ADMChannelResponse: ADMChannelResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ADMChannelResponseTypeDef
2. See ResponseMetadataTypeDef

DeleteApnsChannelResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import DeleteApnsChannelResponseTypeDef

def get_value() -> DeleteApnsChannelResponseTypeDef:
    return {
        "APNSChannelResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class DeleteApnsChannelResponseTypeDef(TypedDict):
    APNSChannelResponse: APNSChannelResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See APNSChannelResponseTypeDef
2. See ResponseMetadataTypeDef

DeleteApnsSandboxChannelResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import DeleteApnsSandboxChannelResponseTypeDef

def get_value() -> DeleteApnsSandboxChannelResponseTypeDef:
    return {
        "APNSSandboxChannelResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class DeleteApnsSandboxChannelResponseTypeDef(TypedDict):
    APNSSandboxChannelResponse: APNSSandboxChannelResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See APNSSandboxChannelResponseTypeDef
2. See ResponseMetadataTypeDef

DeleteApnsVoipChannelResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import DeleteApnsVoipChannelResponseTypeDef

def get_value() -> DeleteApnsVoipChannelResponseTypeDef:
    return {
        "APNSVoipChannelResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class DeleteApnsVoipChannelResponseTypeDef(TypedDict):
    APNSVoipChannelResponse: APNSVoipChannelResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See APNSVoipChannelResponseTypeDef
2. See ResponseMetadataTypeDef

DeleteApnsVoipSandboxChannelResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import DeleteApnsVoipSandboxChannelResponseTypeDef

def get_value() -> DeleteApnsVoipSandboxChannelResponseTypeDef:
    return {
        "APNSVoipSandboxChannelResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class DeleteApnsVoipSandboxChannelResponseTypeDef(TypedDict):
    APNSVoipSandboxChannelResponse: APNSVoipSandboxChannelResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See APNSVoipSandboxChannelResponseTypeDef
2. See ResponseMetadataTypeDef

DeleteAppResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import DeleteAppResponseTypeDef

def get_value() -> DeleteAppResponseTypeDef:
    return {
        "ApplicationResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class DeleteAppResponseTypeDef(TypedDict):
    ApplicationResponse: ApplicationResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ApplicationResponseTypeDef
2. See ResponseMetadataTypeDef

DeleteBaiduChannelResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import DeleteBaiduChannelResponseTypeDef

def get_value() -> DeleteBaiduChannelResponseTypeDef:
    return {
        "BaiduChannelResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class DeleteBaiduChannelResponseTypeDef(TypedDict):
    BaiduChannelResponse: BaiduChannelResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See BaiduChannelResponseTypeDef
2. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import EmptyResponseMetadataTypeDef

def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }

Definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

GetAdmChannelResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetAdmChannelResponseTypeDef

def get_value() -> GetAdmChannelResponseTypeDef:
    return {
        "ADMChannelResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetAdmChannelResponseTypeDef(TypedDict):
    ADMChannelResponse: ADMChannelResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ADMChannelResponseTypeDef
2. See ResponseMetadataTypeDef

GetApnsChannelResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetApnsChannelResponseTypeDef

def get_value() -> GetApnsChannelResponseTypeDef:
    return {
        "APNSChannelResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetApnsChannelResponseTypeDef(TypedDict):
    APNSChannelResponse: APNSChannelResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See APNSChannelResponseTypeDef
2. See ResponseMetadataTypeDef

GetApnsSandboxChannelResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetApnsSandboxChannelResponseTypeDef

def get_value() -> GetApnsSandboxChannelResponseTypeDef:
    return {
        "APNSSandboxChannelResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetApnsSandboxChannelResponseTypeDef(TypedDict):
    APNSSandboxChannelResponse: APNSSandboxChannelResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See APNSSandboxChannelResponseTypeDef
2. See ResponseMetadataTypeDef

GetApnsVoipChannelResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetApnsVoipChannelResponseTypeDef

def get_value() -> GetApnsVoipChannelResponseTypeDef:
    return {
        "APNSVoipChannelResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetApnsVoipChannelResponseTypeDef(TypedDict):
    APNSVoipChannelResponse: APNSVoipChannelResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See APNSVoipChannelResponseTypeDef
2. See ResponseMetadataTypeDef

GetApnsVoipSandboxChannelResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetApnsVoipSandboxChannelResponseTypeDef

def get_value() -> GetApnsVoipSandboxChannelResponseTypeDef:
    return {
        "APNSVoipSandboxChannelResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetApnsVoipSandboxChannelResponseTypeDef(TypedDict):
    APNSVoipSandboxChannelResponse: APNSVoipSandboxChannelResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See APNSVoipSandboxChannelResponseTypeDef
2. See ResponseMetadataTypeDef

GetAppResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetAppResponseTypeDef

def get_value() -> GetAppResponseTypeDef:
    return {
        "ApplicationResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetAppResponseTypeDef(TypedDict):
    ApplicationResponse: ApplicationResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ApplicationResponseTypeDef
2. See ResponseMetadataTypeDef

GetBaiduChannelResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetBaiduChannelResponseTypeDef

def get_value() -> GetBaiduChannelResponseTypeDef:
    return {
        "BaiduChannelResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetBaiduChannelResponseTypeDef(TypedDict):
    BaiduChannelResponse: BaiduChannelResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See BaiduChannelResponseTypeDef
2. See ResponseMetadataTypeDef

RemoveAttributesResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import RemoveAttributesResponseTypeDef

def get_value() -> RemoveAttributesResponseTypeDef:
    return {
        "AttributesResource": ...,
        "ResponseMetadata": ...,
    }

Definition

class RemoveAttributesResponseTypeDef(TypedDict):
    AttributesResource: AttributesResourceTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See AttributesResourceTypeDef
2. See ResponseMetadataTypeDef

UpdateAdmChannelResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateAdmChannelResponseTypeDef

def get_value() -> UpdateAdmChannelResponseTypeDef:
    return {
        "ADMChannelResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class UpdateAdmChannelResponseTypeDef(TypedDict):
    ADMChannelResponse: ADMChannelResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ADMChannelResponseTypeDef
2. See ResponseMetadataTypeDef

UpdateApnsChannelResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateApnsChannelResponseTypeDef

def get_value() -> UpdateApnsChannelResponseTypeDef:
    return {
        "APNSChannelResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class UpdateApnsChannelResponseTypeDef(TypedDict):
    APNSChannelResponse: APNSChannelResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See APNSChannelResponseTypeDef
2. See ResponseMetadataTypeDef

UpdateApnsSandboxChannelResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateApnsSandboxChannelResponseTypeDef

def get_value() -> UpdateApnsSandboxChannelResponseTypeDef:
    return {
        "APNSSandboxChannelResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class UpdateApnsSandboxChannelResponseTypeDef(TypedDict):
    APNSSandboxChannelResponse: APNSSandboxChannelResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See APNSSandboxChannelResponseTypeDef
2. See ResponseMetadataTypeDef

UpdateApnsVoipChannelResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateApnsVoipChannelResponseTypeDef

def get_value() -> UpdateApnsVoipChannelResponseTypeDef:
    return {
        "APNSVoipChannelResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class UpdateApnsVoipChannelResponseTypeDef(TypedDict):
    APNSVoipChannelResponse: APNSVoipChannelResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See APNSVoipChannelResponseTypeDef
2. See ResponseMetadataTypeDef

UpdateApnsVoipSandboxChannelResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateApnsVoipSandboxChannelResponseTypeDef

def get_value() -> UpdateApnsVoipSandboxChannelResponseTypeDef:
    return {
        "APNSVoipSandboxChannelResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class UpdateApnsVoipSandboxChannelResponseTypeDef(TypedDict):
    APNSVoipSandboxChannelResponse: APNSVoipSandboxChannelResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See APNSVoipSandboxChannelResponseTypeDef
2. See ResponseMetadataTypeDef

UpdateBaiduChannelResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateBaiduChannelResponseTypeDef

def get_value() -> UpdateBaiduChannelResponseTypeDef:
    return {
        "BaiduChannelResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class UpdateBaiduChannelResponseTypeDef(TypedDict):
    BaiduChannelResponse: BaiduChannelResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See BaiduChannelResponseTypeDef
2. See ResponseMetadataTypeDef

CreateEmailTemplateRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import CreateEmailTemplateRequestRequestTypeDef

def get_value() -> CreateEmailTemplateRequestRequestTypeDef:
    return {
        "EmailTemplateRequest": ...,
        "TemplateName": ...,
    }

Definition

class CreateEmailTemplateRequestRequestTypeDef(TypedDict):
    EmailTemplateRequest: EmailTemplateRequestTypeDef,  # (1)
    TemplateName: str,

1. See EmailTemplateRequestTypeDef

UpdateEmailTemplateRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateEmailTemplateRequestRequestTypeDef

def get_value() -> UpdateEmailTemplateRequestRequestTypeDef:
    return {
        "EmailTemplateRequest": ...,
        "TemplateName": ...,
    }

Definition

class UpdateEmailTemplateRequestRequestTypeDef(TypedDict):
    EmailTemplateRequest: EmailTemplateRequestTypeDef,  # (1)
    TemplateName: str,
    CreateNewVersion: NotRequired[bool],
    Version: NotRequired[str],

1. See EmailTemplateRequestTypeDef

CreateEmailTemplateResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import CreateEmailTemplateResponseTypeDef

def get_value() -> CreateEmailTemplateResponseTypeDef:
    return {
        "CreateTemplateMessageBody": ...,
        "ResponseMetadata": ...,
    }

Definition

class CreateEmailTemplateResponseTypeDef(TypedDict):
    CreateTemplateMessageBody: CreateTemplateMessageBodyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See CreateTemplateMessageBodyTypeDef
2. See ResponseMetadataTypeDef

CreatePushTemplateResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import CreatePushTemplateResponseTypeDef

def get_value() -> CreatePushTemplateResponseTypeDef:
    return {
        "CreateTemplateMessageBody": ...,
        "ResponseMetadata": ...,
    }

Definition

class CreatePushTemplateResponseTypeDef(TypedDict):
    CreateTemplateMessageBody: CreateTemplateMessageBodyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See CreateTemplateMessageBodyTypeDef
2. See ResponseMetadataTypeDef

CreateSmsTemplateResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import CreateSmsTemplateResponseTypeDef

def get_value() -> CreateSmsTemplateResponseTypeDef:
    return {
        "CreateTemplateMessageBody": ...,
        "ResponseMetadata": ...,
    }

Definition

class CreateSmsTemplateResponseTypeDef(TypedDict):
    CreateTemplateMessageBody: CreateTemplateMessageBodyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See CreateTemplateMessageBodyTypeDef
2. See ResponseMetadataTypeDef

CreateVoiceTemplateResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import CreateVoiceTemplateResponseTypeDef

def get_value() -> CreateVoiceTemplateResponseTypeDef:
    return {
        "CreateTemplateMessageBody": ...,
        "ResponseMetadata": ...,
    }

Definition

class CreateVoiceTemplateResponseTypeDef(TypedDict):
    CreateTemplateMessageBody: CreateTemplateMessageBodyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See CreateTemplateMessageBodyTypeDef
2. See ResponseMetadataTypeDef

CreateExportJobRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import CreateExportJobRequestRequestTypeDef

def get_value() -> CreateExportJobRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "ExportJobRequest": ...,
    }

Definition

class CreateExportJobRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    ExportJobRequest: ExportJobRequestTypeDef,  # (1)

1. See ExportJobRequestTypeDef

CreateImportJobRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import CreateImportJobRequestRequestTypeDef

def get_value() -> CreateImportJobRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "ImportJobRequest": ...,
    }

Definition

class CreateImportJobRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    ImportJobRequest: ImportJobRequestTypeDef,  # (1)

1. See ImportJobRequestTypeDef

CreateInAppTemplateResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import CreateInAppTemplateResponseTypeDef

def get_value() -> CreateInAppTemplateResponseTypeDef:
    return {
        "TemplateCreateMessageBody": ...,
        "ResponseMetadata": ...,
    }

Definition

class CreateInAppTemplateResponseTypeDef(TypedDict):
    TemplateCreateMessageBody: TemplateCreateMessageBodyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See TemplateCreateMessageBodyTypeDef
2. See ResponseMetadataTypeDef

CreateRecommenderConfigurationRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import CreateRecommenderConfigurationRequestRequestTypeDef

def get_value() -> CreateRecommenderConfigurationRequestRequestTypeDef:
    return {
        "CreateRecommenderConfiguration": ...,
    }

Definition

class CreateRecommenderConfigurationRequestRequestTypeDef(TypedDict):
    CreateRecommenderConfiguration: CreateRecommenderConfigurationTypeDef,  # (1)

1. See CreateRecommenderConfigurationTypeDef

CreateRecommenderConfigurationResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import CreateRecommenderConfigurationResponseTypeDef

def get_value() -> CreateRecommenderConfigurationResponseTypeDef:
    return {
        "RecommenderConfigurationResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class CreateRecommenderConfigurationResponseTypeDef(TypedDict):
    RecommenderConfigurationResponse: RecommenderConfigurationResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See RecommenderConfigurationResponseTypeDef
2. See ResponseMetadataTypeDef

DeleteRecommenderConfigurationResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import DeleteRecommenderConfigurationResponseTypeDef

def get_value() -> DeleteRecommenderConfigurationResponseTypeDef:
    return {
        "RecommenderConfigurationResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class DeleteRecommenderConfigurationResponseTypeDef(TypedDict):
    RecommenderConfigurationResponse: RecommenderConfigurationResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See RecommenderConfigurationResponseTypeDef
2. See ResponseMetadataTypeDef

GetRecommenderConfigurationResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetRecommenderConfigurationResponseTypeDef

def get_value() -> GetRecommenderConfigurationResponseTypeDef:
    return {
        "RecommenderConfigurationResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetRecommenderConfigurationResponseTypeDef(TypedDict):
    RecommenderConfigurationResponse: RecommenderConfigurationResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See RecommenderConfigurationResponseTypeDef
2. See ResponseMetadataTypeDef

ListRecommenderConfigurationsResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import ListRecommenderConfigurationsResponseTypeDef

def get_value() -> ListRecommenderConfigurationsResponseTypeDef:
    return {
        "Item": ...,
    }

Definition

class ListRecommenderConfigurationsResponseTypeDef(TypedDict):
    Item: List[RecommenderConfigurationResponseTypeDef],  # (1)
    NextToken: NotRequired[str],

1. See RecommenderConfigurationResponseTypeDef

UpdateRecommenderConfigurationResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateRecommenderConfigurationResponseTypeDef

def get_value() -> UpdateRecommenderConfigurationResponseTypeDef:
    return {
        "RecommenderConfigurationResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class UpdateRecommenderConfigurationResponseTypeDef(TypedDict):
    RecommenderConfigurationResponse: RecommenderConfigurationResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See RecommenderConfigurationResponseTypeDef
2. See ResponseMetadataTypeDef

CreateSmsTemplateRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import CreateSmsTemplateRequestRequestTypeDef

def get_value() -> CreateSmsTemplateRequestRequestTypeDef:
    return {
        "SMSTemplateRequest": ...,
        "TemplateName": ...,
    }

Definition

class CreateSmsTemplateRequestRequestTypeDef(TypedDict):
    SMSTemplateRequest: SMSTemplateRequestTypeDef,  # (1)
    TemplateName: str,

1. See SMSTemplateRequestTypeDef

UpdateSmsTemplateRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateSmsTemplateRequestRequestTypeDef

def get_value() -> UpdateSmsTemplateRequestRequestTypeDef:
    return {
        "SMSTemplateRequest": ...,
        "TemplateName": ...,
    }

Definition

class UpdateSmsTemplateRequestRequestTypeDef(TypedDict):
    SMSTemplateRequest: SMSTemplateRequestTypeDef,  # (1)
    TemplateName: str,
    CreateNewVersion: NotRequired[bool],
    Version: NotRequired[str],

1. See SMSTemplateRequestTypeDef

CreateVoiceTemplateRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import CreateVoiceTemplateRequestRequestTypeDef

def get_value() -> CreateVoiceTemplateRequestRequestTypeDef:
    return {
        "TemplateName": ...,
        "VoiceTemplateRequest": ...,
    }

Definition

class CreateVoiceTemplateRequestRequestTypeDef(TypedDict):
    TemplateName: str,
    VoiceTemplateRequest: VoiceTemplateRequestTypeDef,  # (1)

1. See VoiceTemplateRequestTypeDef

UpdateVoiceTemplateRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateVoiceTemplateRequestRequestTypeDef

def get_value() -> UpdateVoiceTemplateRequestRequestTypeDef:
    return {
        "TemplateName": ...,
        "VoiceTemplateRequest": ...,
    }

Definition

class UpdateVoiceTemplateRequestRequestTypeDef(TypedDict):
    TemplateName: str,
    VoiceTemplateRequest: VoiceTemplateRequestTypeDef,  # (1)
    CreateNewVersion: NotRequired[bool],
    Version: NotRequired[str],

1. See VoiceTemplateRequestTypeDef

CustomMessageActivityTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import CustomMessageActivityTypeDef

def get_value() -> CustomMessageActivityTypeDef:
    return {
        "DeliveryUri": ...,
    }

Definition

class CustomMessageActivityTypeDef(TypedDict):
    DeliveryUri: NotRequired[str],
    EndpointTypes: NotRequired[Sequence[EndpointTypesElementType]],  # (1)
    MessageConfig: NotRequired[JourneyCustomMessageTypeDef],  # (2)
    NextActivity: NotRequired[str],
    TemplateName: NotRequired[str],
    TemplateVersion: NotRequired[str],

1. See EndpointTypesElementType
2. See JourneyCustomMessageTypeDef

PushNotificationTemplateRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import PushNotificationTemplateRequestTypeDef

def get_value() -> PushNotificationTemplateRequestTypeDef:
    return {
        "ADM": ...,
    }

Definition

class PushNotificationTemplateRequestTypeDef(TypedDict):
    ADM: NotRequired[AndroidPushNotificationTemplateTypeDef],  # (1)
    APNS: NotRequired[APNSPushNotificationTemplateTypeDef],  # (2)
    Baidu: NotRequired[AndroidPushNotificationTemplateTypeDef],  # (1)
    Default: NotRequired[DefaultPushNotificationTemplateTypeDef],  # (4)
    DefaultSubstitutions: NotRequired[str],
    GCM: NotRequired[AndroidPushNotificationTemplateTypeDef],  # (1)
    RecommenderId: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
    TemplateDescription: NotRequired[str],

1. See AndroidPushNotificationTemplateTypeDef
2. See APNSPushNotificationTemplateTypeDef
3. See AndroidPushNotificationTemplateTypeDef
4. See DefaultPushNotificationTemplateTypeDef
5. See AndroidPushNotificationTemplateTypeDef

PushNotificationTemplateResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import PushNotificationTemplateResponseTypeDef

def get_value() -> PushNotificationTemplateResponseTypeDef:
    return {
        "CreationDate": ...,
        "LastModifiedDate": ...,
        "TemplateName": ...,
        "TemplateType": ...,
    }

Definition

class PushNotificationTemplateResponseTypeDef(TypedDict):
    CreationDate: str,
    LastModifiedDate: str,
    TemplateName: str,
    TemplateType: TemplateTypeType,  # (6)
    ADM: NotRequired[AndroidPushNotificationTemplateTypeDef],  # (1)
    APNS: NotRequired[APNSPushNotificationTemplateTypeDef],  # (2)
    Arn: NotRequired[str],
    Baidu: NotRequired[AndroidPushNotificationTemplateTypeDef],  # (1)
    Default: NotRequired[DefaultPushNotificationTemplateTypeDef],  # (4)
    DefaultSubstitutions: NotRequired[str],
    GCM: NotRequired[AndroidPushNotificationTemplateTypeDef],  # (1)
    RecommenderId: NotRequired[str],
    tags: NotRequired[Dict[str, str]],
    TemplateDescription: NotRequired[str],
    Version: NotRequired[str],

1. See AndroidPushNotificationTemplateTypeDef
2. See APNSPushNotificationTemplateTypeDef
3. See AndroidPushNotificationTemplateTypeDef
4. See DefaultPushNotificationTemplateTypeDef
5. See AndroidPushNotificationTemplateTypeDef
6. See TemplateTypeType

DeleteEmailChannelResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import DeleteEmailChannelResponseTypeDef

def get_value() -> DeleteEmailChannelResponseTypeDef:
    return {
        "EmailChannelResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class DeleteEmailChannelResponseTypeDef(TypedDict):
    EmailChannelResponse: EmailChannelResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See EmailChannelResponseTypeDef
2. See ResponseMetadataTypeDef

GetEmailChannelResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetEmailChannelResponseTypeDef

def get_value() -> GetEmailChannelResponseTypeDef:
    return {
        "EmailChannelResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetEmailChannelResponseTypeDef(TypedDict):
    EmailChannelResponse: EmailChannelResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See EmailChannelResponseTypeDef
2. See ResponseMetadataTypeDef

UpdateEmailChannelResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateEmailChannelResponseTypeDef

def get_value() -> UpdateEmailChannelResponseTypeDef:
    return {
        "EmailChannelResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class UpdateEmailChannelResponseTypeDef(TypedDict):
    EmailChannelResponse: EmailChannelResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See EmailChannelResponseTypeDef
2. See ResponseMetadataTypeDef

DeleteEmailTemplateResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import DeleteEmailTemplateResponseTypeDef

def get_value() -> DeleteEmailTemplateResponseTypeDef:
    return {
        "MessageBody": ...,
        "ResponseMetadata": ...,
    }

Definition

class DeleteEmailTemplateResponseTypeDef(TypedDict):
    MessageBody: MessageBodyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See MessageBodyTypeDef
2. See ResponseMetadataTypeDef

DeleteInAppTemplateResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import DeleteInAppTemplateResponseTypeDef

def get_value() -> DeleteInAppTemplateResponseTypeDef:
    return {
        "MessageBody": ...,
        "ResponseMetadata": ...,
    }

Definition

class DeleteInAppTemplateResponseTypeDef(TypedDict):
    MessageBody: MessageBodyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See MessageBodyTypeDef
2. See ResponseMetadataTypeDef

DeletePushTemplateResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import DeletePushTemplateResponseTypeDef

def get_value() -> DeletePushTemplateResponseTypeDef:
    return {
        "MessageBody": ...,
        "ResponseMetadata": ...,
    }

Definition

class DeletePushTemplateResponseTypeDef(TypedDict):
    MessageBody: MessageBodyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See MessageBodyTypeDef
2. See ResponseMetadataTypeDef

DeleteSmsTemplateResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import DeleteSmsTemplateResponseTypeDef

def get_value() -> DeleteSmsTemplateResponseTypeDef:
    return {
        "MessageBody": ...,
        "ResponseMetadata": ...,
    }

Definition

class DeleteSmsTemplateResponseTypeDef(TypedDict):
    MessageBody: MessageBodyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See MessageBodyTypeDef
2. See ResponseMetadataTypeDef

DeleteVoiceTemplateResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import DeleteVoiceTemplateResponseTypeDef

def get_value() -> DeleteVoiceTemplateResponseTypeDef:
    return {
        "MessageBody": ...,
        "ResponseMetadata": ...,
    }

Definition

class DeleteVoiceTemplateResponseTypeDef(TypedDict):
    MessageBody: MessageBodyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See MessageBodyTypeDef
2. See ResponseMetadataTypeDef

UpdateEmailTemplateResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateEmailTemplateResponseTypeDef

def get_value() -> UpdateEmailTemplateResponseTypeDef:
    return {
        "MessageBody": ...,
        "ResponseMetadata": ...,
    }

Definition

class UpdateEmailTemplateResponseTypeDef(TypedDict):
    MessageBody: MessageBodyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See MessageBodyTypeDef
2. See ResponseMetadataTypeDef

UpdateEndpointResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateEndpointResponseTypeDef

def get_value() -> UpdateEndpointResponseTypeDef:
    return {
        "MessageBody": ...,
        "ResponseMetadata": ...,
    }

Definition

class UpdateEndpointResponseTypeDef(TypedDict):
    MessageBody: MessageBodyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See MessageBodyTypeDef
2. See ResponseMetadataTypeDef

UpdateEndpointsBatchResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateEndpointsBatchResponseTypeDef

def get_value() -> UpdateEndpointsBatchResponseTypeDef:
    return {
        "MessageBody": ...,
        "ResponseMetadata": ...,
    }

Definition

class UpdateEndpointsBatchResponseTypeDef(TypedDict):
    MessageBody: MessageBodyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See MessageBodyTypeDef
2. See ResponseMetadataTypeDef

UpdateInAppTemplateResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateInAppTemplateResponseTypeDef

def get_value() -> UpdateInAppTemplateResponseTypeDef:
    return {
        "MessageBody": ...,
        "ResponseMetadata": ...,
    }

Definition

class UpdateInAppTemplateResponseTypeDef(TypedDict):
    MessageBody: MessageBodyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See MessageBodyTypeDef
2. See ResponseMetadataTypeDef

UpdatePushTemplateResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdatePushTemplateResponseTypeDef

def get_value() -> UpdatePushTemplateResponseTypeDef:
    return {
        "MessageBody": ...,
        "ResponseMetadata": ...,
    }

Definition

class UpdatePushTemplateResponseTypeDef(TypedDict):
    MessageBody: MessageBodyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See MessageBodyTypeDef
2. See ResponseMetadataTypeDef

UpdateSmsTemplateResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateSmsTemplateResponseTypeDef

def get_value() -> UpdateSmsTemplateResponseTypeDef:
    return {
        "MessageBody": ...,
        "ResponseMetadata": ...,
    }

Definition

class UpdateSmsTemplateResponseTypeDef(TypedDict):
    MessageBody: MessageBodyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See MessageBodyTypeDef
2. See ResponseMetadataTypeDef

UpdateTemplateActiveVersionResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateTemplateActiveVersionResponseTypeDef

def get_value() -> UpdateTemplateActiveVersionResponseTypeDef:
    return {
        "MessageBody": ...,
        "ResponseMetadata": ...,
    }

Definition

class UpdateTemplateActiveVersionResponseTypeDef(TypedDict):
    MessageBody: MessageBodyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See MessageBodyTypeDef
2. See ResponseMetadataTypeDef

UpdateVoiceTemplateResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateVoiceTemplateResponseTypeDef

def get_value() -> UpdateVoiceTemplateResponseTypeDef:
    return {
        "MessageBody": ...,
        "ResponseMetadata": ...,
    }

Definition

class UpdateVoiceTemplateResponseTypeDef(TypedDict):
    MessageBody: MessageBodyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See MessageBodyTypeDef
2. See ResponseMetadataTypeDef

DeleteEventStreamResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import DeleteEventStreamResponseTypeDef

def get_value() -> DeleteEventStreamResponseTypeDef:
    return {
        "EventStream": ...,
        "ResponseMetadata": ...,
    }

Definition

class DeleteEventStreamResponseTypeDef(TypedDict):
    EventStream: EventStreamTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See EventStreamTypeDef
2. See ResponseMetadataTypeDef

GetEventStreamResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetEventStreamResponseTypeDef

def get_value() -> GetEventStreamResponseTypeDef:
    return {
        "EventStream": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetEventStreamResponseTypeDef(TypedDict):
    EventStream: EventStreamTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See EventStreamTypeDef
2. See ResponseMetadataTypeDef

PutEventStreamResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import PutEventStreamResponseTypeDef

def get_value() -> PutEventStreamResponseTypeDef:
    return {
        "EventStream": ...,
        "ResponseMetadata": ...,
    }

Definition

class PutEventStreamResponseTypeDef(TypedDict):
    EventStream: EventStreamTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See EventStreamTypeDef
2. See ResponseMetadataTypeDef

DeleteGcmChannelResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import DeleteGcmChannelResponseTypeDef

def get_value() -> DeleteGcmChannelResponseTypeDef:
    return {
        "GCMChannelResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class DeleteGcmChannelResponseTypeDef(TypedDict):
    GCMChannelResponse: GCMChannelResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See GCMChannelResponseTypeDef
2. See ResponseMetadataTypeDef

GetGcmChannelResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetGcmChannelResponseTypeDef

def get_value() -> GetGcmChannelResponseTypeDef:
    return {
        "GCMChannelResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetGcmChannelResponseTypeDef(TypedDict):
    GCMChannelResponse: GCMChannelResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See GCMChannelResponseTypeDef
2. See ResponseMetadataTypeDef

UpdateGcmChannelResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateGcmChannelResponseTypeDef

def get_value() -> UpdateGcmChannelResponseTypeDef:
    return {
        "GCMChannelResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class UpdateGcmChannelResponseTypeDef(TypedDict):
    GCMChannelResponse: GCMChannelResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See GCMChannelResponseTypeDef
2. See ResponseMetadataTypeDef

DeleteSmsChannelResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import DeleteSmsChannelResponseTypeDef

def get_value() -> DeleteSmsChannelResponseTypeDef:
    return {
        "SMSChannelResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class DeleteSmsChannelResponseTypeDef(TypedDict):
    SMSChannelResponse: SMSChannelResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See SMSChannelResponseTypeDef
2. See ResponseMetadataTypeDef

GetSmsChannelResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetSmsChannelResponseTypeDef

def get_value() -> GetSmsChannelResponseTypeDef:
    return {
        "SMSChannelResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetSmsChannelResponseTypeDef(TypedDict):
    SMSChannelResponse: SMSChannelResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See SMSChannelResponseTypeDef
2. See ResponseMetadataTypeDef

UpdateSmsChannelResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateSmsChannelResponseTypeDef

def get_value() -> UpdateSmsChannelResponseTypeDef:
    return {
        "SMSChannelResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class UpdateSmsChannelResponseTypeDef(TypedDict):
    SMSChannelResponse: SMSChannelResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See SMSChannelResponseTypeDef
2. See ResponseMetadataTypeDef

DeleteVoiceChannelResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import DeleteVoiceChannelResponseTypeDef

def get_value() -> DeleteVoiceChannelResponseTypeDef:
    return {
        "VoiceChannelResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class DeleteVoiceChannelResponseTypeDef(TypedDict):
    VoiceChannelResponse: VoiceChannelResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See VoiceChannelResponseTypeDef
2. See ResponseMetadataTypeDef

GetVoiceChannelResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetVoiceChannelResponseTypeDef

def get_value() -> GetVoiceChannelResponseTypeDef:
    return {
        "VoiceChannelResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetVoiceChannelResponseTypeDef(TypedDict):
    VoiceChannelResponse: VoiceChannelResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See VoiceChannelResponseTypeDef
2. See ResponseMetadataTypeDef

UpdateVoiceChannelResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateVoiceChannelResponseTypeDef

def get_value() -> UpdateVoiceChannelResponseTypeDef:
    return {
        "VoiceChannelResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class UpdateVoiceChannelResponseTypeDef(TypedDict):
    VoiceChannelResponse: VoiceChannelResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See VoiceChannelResponseTypeDef
2. See ResponseMetadataTypeDef

UpdateEmailChannelRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateEmailChannelRequestRequestTypeDef

def get_value() -> UpdateEmailChannelRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "EmailChannelRequest": ...,
    }

Definition

class UpdateEmailChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    EmailChannelRequest: EmailChannelRequestTypeDef,  # (1)

1. See EmailChannelRequestTypeDef

EmailMessageActivityTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import EmailMessageActivityTypeDef

def get_value() -> EmailMessageActivityTypeDef:
    return {
        "MessageConfig": ...,
    }

Definition

class EmailMessageActivityTypeDef(TypedDict):
    MessageConfig: NotRequired[JourneyEmailMessageTypeDef],  # (1)
    NextActivity: NotRequired[str],
    TemplateName: NotRequired[str],
    TemplateVersion: NotRequired[str],

1. See JourneyEmailMessageTypeDef

GetEmailTemplateResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetEmailTemplateResponseTypeDef

def get_value() -> GetEmailTemplateResponseTypeDef:
    return {
        "EmailTemplateResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetEmailTemplateResponseTypeDef(TypedDict):
    EmailTemplateResponse: EmailTemplateResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See EmailTemplateResponseTypeDef
2. See ResponseMetadataTypeDef

EndpointBatchItemTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import EndpointBatchItemTypeDef

def get_value() -> EndpointBatchItemTypeDef:
    return {
        "Address": ...,
    }

Definition

class EndpointBatchItemTypeDef(TypedDict):
    Address: NotRequired[str],
    Attributes: NotRequired[Mapping[str, Sequence[str]]],
    ChannelType: NotRequired[ChannelTypeType],  # (1)
    Demographic: NotRequired[EndpointDemographicTypeDef],  # (2)
    EffectiveDate: NotRequired[str],
    EndpointStatus: NotRequired[str],
    Id: NotRequired[str],
    Location: NotRequired[EndpointLocationTypeDef],  # (3)
    Metrics: NotRequired[Mapping[str, float]],
    OptOut: NotRequired[str],
    RequestId: NotRequired[str],
    User: NotRequired[EndpointUserTypeDef],  # (4)

1. See ChannelTypeType
2. See EndpointDemographicTypeDef
3. See EndpointLocationTypeDef
4. See EndpointUserTypeDef

EndpointRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import EndpointRequestTypeDef

def get_value() -> EndpointRequestTypeDef:
    return {
        "Address": ...,
    }

Definition

class EndpointRequestTypeDef(TypedDict):
    Address: NotRequired[str],
    Attributes: NotRequired[Mapping[str, Sequence[str]]],
    ChannelType: NotRequired[ChannelTypeType],  # (1)
    Demographic: NotRequired[EndpointDemographicTypeDef],  # (2)
    EffectiveDate: NotRequired[str],
    EndpointStatus: NotRequired[str],
    Location: NotRequired[EndpointLocationTypeDef],  # (3)
    Metrics: NotRequired[Mapping[str, float]],
    OptOut: NotRequired[str],
    RequestId: NotRequired[str],
    User: NotRequired[EndpointUserTypeDef],  # (4)

1. See ChannelTypeType
2. See EndpointDemographicTypeDef
3. See EndpointLocationTypeDef
4. See EndpointUserTypeDef

EndpointResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import EndpointResponseTypeDef

def get_value() -> EndpointResponseTypeDef:
    return {
        "Address": ...,
    }

Definition

class EndpointResponseTypeDef(TypedDict):
    Address: NotRequired[str],
    ApplicationId: NotRequired[str],
    Attributes: NotRequired[Dict[str, List[str]]],
    ChannelType: NotRequired[ChannelTypeType],  # (1)
    CohortId: NotRequired[str],
    CreationDate: NotRequired[str],
    Demographic: NotRequired[EndpointDemographicTypeDef],  # (2)
    EffectiveDate: NotRequired[str],
    EndpointStatus: NotRequired[str],
    Id: NotRequired[str],
    Location: NotRequired[EndpointLocationTypeDef],  # (3)
    Metrics: NotRequired[Dict[str, float]],
    OptOut: NotRequired[str],
    RequestId: NotRequired[str],
    User: NotRequired[EndpointUserTypeDef],  # (4)

1. See ChannelTypeType
2. See EndpointDemographicTypeDef
3. See EndpointLocationTypeDef
4. See EndpointUserTypeDef

PublicEndpointTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import PublicEndpointTypeDef

def get_value() -> PublicEndpointTypeDef:
    return {
        "Address": ...,
    }

Definition

class PublicEndpointTypeDef(TypedDict):
    Address: NotRequired[str],
    Attributes: NotRequired[Mapping[str, Sequence[str]]],
    ChannelType: NotRequired[ChannelTypeType],  # (1)
    Demographic: NotRequired[EndpointDemographicTypeDef],  # (2)
    EffectiveDate: NotRequired[str],
    EndpointStatus: NotRequired[str],
    Location: NotRequired[EndpointLocationTypeDef],  # (3)
    Metrics: NotRequired[Mapping[str, float]],
    OptOut: NotRequired[str],
    RequestId: NotRequired[str],
    User: NotRequired[EndpointUserTypeDef],  # (4)

1. See ChannelTypeType
2. See EndpointDemographicTypeDef
3. See EndpointLocationTypeDef
4. See EndpointUserTypeDef

SendUsersMessageResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import SendUsersMessageResponseTypeDef

def get_value() -> SendUsersMessageResponseTypeDef:
    return {
        "ApplicationId": ...,
    }

Definition

class SendUsersMessageResponseTypeDef(TypedDict):
    ApplicationId: str,
    RequestId: NotRequired[str],
    Result: NotRequired[Dict[str, Dict[str, EndpointMessageResultTypeDef]]],  # (1)

1. See EndpointMessageResultTypeDef

EventDimensionsTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import EventDimensionsTypeDef

def get_value() -> EventDimensionsTypeDef:
    return {
        "Attributes": ...,
    }

Definition

class EventDimensionsTypeDef(TypedDict):
    Attributes: NotRequired[Mapping[str, AttributeDimensionTypeDef]],  # (1)
    EventType: NotRequired[SetDimensionTypeDef],  # (2)
    Metrics: NotRequired[Mapping[str, MetricDimensionTypeDef]],  # (3)

1. See AttributeDimensionTypeDef
2. See SetDimensionTypeDef
3. See MetricDimensionTypeDef

SegmentDemographicsTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import SegmentDemographicsTypeDef

def get_value() -> SegmentDemographicsTypeDef:
    return {
        "AppVersion": ...,
    }

Definition

class SegmentDemographicsTypeDef(TypedDict):
    AppVersion: NotRequired[SetDimensionTypeDef],  # (1)
    Channel: NotRequired[SetDimensionTypeDef],  # (1)
    DeviceType: NotRequired[SetDimensionTypeDef],  # (1)
    Make: NotRequired[SetDimensionTypeDef],  # (1)
    Model: NotRequired[SetDimensionTypeDef],  # (1)
    Platform: NotRequired[SetDimensionTypeDef],  # (1)

1. See SetDimensionTypeDef
2. See SetDimensionTypeDef
3. See SetDimensionTypeDef
4. See SetDimensionTypeDef
5. See SetDimensionTypeDef
6. See SetDimensionTypeDef

ItemResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import ItemResponseTypeDef

def get_value() -> ItemResponseTypeDef:
    return {
        "EndpointItemResponse": ...,
    }

Definition

class ItemResponseTypeDef(TypedDict):
    EndpointItemResponse: NotRequired[EndpointItemResponseTypeDef],  # (1)
    EventsItemResponse: NotRequired[Dict[str, EventItemResponseTypeDef]],  # (2)

1. See EndpointItemResponseTypeDef
2. See EventItemResponseTypeDef

EventTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import EventTypeDef

def get_value() -> EventTypeDef:
    return {
        "EventType": ...,
        "Timestamp": ...,
    }

Definition

class EventTypeDef(TypedDict):
    EventType: str,
    Timestamp: str,
    AppPackageName: NotRequired[str],
    AppTitle: NotRequired[str],
    AppVersionCode: NotRequired[str],
    Attributes: NotRequired[Mapping[str, str]],
    ClientSdkVersion: NotRequired[str],
    Metrics: NotRequired[Mapping[str, float]],
    SdkName: NotRequired[str],
    Session: NotRequired[SessionTypeDef],  # (1)

1. See SessionTypeDef

ExportJobResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import ExportJobResponseTypeDef

def get_value() -> ExportJobResponseTypeDef:
    return {
        "ApplicationId": ...,
        "CreationDate": ...,
        "Definition": ...,
        "Id": ...,
        "JobStatus": ...,
        "Type": ...,
    }

Definition

class ExportJobResponseTypeDef(TypedDict):
    ApplicationId: str,
    CreationDate: str,
    Definition: ExportJobResourceTypeDef,  # (1)
    Id: str,
    JobStatus: JobStatusType,  # (2)
    Type: str,
    CompletedPieces: NotRequired[int],
    CompletionDate: NotRequired[str],
    FailedPieces: NotRequired[int],
    Failures: NotRequired[List[str]],
    TotalFailures: NotRequired[int],
    TotalPieces: NotRequired[int],
    TotalProcessed: NotRequired[int],

1. See ExportJobResourceTypeDef
2. See JobStatusType

UpdateGcmChannelRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateGcmChannelRequestRequestTypeDef

def get_value() -> UpdateGcmChannelRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "GCMChannelRequest": ...,
    }

Definition

class UpdateGcmChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    GCMChannelRequest: GCMChannelRequestTypeDef,  # (1)

1. See GCMChannelRequestTypeDef

GPSPointDimensionTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GPSPointDimensionTypeDef

def get_value() -> GPSPointDimensionTypeDef:
    return {
        "Coordinates": ...,
    }

Definition

class GPSPointDimensionTypeDef(TypedDict):
    Coordinates: GPSCoordinatesTypeDef,  # (1)
    RangeInKilometers: NotRequired[float],

1. See GPSCoordinatesTypeDef

GetJourneyExecutionActivityMetricsResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetJourneyExecutionActivityMetricsResponseTypeDef

def get_value() -> GetJourneyExecutionActivityMetricsResponseTypeDef:
    return {
        "JourneyExecutionActivityMetricsResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetJourneyExecutionActivityMetricsResponseTypeDef(TypedDict):
    JourneyExecutionActivityMetricsResponse: JourneyExecutionActivityMetricsResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See JourneyExecutionActivityMetricsResponseTypeDef
2. See ResponseMetadataTypeDef

GetJourneyExecutionMetricsResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetJourneyExecutionMetricsResponseTypeDef

def get_value() -> GetJourneyExecutionMetricsResponseTypeDef:
    return {
        "JourneyExecutionMetricsResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetJourneyExecutionMetricsResponseTypeDef(TypedDict):
    JourneyExecutionMetricsResponse: JourneyExecutionMetricsResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See JourneyExecutionMetricsResponseTypeDef
2. See ResponseMetadataTypeDef

GetSmsTemplateResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetSmsTemplateResponseTypeDef

def get_value() -> GetSmsTemplateResponseTypeDef:
    return {
        "SMSTemplateResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetSmsTemplateResponseTypeDef(TypedDict):
    SMSTemplateResponse: SMSTemplateResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See SMSTemplateResponseTypeDef
2. See ResponseMetadataTypeDef

GetVoiceTemplateResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetVoiceTemplateResponseTypeDef

def get_value() -> GetVoiceTemplateResponseTypeDef:
    return {
        "VoiceTemplateResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetVoiceTemplateResponseTypeDef(TypedDict):
    VoiceTemplateResponse: VoiceTemplateResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See VoiceTemplateResponseTypeDef
2. See ResponseMetadataTypeDef

ImportJobResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import ImportJobResponseTypeDef

def get_value() -> ImportJobResponseTypeDef:
    return {
        "ApplicationId": ...,
        "CreationDate": ...,
        "Definition": ...,
        "Id": ...,
        "JobStatus": ...,
        "Type": ...,
    }

Definition

class ImportJobResponseTypeDef(TypedDict):
    ApplicationId: str,
    CreationDate: str,
    Definition: ImportJobResourceTypeDef,  # (1)
    Id: str,
    JobStatus: JobStatusType,  # (2)
    Type: str,
    CompletedPieces: NotRequired[int],
    CompletionDate: NotRequired[str],
    FailedPieces: NotRequired[int],
    Failures: NotRequired[List[str]],
    TotalFailures: NotRequired[int],
    TotalPieces: NotRequired[int],
    TotalProcessed: NotRequired[int],

1. See ImportJobResourceTypeDef
2. See JobStatusType

InAppMessageButtonTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import InAppMessageButtonTypeDef

def get_value() -> InAppMessageButtonTypeDef:
    return {
        "Android": ...,
    }

Definition

class InAppMessageButtonTypeDef(TypedDict):
    Android: NotRequired[OverrideButtonConfigurationTypeDef],  # (1)
    DefaultConfig: NotRequired[DefaultButtonConfigurationTypeDef],  # (2)
    IOS: NotRequired[OverrideButtonConfigurationTypeDef],  # (1)
    Web: NotRequired[OverrideButtonConfigurationTypeDef],  # (1)

1. See OverrideButtonConfigurationTypeDef
2. See DefaultButtonConfigurationTypeDef
3. See OverrideButtonConfigurationTypeDef
4. See OverrideButtonConfigurationTypeDef

PushMessageActivityTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import PushMessageActivityTypeDef

def get_value() -> PushMessageActivityTypeDef:
    return {
        "MessageConfig": ...,
    }

Definition

class PushMessageActivityTypeDef(TypedDict):
    MessageConfig: NotRequired[JourneyPushMessageTypeDef],  # (1)
    NextActivity: NotRequired[str],
    TemplateName: NotRequired[str],
    TemplateVersion: NotRequired[str],

1. See JourneyPushMessageTypeDef

SMSMessageActivityTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import SMSMessageActivityTypeDef

def get_value() -> SMSMessageActivityTypeDef:
    return {
        "MessageConfig": ...,
    }

Definition

class SMSMessageActivityTypeDef(TypedDict):
    MessageConfig: NotRequired[JourneySMSMessageTypeDef],  # (1)
    NextActivity: NotRequired[str],
    TemplateName: NotRequired[str],
    TemplateVersion: NotRequired[str],

1. See JourneySMSMessageTypeDef

UpdateJourneyStateRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateJourneyStateRequestRequestTypeDef

def get_value() -> UpdateJourneyStateRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "JourneyId": ...,
        "JourneyStateRequest": ...,
    }

Definition

class UpdateJourneyStateRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    JourneyId: str,
    JourneyStateRequest: JourneyStateRequestTypeDef,  # (1)

1. See JourneyStateRequestTypeDef

ListTagsForResourceResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import ListTagsForResourceResponseTypeDef

def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "TagsModel": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    TagsModel: TagsModelTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See TagsModelTypeDef
2. See ResponseMetadataTypeDef

TagResourceRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import TagResourceRequestRequestTypeDef

def get_value() -> TagResourceRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
        "TagsModel": ...,
    }

Definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    TagsModel: TagsModelTypeDef,  # (1)

1. See TagsModelTypeDef

MessageResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import MessageResponseTypeDef

def get_value() -> MessageResponseTypeDef:
    return {
        "ApplicationId": ...,
    }

Definition

class MessageResponseTypeDef(TypedDict):
    ApplicationId: str,
    EndpointResult: NotRequired[Dict[str, EndpointMessageResultTypeDef]],  # (1)
    RequestId: NotRequired[str],
    Result: NotRequired[Dict[str, MessageResultTypeDef]],  # (2)

1. See EndpointMessageResultTypeDef
2. See MessageResultTypeDef

PhoneNumberValidateRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import PhoneNumberValidateRequestRequestTypeDef

def get_value() -> PhoneNumberValidateRequestRequestTypeDef:
    return {
        "NumberValidateRequest": ...,
    }

Definition

class PhoneNumberValidateRequestRequestTypeDef(TypedDict):
    NumberValidateRequest: NumberValidateRequestTypeDef,  # (1)

1. See NumberValidateRequestTypeDef

PhoneNumberValidateResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import PhoneNumberValidateResponseTypeDef

def get_value() -> PhoneNumberValidateResponseTypeDef:
    return {
        "NumberValidateResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class PhoneNumberValidateResponseTypeDef(TypedDict):
    NumberValidateResponse: NumberValidateResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See NumberValidateResponseTypeDef
2. See ResponseMetadataTypeDef

OpenHoursTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import OpenHoursTypeDef

def get_value() -> OpenHoursTypeDef:
    return {
        "EMAIL": ...,
    }

Definition

class OpenHoursTypeDef(TypedDict):
    EMAIL: NotRequired[Mapping[DayOfWeekType, Sequence[OpenHoursRuleTypeDef]]],  # (1)
    SMS: NotRequired[Mapping[DayOfWeekType, Sequence[OpenHoursRuleTypeDef]]],  # (1)
    PUSH: NotRequired[Mapping[DayOfWeekType, Sequence[OpenHoursRuleTypeDef]]],  # (1)
    VOICE: NotRequired[Mapping[DayOfWeekType, Sequence[OpenHoursRuleTypeDef]]],  # (1)
    CUSTOM: NotRequired[Mapping[DayOfWeekType, Sequence[OpenHoursRuleTypeDef]]],  # (1)

1. See DayOfWeekType OpenHoursRuleTypeDef
2. See DayOfWeekType OpenHoursRuleTypeDef
3. See DayOfWeekType OpenHoursRuleTypeDef
4. See DayOfWeekType OpenHoursRuleTypeDef
5. See DayOfWeekType OpenHoursRuleTypeDef

PutEventStreamRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import PutEventStreamRequestRequestTypeDef

def get_value() -> PutEventStreamRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "WriteEventStream": ...,
    }

Definition

class PutEventStreamRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    WriteEventStream: WriteEventStreamTypeDef,  # (1)

1. See WriteEventStreamTypeDef

RandomSplitActivityTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import RandomSplitActivityTypeDef

def get_value() -> RandomSplitActivityTypeDef:
    return {
        "Branches": ...,
    }

Definition

class RandomSplitActivityTypeDef(TypedDict):
    Branches: NotRequired[Sequence[RandomSplitEntryTypeDef]],  # (1)

1. See RandomSplitEntryTypeDef

SegmentBehaviorsTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import SegmentBehaviorsTypeDef

def get_value() -> SegmentBehaviorsTypeDef:
    return {
        "Recency": ...,
    }

Definition

class SegmentBehaviorsTypeDef(TypedDict):
    Recency: NotRequired[RecencyDimensionTypeDef],  # (1)

1. See RecencyDimensionTypeDef

RemoveAttributesRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import RemoveAttributesRequestRequestTypeDef

def get_value() -> RemoveAttributesRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "AttributeType": ...,
        "UpdateAttributesRequest": ...,
    }

Definition

class RemoveAttributesRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    AttributeType: str,
    UpdateAttributesRequest: UpdateAttributesRequestTypeDef,  # (1)

1. See UpdateAttributesRequestTypeDef

ResultRowTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import ResultRowTypeDef

def get_value() -> ResultRowTypeDef:
    return {
        "GroupedBys": ...,
        "Values": ...,
    }

Definition

class ResultRowTypeDef(TypedDict):
    GroupedBys: List[ResultRowValueTypeDef],  # (1)
    Values: List[ResultRowValueTypeDef],  # (1)

1. See ResultRowValueTypeDef
2. See ResultRowValueTypeDef

UpdateSmsChannelRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateSmsChannelRequestRequestTypeDef

def get_value() -> UpdateSmsChannelRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "SMSChannelRequest": ...,
    }

Definition

class UpdateSmsChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    SMSChannelRequest: SMSChannelRequestTypeDef,  # (1)

1. See SMSChannelRequestTypeDef

SendOTPMessageRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import SendOTPMessageRequestRequestTypeDef

def get_value() -> SendOTPMessageRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "SendOTPMessageRequestParameters": ...,
    }

Definition

class SendOTPMessageRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    SendOTPMessageRequestParameters: SendOTPMessageRequestParametersTypeDef,  # (1)

1. See SendOTPMessageRequestParametersTypeDef

SimpleEmailTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import SimpleEmailTypeDef

def get_value() -> SimpleEmailTypeDef:
    return {
        "HtmlPart": ...,
    }

Definition

class SimpleEmailTypeDef(TypedDict):
    HtmlPart: NotRequired[SimpleEmailPartTypeDef],  # (1)
    Subject: NotRequired[SimpleEmailPartTypeDef],  # (1)
    TextPart: NotRequired[SimpleEmailPartTypeDef],  # (1)

1. See SimpleEmailPartTypeDef
2. See SimpleEmailPartTypeDef
3. See SimpleEmailPartTypeDef

UpdateTemplateActiveVersionRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateTemplateActiveVersionRequestRequestTypeDef

def get_value() -> UpdateTemplateActiveVersionRequestRequestTypeDef:
    return {
        "TemplateActiveVersionRequest": ...,
        "TemplateName": ...,
        "TemplateType": ...,
    }

Definition

class UpdateTemplateActiveVersionRequestRequestTypeDef(TypedDict):
    TemplateActiveVersionRequest: TemplateActiveVersionRequestTypeDef,  # (1)
    TemplateName: str,
    TemplateType: str,

1. See TemplateActiveVersionRequestTypeDef

TemplateConfigurationTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import TemplateConfigurationTypeDef

def get_value() -> TemplateConfigurationTypeDef:
    return {
        "EmailTemplate": ...,
    }

Definition

class TemplateConfigurationTypeDef(TypedDict):
    EmailTemplate: NotRequired[TemplateTypeDef],  # (1)
    PushTemplate: NotRequired[TemplateTypeDef],  # (1)
    SMSTemplate: NotRequired[TemplateTypeDef],  # (1)
    VoiceTemplate: NotRequired[TemplateTypeDef],  # (1)

1. See TemplateTypeDef
2. See TemplateTypeDef
3. See TemplateTypeDef
4. See TemplateTypeDef

TemplatesResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import TemplatesResponseTypeDef

def get_value() -> TemplatesResponseTypeDef:
    return {
        "Item": ...,
    }

Definition

class TemplatesResponseTypeDef(TypedDict):
    Item: List[TemplateResponseTypeDef],  # (1)
    NextToken: NotRequired[str],

1. See TemplateResponseTypeDef

TemplateVersionsResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import TemplateVersionsResponseTypeDef

def get_value() -> TemplateVersionsResponseTypeDef:
    return {
        "Item": ...,
    }

Definition

class TemplateVersionsResponseTypeDef(TypedDict):
    Item: List[TemplateVersionResponseTypeDef],  # (1)
    Message: NotRequired[str],
    NextToken: NotRequired[str],
    RequestID: NotRequired[str],

1. See TemplateVersionResponseTypeDef

UpdateRecommenderConfigurationRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateRecommenderConfigurationRequestRequestTypeDef

def get_value() -> UpdateRecommenderConfigurationRequestRequestTypeDef:
    return {
        "RecommenderId": ...,
        "UpdateRecommenderConfiguration": ...,
    }

Definition

class UpdateRecommenderConfigurationRequestRequestTypeDef(TypedDict):
    RecommenderId: str,
    UpdateRecommenderConfiguration: UpdateRecommenderConfigurationTypeDef,  # (1)

1. See UpdateRecommenderConfigurationTypeDef

UpdateVoiceChannelRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateVoiceChannelRequestRequestTypeDef

def get_value() -> UpdateVoiceChannelRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "VoiceChannelRequest": ...,
    }

Definition

class UpdateVoiceChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    VoiceChannelRequest: VoiceChannelRequestTypeDef,  # (1)

1. See VoiceChannelRequestTypeDef

VerifyOTPMessageResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import VerifyOTPMessageResponseTypeDef

def get_value() -> VerifyOTPMessageResponseTypeDef:
    return {
        "VerificationResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class VerifyOTPMessageResponseTypeDef(TypedDict):
    VerificationResponse: VerificationResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See VerificationResponseTypeDef
2. See ResponseMetadataTypeDef

VerifyOTPMessageRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import VerifyOTPMessageRequestRequestTypeDef

def get_value() -> VerifyOTPMessageRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "VerifyOTPMessageRequestParameters": ...,
    }

Definition

class VerifyOTPMessageRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    VerifyOTPMessageRequestParameters: VerifyOTPMessageRequestParametersTypeDef,  # (1)

1. See VerifyOTPMessageRequestParametersTypeDef

GetCampaignActivitiesResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetCampaignActivitiesResponseTypeDef

def get_value() -> GetCampaignActivitiesResponseTypeDef:
    return {
        "ActivitiesResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetCampaignActivitiesResponseTypeDef(TypedDict):
    ActivitiesResponse: ActivitiesResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ActivitiesResponseTypeDef
2. See ResponseMetadataTypeDef

GetAppsResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetAppsResponseTypeDef

def get_value() -> GetAppsResponseTypeDef:
    return {
        "ApplicationsResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetAppsResponseTypeDef(TypedDict):
    ApplicationsResponse: ApplicationsResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ApplicationsResponseTypeDef
2. See ResponseMetadataTypeDef

GetApplicationSettingsResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetApplicationSettingsResponseTypeDef

def get_value() -> GetApplicationSettingsResponseTypeDef:
    return {
        "ApplicationSettingsResource": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetApplicationSettingsResponseTypeDef(TypedDict):
    ApplicationSettingsResource: ApplicationSettingsResourceTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ApplicationSettingsResourceTypeDef
2. See ResponseMetadataTypeDef

UpdateApplicationSettingsResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateApplicationSettingsResponseTypeDef

def get_value() -> UpdateApplicationSettingsResponseTypeDef:
    return {
        "ApplicationSettingsResource": ...,
        "ResponseMetadata": ...,
    }

Definition

class UpdateApplicationSettingsResponseTypeDef(TypedDict):
    ApplicationSettingsResource: ApplicationSettingsResourceTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ApplicationSettingsResourceTypeDef
2. See ResponseMetadataTypeDef

UpdateApplicationSettingsRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateApplicationSettingsRequestRequestTypeDef

def get_value() -> UpdateApplicationSettingsRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "WriteApplicationSettingsRequest": ...,
    }

Definition

class UpdateApplicationSettingsRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    WriteApplicationSettingsRequest: WriteApplicationSettingsRequestTypeDef,  # (1)

1. See WriteApplicationSettingsRequestTypeDef

GetChannelsResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetChannelsResponseTypeDef

def get_value() -> GetChannelsResponseTypeDef:
    return {
        "ChannelsResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetChannelsResponseTypeDef(TypedDict):
    ChannelsResponse: ChannelsResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ChannelsResponseTypeDef
2. See ResponseMetadataTypeDef

GetRecommenderConfigurationsResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetRecommenderConfigurationsResponseTypeDef

def get_value() -> GetRecommenderConfigurationsResponseTypeDef:
    return {
        "ListRecommenderConfigurationsResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetRecommenderConfigurationsResponseTypeDef(TypedDict):
    ListRecommenderConfigurationsResponse: ListRecommenderConfigurationsResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ListRecommenderConfigurationsResponseTypeDef
2. See ResponseMetadataTypeDef

CreatePushTemplateRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import CreatePushTemplateRequestRequestTypeDef

def get_value() -> CreatePushTemplateRequestRequestTypeDef:
    return {
        "PushNotificationTemplateRequest": ...,
        "TemplateName": ...,
    }

Definition

class CreatePushTemplateRequestRequestTypeDef(TypedDict):
    PushNotificationTemplateRequest: PushNotificationTemplateRequestTypeDef,  # (1)
    TemplateName: str,

1. See PushNotificationTemplateRequestTypeDef

UpdatePushTemplateRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdatePushTemplateRequestRequestTypeDef

def get_value() -> UpdatePushTemplateRequestRequestTypeDef:
    return {
        "PushNotificationTemplateRequest": ...,
        "TemplateName": ...,
    }

Definition

class UpdatePushTemplateRequestRequestTypeDef(TypedDict):
    PushNotificationTemplateRequest: PushNotificationTemplateRequestTypeDef,  # (1)
    TemplateName: str,
    CreateNewVersion: NotRequired[bool],
    Version: NotRequired[str],

1. See PushNotificationTemplateRequestTypeDef

GetPushTemplateResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetPushTemplateResponseTypeDef

def get_value() -> GetPushTemplateResponseTypeDef:
    return {
        "PushNotificationTemplateResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetPushTemplateResponseTypeDef(TypedDict):
    PushNotificationTemplateResponse: PushNotificationTemplateResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See PushNotificationTemplateResponseTypeDef
2. See ResponseMetadataTypeDef

EndpointBatchRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import EndpointBatchRequestTypeDef

def get_value() -> EndpointBatchRequestTypeDef:
    return {
        "Item": ...,
    }

Definition

class EndpointBatchRequestTypeDef(TypedDict):
    Item: Sequence[EndpointBatchItemTypeDef],  # (1)

1. See EndpointBatchItemTypeDef

UpdateEndpointRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateEndpointRequestRequestTypeDef

def get_value() -> UpdateEndpointRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "EndpointId": ...,
        "EndpointRequest": ...,
    }

Definition

class UpdateEndpointRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    EndpointId: str,
    EndpointRequest: EndpointRequestTypeDef,  # (1)

1. See EndpointRequestTypeDef

DeleteEndpointResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import DeleteEndpointResponseTypeDef

def get_value() -> DeleteEndpointResponseTypeDef:
    return {
        "EndpointResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class DeleteEndpointResponseTypeDef(TypedDict):
    EndpointResponse: EndpointResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See EndpointResponseTypeDef
2. See ResponseMetadataTypeDef

EndpointsResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import EndpointsResponseTypeDef

def get_value() -> EndpointsResponseTypeDef:
    return {
        "Item": ...,
    }

Definition

class EndpointsResponseTypeDef(TypedDict):
    Item: List[EndpointResponseTypeDef],  # (1)

1. See EndpointResponseTypeDef

GetEndpointResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetEndpointResponseTypeDef

def get_value() -> GetEndpointResponseTypeDef:
    return {
        "EndpointResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetEndpointResponseTypeDef(TypedDict):
    EndpointResponse: EndpointResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See EndpointResponseTypeDef
2. See ResponseMetadataTypeDef

SendUsersMessagesResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import SendUsersMessagesResponseTypeDef

def get_value() -> SendUsersMessagesResponseTypeDef:
    return {
        "SendUsersMessageResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class SendUsersMessagesResponseTypeDef(TypedDict):
    SendUsersMessageResponse: SendUsersMessageResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See SendUsersMessageResponseTypeDef
2. See ResponseMetadataTypeDef

CampaignEventFilterTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import CampaignEventFilterTypeDef

def get_value() -> CampaignEventFilterTypeDef:
    return {
        "Dimensions": ...,
        "FilterType": ...,
    }

Definition

class CampaignEventFilterTypeDef(TypedDict):
    Dimensions: EventDimensionsTypeDef,  # (1)
    FilterType: FilterTypeType,  # (2)

1. See EventDimensionsTypeDef
2. See FilterTypeType

EventConditionTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import EventConditionTypeDef

def get_value() -> EventConditionTypeDef:
    return {
        "Dimensions": ...,
    }

Definition

class EventConditionTypeDef(TypedDict):
    Dimensions: NotRequired[EventDimensionsTypeDef],  # (1)
    MessageActivity: NotRequired[str],

1. See EventDimensionsTypeDef

EventFilterTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import EventFilterTypeDef

def get_value() -> EventFilterTypeDef:
    return {
        "Dimensions": ...,
        "FilterType": ...,
    }

Definition

class EventFilterTypeDef(TypedDict):
    Dimensions: EventDimensionsTypeDef,  # (1)
    FilterType: FilterTypeType,  # (2)

1. See EventDimensionsTypeDef
2. See FilterTypeType

EventsResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import EventsResponseTypeDef

def get_value() -> EventsResponseTypeDef:
    return {
        "Results": ...,
    }

Definition

class EventsResponseTypeDef(TypedDict):
    Results: NotRequired[Dict[str, ItemResponseTypeDef]],  # (1)

1. See ItemResponseTypeDef

EventsBatchTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import EventsBatchTypeDef

def get_value() -> EventsBatchTypeDef:
    return {
        "Endpoint": ...,
        "Events": ...,
    }

Definition

class EventsBatchTypeDef(TypedDict):
    Endpoint: PublicEndpointTypeDef,  # (1)
    Events: Mapping[str, EventTypeDef],  # (2)

1. See PublicEndpointTypeDef
2. See EventTypeDef

CreateExportJobResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import CreateExportJobResponseTypeDef

def get_value() -> CreateExportJobResponseTypeDef:
    return {
        "ExportJobResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class CreateExportJobResponseTypeDef(TypedDict):
    ExportJobResponse: ExportJobResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ExportJobResponseTypeDef
2. See ResponseMetadataTypeDef

ExportJobsResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import ExportJobsResponseTypeDef

def get_value() -> ExportJobsResponseTypeDef:
    return {
        "Item": ...,
    }

Definition

class ExportJobsResponseTypeDef(TypedDict):
    Item: List[ExportJobResponseTypeDef],  # (1)
    NextToken: NotRequired[str],

1. See ExportJobResponseTypeDef

GetExportJobResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetExportJobResponseTypeDef

def get_value() -> GetExportJobResponseTypeDef:
    return {
        "ExportJobResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetExportJobResponseTypeDef(TypedDict):
    ExportJobResponse: ExportJobResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ExportJobResponseTypeDef
2. See ResponseMetadataTypeDef

SegmentLocationTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import SegmentLocationTypeDef

def get_value() -> SegmentLocationTypeDef:
    return {
        "Country": ...,
    }

Definition

class SegmentLocationTypeDef(TypedDict):
    Country: NotRequired[SetDimensionTypeDef],  # (1)
    GPSPoint: NotRequired[GPSPointDimensionTypeDef],  # (2)

1. See SetDimensionTypeDef
2. See GPSPointDimensionTypeDef

CreateImportJobResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import CreateImportJobResponseTypeDef

def get_value() -> CreateImportJobResponseTypeDef:
    return {
        "ImportJobResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class CreateImportJobResponseTypeDef(TypedDict):
    ImportJobResponse: ImportJobResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ImportJobResponseTypeDef
2. See ResponseMetadataTypeDef

GetImportJobResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetImportJobResponseTypeDef

def get_value() -> GetImportJobResponseTypeDef:
    return {
        "ImportJobResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetImportJobResponseTypeDef(TypedDict):
    ImportJobResponse: ImportJobResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ImportJobResponseTypeDef
2. See ResponseMetadataTypeDef

ImportJobsResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import ImportJobsResponseTypeDef

def get_value() -> ImportJobsResponseTypeDef:
    return {
        "Item": ...,
    }

Definition

class ImportJobsResponseTypeDef(TypedDict):
    Item: List[ImportJobResponseTypeDef],  # (1)
    NextToken: NotRequired[str],

1. See ImportJobResponseTypeDef

InAppMessageContentTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import InAppMessageContentTypeDef

def get_value() -> InAppMessageContentTypeDef:
    return {
        "BackgroundColor": ...,
    }

Definition

class InAppMessageContentTypeDef(TypedDict):
    BackgroundColor: NotRequired[str],
    BodyConfig: NotRequired[InAppMessageBodyConfigTypeDef],  # (1)
    HeaderConfig: NotRequired[InAppMessageHeaderConfigTypeDef],  # (2)
    ImageUrl: NotRequired[str],
    PrimaryBtn: NotRequired[InAppMessageButtonTypeDef],  # (3)
    SecondaryBtn: NotRequired[InAppMessageButtonTypeDef],  # (3)

1. See InAppMessageBodyConfigTypeDef
2. See InAppMessageHeaderConfigTypeDef
3. See InAppMessageButtonTypeDef
4. See InAppMessageButtonTypeDef

SendMessagesResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import SendMessagesResponseTypeDef

def get_value() -> SendMessagesResponseTypeDef:
    return {
        "MessageResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class SendMessagesResponseTypeDef(TypedDict):
    MessageResponse: MessageResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See MessageResponseTypeDef
2. See ResponseMetadataTypeDef

SendOTPMessageResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import SendOTPMessageResponseTypeDef

def get_value() -> SendOTPMessageResponseTypeDef:
    return {
        "MessageResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class SendOTPMessageResponseTypeDef(TypedDict):
    MessageResponse: MessageResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See MessageResponseTypeDef
2. See ResponseMetadataTypeDef

BaseKpiResultTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import BaseKpiResultTypeDef

def get_value() -> BaseKpiResultTypeDef:
    return {
        "Rows": ...,
    }

Definition

class BaseKpiResultTypeDef(TypedDict):
    Rows: List[ResultRowTypeDef],  # (1)

1. See ResultRowTypeDef

EmailMessageTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import EmailMessageTypeDef

def get_value() -> EmailMessageTypeDef:
    return {
        "Body": ...,
    }

Definition

class EmailMessageTypeDef(TypedDict):
    Body: NotRequired[str],
    FeedbackForwardingAddress: NotRequired[str],
    FromAddress: NotRequired[str],
    RawEmail: NotRequired[RawEmailTypeDef],  # (1)
    ReplyToAddresses: NotRequired[Sequence[str]],
    SimpleEmail: NotRequired[SimpleEmailTypeDef],  # (2)
    Substitutions: NotRequired[Mapping[str, Sequence[str]]],

1. See RawEmailTypeDef
2. See SimpleEmailTypeDef

ListTemplatesResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import ListTemplatesResponseTypeDef

def get_value() -> ListTemplatesResponseTypeDef:
    return {
        "TemplatesResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListTemplatesResponseTypeDef(TypedDict):
    TemplatesResponse: TemplatesResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See TemplatesResponseTypeDef
2. See ResponseMetadataTypeDef

ListTemplateVersionsResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import ListTemplateVersionsResponseTypeDef

def get_value() -> ListTemplateVersionsResponseTypeDef:
    return {
        "TemplateVersionsResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListTemplateVersionsResponseTypeDef(TypedDict):
    TemplateVersionsResponse: TemplateVersionsResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See TemplateVersionsResponseTypeDef
2. See ResponseMetadataTypeDef

UpdateEndpointsBatchRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateEndpointsBatchRequestRequestTypeDef

def get_value() -> UpdateEndpointsBatchRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "EndpointBatchRequest": ...,
    }

Definition

class UpdateEndpointsBatchRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    EndpointBatchRequest: EndpointBatchRequestTypeDef,  # (1)

1. See EndpointBatchRequestTypeDef

DeleteUserEndpointsResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import DeleteUserEndpointsResponseTypeDef

def get_value() -> DeleteUserEndpointsResponseTypeDef:
    return {
        "EndpointsResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class DeleteUserEndpointsResponseTypeDef(TypedDict):
    EndpointsResponse: EndpointsResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See EndpointsResponseTypeDef
2. See ResponseMetadataTypeDef

GetUserEndpointsResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetUserEndpointsResponseTypeDef

def get_value() -> GetUserEndpointsResponseTypeDef:
    return {
        "EndpointsResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetUserEndpointsResponseTypeDef(TypedDict):
    EndpointsResponse: EndpointsResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See EndpointsResponseTypeDef
2. See ResponseMetadataTypeDef

InAppCampaignScheduleTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import InAppCampaignScheduleTypeDef

def get_value() -> InAppCampaignScheduleTypeDef:
    return {
        "EndDate": ...,
    }

Definition

class InAppCampaignScheduleTypeDef(TypedDict):
    EndDate: NotRequired[str],
    EventFilter: NotRequired[CampaignEventFilterTypeDef],  # (1)
    QuietTime: NotRequired[QuietTimeTypeDef],  # (2)

1. See CampaignEventFilterTypeDef
2. See QuietTimeTypeDef

ScheduleTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import ScheduleTypeDef

def get_value() -> ScheduleTypeDef:
    return {
        "StartTime": ...,
    }

Definition

class ScheduleTypeDef(TypedDict):
    StartTime: str,
    EndTime: NotRequired[str],
    EventFilter: NotRequired[CampaignEventFilterTypeDef],  # (1)
    Frequency: NotRequired[FrequencyType],  # (2)
    IsLocalTime: NotRequired[bool],
    QuietTime: NotRequired[QuietTimeTypeDef],  # (3)
    Timezone: NotRequired[str],

1. See CampaignEventFilterTypeDef
2. See FrequencyType
3. See QuietTimeTypeDef

EventStartConditionTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import EventStartConditionTypeDef

def get_value() -> EventStartConditionTypeDef:
    return {
        "EventFilter": ...,
    }

Definition

class EventStartConditionTypeDef(TypedDict):
    EventFilter: NotRequired[EventFilterTypeDef],  # (1)
    SegmentId: NotRequired[str],

1. See EventFilterTypeDef

PutEventsResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import PutEventsResponseTypeDef

def get_value() -> PutEventsResponseTypeDef:
    return {
        "EventsResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class PutEventsResponseTypeDef(TypedDict):
    EventsResponse: EventsResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See EventsResponseTypeDef
2. See ResponseMetadataTypeDef

EventsRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import EventsRequestTypeDef

def get_value() -> EventsRequestTypeDef:
    return {
        "BatchItem": ...,
    }

Definition

class EventsRequestTypeDef(TypedDict):
    BatchItem: Mapping[str, EventsBatchTypeDef],  # (1)

1. See EventsBatchTypeDef

GetExportJobsResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetExportJobsResponseTypeDef

def get_value() -> GetExportJobsResponseTypeDef:
    return {
        "ExportJobsResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetExportJobsResponseTypeDef(TypedDict):
    ExportJobsResponse: ExportJobsResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ExportJobsResponseTypeDef
2. See ResponseMetadataTypeDef

GetSegmentExportJobsResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetSegmentExportJobsResponseTypeDef

def get_value() -> GetSegmentExportJobsResponseTypeDef:
    return {
        "ExportJobsResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetSegmentExportJobsResponseTypeDef(TypedDict):
    ExportJobsResponse: ExportJobsResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ExportJobsResponseTypeDef
2. See ResponseMetadataTypeDef

SegmentDimensionsTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import SegmentDimensionsTypeDef

def get_value() -> SegmentDimensionsTypeDef:
    return {
        "Attributes": ...,
    }

Definition

class SegmentDimensionsTypeDef(TypedDict):
    Attributes: NotRequired[Mapping[str, AttributeDimensionTypeDef]],  # (1)
    Behavior: NotRequired[SegmentBehaviorsTypeDef],  # (2)
    Demographic: NotRequired[SegmentDemographicsTypeDef],  # (3)
    Location: NotRequired[SegmentLocationTypeDef],  # (4)
    Metrics: NotRequired[Mapping[str, MetricDimensionTypeDef]],  # (5)
    UserAttributes: NotRequired[Mapping[str, AttributeDimensionTypeDef]],  # (1)

1. See AttributeDimensionTypeDef
2. See SegmentBehaviorsTypeDef
3. See SegmentDemographicsTypeDef
4. See SegmentLocationTypeDef
5. See MetricDimensionTypeDef
6. See AttributeDimensionTypeDef

GetImportJobsResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetImportJobsResponseTypeDef

def get_value() -> GetImportJobsResponseTypeDef:
    return {
        "ImportJobsResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetImportJobsResponseTypeDef(TypedDict):
    ImportJobsResponse: ImportJobsResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ImportJobsResponseTypeDef
2. See ResponseMetadataTypeDef

GetSegmentImportJobsResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetSegmentImportJobsResponseTypeDef

def get_value() -> GetSegmentImportJobsResponseTypeDef:
    return {
        "ImportJobsResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetSegmentImportJobsResponseTypeDef(TypedDict):
    ImportJobsResponse: ImportJobsResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ImportJobsResponseTypeDef
2. See ResponseMetadataTypeDef

CampaignInAppMessageTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import CampaignInAppMessageTypeDef

def get_value() -> CampaignInAppMessageTypeDef:
    return {
        "Body": ...,
    }

Definition

class CampaignInAppMessageTypeDef(TypedDict):
    Body: NotRequired[str],
    Content: NotRequired[Sequence[InAppMessageContentTypeDef]],  # (1)
    CustomConfig: NotRequired[Mapping[str, str]],
    Layout: NotRequired[LayoutType],  # (2)

1. See InAppMessageContentTypeDef
2. See LayoutType

InAppMessageTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import InAppMessageTypeDef

def get_value() -> InAppMessageTypeDef:
    return {
        "Content": ...,
    }

Definition

class InAppMessageTypeDef(TypedDict):
    Content: NotRequired[List[InAppMessageContentTypeDef]],  # (1)
    CustomConfig: NotRequired[Dict[str, str]],
    Layout: NotRequired[LayoutType],  # (2)

1. See InAppMessageContentTypeDef
2. See LayoutType

InAppTemplateRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import InAppTemplateRequestTypeDef

def get_value() -> InAppTemplateRequestTypeDef:
    return {
        "Content": ...,
    }

Definition

class InAppTemplateRequestTypeDef(TypedDict):
    Content: NotRequired[Sequence[InAppMessageContentTypeDef]],  # (1)
    CustomConfig: NotRequired[Mapping[str, str]],
    Layout: NotRequired[LayoutType],  # (2)
    tags: NotRequired[Mapping[str, str]],
    TemplateDescription: NotRequired[str],

1. See InAppMessageContentTypeDef
2. See LayoutType

InAppTemplateResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import InAppTemplateResponseTypeDef

def get_value() -> InAppTemplateResponseTypeDef:
    return {
        "CreationDate": ...,
        "LastModifiedDate": ...,
        "TemplateName": ...,
        "TemplateType": ...,
    }

Definition

class InAppTemplateResponseTypeDef(TypedDict):
    CreationDate: str,
    LastModifiedDate: str,
    TemplateName: str,
    TemplateType: TemplateTypeType,  # (3)
    Arn: NotRequired[str],
    Content: NotRequired[List[InAppMessageContentTypeDef]],  # (1)
    CustomConfig: NotRequired[Dict[str, str]],
    Layout: NotRequired[LayoutType],  # (2)
    tags: NotRequired[Dict[str, str]],
    TemplateDescription: NotRequired[str],
    Version: NotRequired[str],

1. See InAppMessageContentTypeDef
2. See LayoutType
3. See TemplateTypeType

ApplicationDateRangeKpiResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import ApplicationDateRangeKpiResponseTypeDef

def get_value() -> ApplicationDateRangeKpiResponseTypeDef:
    return {
        "ApplicationId": ...,
        "EndTime": ...,
        "KpiName": ...,
        "KpiResult": ...,
        "StartTime": ...,
    }

Definition

class ApplicationDateRangeKpiResponseTypeDef(TypedDict):
    ApplicationId: str,
    EndTime: datetime,
    KpiName: str,
    KpiResult: BaseKpiResultTypeDef,  # (1)
    StartTime: datetime,
    NextToken: NotRequired[str],

1. See BaseKpiResultTypeDef

CampaignDateRangeKpiResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import CampaignDateRangeKpiResponseTypeDef

def get_value() -> CampaignDateRangeKpiResponseTypeDef:
    return {
        "ApplicationId": ...,
        "CampaignId": ...,
        "EndTime": ...,
        "KpiName": ...,
        "KpiResult": ...,
        "StartTime": ...,
    }

Definition

class CampaignDateRangeKpiResponseTypeDef(TypedDict):
    ApplicationId: str,
    CampaignId: str,
    EndTime: datetime,
    KpiName: str,
    KpiResult: BaseKpiResultTypeDef,  # (1)
    StartTime: datetime,
    NextToken: NotRequired[str],

1. See BaseKpiResultTypeDef

JourneyDateRangeKpiResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import JourneyDateRangeKpiResponseTypeDef

def get_value() -> JourneyDateRangeKpiResponseTypeDef:
    return {
        "ApplicationId": ...,
        "EndTime": ...,
        "JourneyId": ...,
        "KpiName": ...,
        "KpiResult": ...,
        "StartTime": ...,
    }

Definition

class JourneyDateRangeKpiResponseTypeDef(TypedDict):
    ApplicationId: str,
    EndTime: datetime,
    JourneyId: str,
    KpiName: str,
    KpiResult: BaseKpiResultTypeDef,  # (1)
    StartTime: datetime,
    NextToken: NotRequired[str],

1. See BaseKpiResultTypeDef

DirectMessageConfigurationTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import DirectMessageConfigurationTypeDef

def get_value() -> DirectMessageConfigurationTypeDef:
    return {
        "ADMMessage": ...,
    }

Definition

class DirectMessageConfigurationTypeDef(TypedDict):
    ADMMessage: NotRequired[ADMMessageTypeDef],  # (1)
    APNSMessage: NotRequired[APNSMessageTypeDef],  # (2)
    BaiduMessage: NotRequired[BaiduMessageTypeDef],  # (3)
    DefaultMessage: NotRequired[DefaultMessageTypeDef],  # (4)
    DefaultPushNotificationMessage: NotRequired[DefaultPushNotificationMessageTypeDef],  # (5)
    EmailMessage: NotRequired[EmailMessageTypeDef],  # (6)
    GCMMessage: NotRequired[GCMMessageTypeDef],  # (7)
    SMSMessage: NotRequired[SMSMessageTypeDef],  # (8)
    VoiceMessage: NotRequired[VoiceMessageTypeDef],  # (9)

1. See ADMMessageTypeDef
2. See APNSMessageTypeDef
3. See BaiduMessageTypeDef
4. See DefaultMessageTypeDef
5. See DefaultPushNotificationMessageTypeDef
6. See EmailMessageTypeDef
7. See GCMMessageTypeDef
8. See SMSMessageTypeDef
9. See VoiceMessageTypeDef

StartConditionTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import StartConditionTypeDef

def get_value() -> StartConditionTypeDef:
    return {
        "Description": ...,
    }

Definition

class StartConditionTypeDef(TypedDict):
    Description: NotRequired[str],
    EventStartCondition: NotRequired[EventStartConditionTypeDef],  # (1)
    SegmentStartCondition: NotRequired[SegmentConditionTypeDef],  # (2)

1. See EventStartConditionTypeDef
2. See SegmentConditionTypeDef

PutEventsRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import PutEventsRequestRequestTypeDef

def get_value() -> PutEventsRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "EventsRequest": ...,
    }

Definition

class PutEventsRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    EventsRequest: EventsRequestTypeDef,  # (1)

1. See EventsRequestTypeDef

SegmentGroupTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import SegmentGroupTypeDef

def get_value() -> SegmentGroupTypeDef:
    return {
        "Dimensions": ...,
    }

Definition

class SegmentGroupTypeDef(TypedDict):
    Dimensions: NotRequired[Sequence[SegmentDimensionsTypeDef]],  # (1)
    SourceSegments: NotRequired[Sequence[SegmentReferenceTypeDef]],  # (2)
    SourceType: NotRequired[SourceTypeType],  # (3)
    Type: NotRequired[TypeType],  # (4)

1. See SegmentDimensionsTypeDef
2. See SegmentReferenceTypeDef
3. See SourceTypeType
4. See TypeType

SimpleConditionTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import SimpleConditionTypeDef

def get_value() -> SimpleConditionTypeDef:
    return {
        "EventCondition": ...,
    }

Definition

class SimpleConditionTypeDef(TypedDict):
    EventCondition: NotRequired[EventConditionTypeDef],  # (1)
    SegmentCondition: NotRequired[SegmentConditionTypeDef],  # (2)
    SegmentDimensions: NotRequired[SegmentDimensionsTypeDef],  # (3)

1. See EventConditionTypeDef
2. See SegmentConditionTypeDef
3. See SegmentDimensionsTypeDef

MessageConfigurationTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import MessageConfigurationTypeDef

def get_value() -> MessageConfigurationTypeDef:
    return {
        "ADMMessage": ...,
    }

Definition

class MessageConfigurationTypeDef(TypedDict):
    ADMMessage: NotRequired[MessageTypeDef],  # (1)
    APNSMessage: NotRequired[MessageTypeDef],  # (1)
    BaiduMessage: NotRequired[MessageTypeDef],  # (1)
    CustomMessage: NotRequired[CampaignCustomMessageTypeDef],  # (4)
    DefaultMessage: NotRequired[MessageTypeDef],  # (1)
    EmailMessage: NotRequired[CampaignEmailMessageTypeDef],  # (6)
    GCMMessage: NotRequired[MessageTypeDef],  # (1)
    SMSMessage: NotRequired[CampaignSmsMessageTypeDef],  # (8)
    InAppMessage: NotRequired[CampaignInAppMessageTypeDef],  # (9)

1. See MessageTypeDef
2. See MessageTypeDef
3. See MessageTypeDef
4. See CampaignCustomMessageTypeDef
5. See MessageTypeDef
6. See CampaignEmailMessageTypeDef
7. See MessageTypeDef
8. See CampaignSmsMessageTypeDef
9. See CampaignInAppMessageTypeDef

InAppMessageCampaignTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import InAppMessageCampaignTypeDef

def get_value() -> InAppMessageCampaignTypeDef:
    return {
        "CampaignId": ...,
    }

Definition

class InAppMessageCampaignTypeDef(TypedDict):
    CampaignId: NotRequired[str],
    DailyCap: NotRequired[int],
    InAppMessage: NotRequired[InAppMessageTypeDef],  # (1)
    Priority: NotRequired[int],
    Schedule: NotRequired[InAppCampaignScheduleTypeDef],  # (2)
    SessionCap: NotRequired[int],
    TotalCap: NotRequired[int],
    TreatmentId: NotRequired[str],

1. See InAppMessageTypeDef
2. See InAppCampaignScheduleTypeDef

CreateInAppTemplateRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import CreateInAppTemplateRequestRequestTypeDef

def get_value() -> CreateInAppTemplateRequestRequestTypeDef:
    return {
        "InAppTemplateRequest": ...,
        "TemplateName": ...,
    }

Definition

class CreateInAppTemplateRequestRequestTypeDef(TypedDict):
    InAppTemplateRequest: InAppTemplateRequestTypeDef,  # (1)
    TemplateName: str,

1. See InAppTemplateRequestTypeDef

UpdateInAppTemplateRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateInAppTemplateRequestRequestTypeDef

def get_value() -> UpdateInAppTemplateRequestRequestTypeDef:
    return {
        "InAppTemplateRequest": ...,
        "TemplateName": ...,
    }

Definition

class UpdateInAppTemplateRequestRequestTypeDef(TypedDict):
    InAppTemplateRequest: InAppTemplateRequestTypeDef,  # (1)
    TemplateName: str,
    CreateNewVersion: NotRequired[bool],
    Version: NotRequired[str],

1. See InAppTemplateRequestTypeDef

GetInAppTemplateResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetInAppTemplateResponseTypeDef

def get_value() -> GetInAppTemplateResponseTypeDef:
    return {
        "InAppTemplateResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetInAppTemplateResponseTypeDef(TypedDict):
    InAppTemplateResponse: InAppTemplateResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See InAppTemplateResponseTypeDef
2. See ResponseMetadataTypeDef

GetApplicationDateRangeKpiResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetApplicationDateRangeKpiResponseTypeDef

def get_value() -> GetApplicationDateRangeKpiResponseTypeDef:
    return {
        "ApplicationDateRangeKpiResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetApplicationDateRangeKpiResponseTypeDef(TypedDict):
    ApplicationDateRangeKpiResponse: ApplicationDateRangeKpiResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ApplicationDateRangeKpiResponseTypeDef
2. See ResponseMetadataTypeDef

GetCampaignDateRangeKpiResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetCampaignDateRangeKpiResponseTypeDef

def get_value() -> GetCampaignDateRangeKpiResponseTypeDef:
    return {
        "CampaignDateRangeKpiResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetCampaignDateRangeKpiResponseTypeDef(TypedDict):
    CampaignDateRangeKpiResponse: CampaignDateRangeKpiResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See CampaignDateRangeKpiResponseTypeDef
2. See ResponseMetadataTypeDef

GetJourneyDateRangeKpiResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetJourneyDateRangeKpiResponseTypeDef

def get_value() -> GetJourneyDateRangeKpiResponseTypeDef:
    return {
        "JourneyDateRangeKpiResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetJourneyDateRangeKpiResponseTypeDef(TypedDict):
    JourneyDateRangeKpiResponse: JourneyDateRangeKpiResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See JourneyDateRangeKpiResponseTypeDef
2. See ResponseMetadataTypeDef

MessageRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import MessageRequestTypeDef

def get_value() -> MessageRequestTypeDef:
    return {
        "MessageConfiguration": ...,
    }

Definition

class MessageRequestTypeDef(TypedDict):
    MessageConfiguration: DirectMessageConfigurationTypeDef,  # (3)
    Addresses: NotRequired[Mapping[str, AddressConfigurationTypeDef]],  # (1)
    Context: NotRequired[Mapping[str, str]],
    Endpoints: NotRequired[Mapping[str, EndpointSendConfigurationTypeDef]],  # (2)
    TemplateConfiguration: NotRequired[TemplateConfigurationTypeDef],  # (4)
    TraceId: NotRequired[str],

1. See AddressConfigurationTypeDef
2. See EndpointSendConfigurationTypeDef
3. See DirectMessageConfigurationTypeDef
4. See TemplateConfigurationTypeDef

SendUsersMessageRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import SendUsersMessageRequestTypeDef

def get_value() -> SendUsersMessageRequestTypeDef:
    return {
        "MessageConfiguration": ...,
        "Users": ...,
    }

Definition

class SendUsersMessageRequestTypeDef(TypedDict):
    MessageConfiguration: DirectMessageConfigurationTypeDef,  # (1)
    Users: Mapping[str, EndpointSendConfigurationTypeDef],  # (3)
    Context: NotRequired[Mapping[str, str]],
    TemplateConfiguration: NotRequired[TemplateConfigurationTypeDef],  # (2)
    TraceId: NotRequired[str],

1. See DirectMessageConfigurationTypeDef
2. See TemplateConfigurationTypeDef
3. See EndpointSendConfigurationTypeDef

SegmentGroupListTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import SegmentGroupListTypeDef

def get_value() -> SegmentGroupListTypeDef:
    return {
        "Groups": ...,
    }

Definition

class SegmentGroupListTypeDef(TypedDict):
    Groups: NotRequired[Sequence[SegmentGroupTypeDef]],  # (1)
    Include: NotRequired[IncludeType],  # (2)

1. See SegmentGroupTypeDef
2. See IncludeType

ConditionTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import ConditionTypeDef

def get_value() -> ConditionTypeDef:
    return {
        "Conditions": ...,
    }

Definition

class ConditionTypeDef(TypedDict):
    Conditions: NotRequired[Sequence[SimpleConditionTypeDef]],  # (1)
    Operator: NotRequired[OperatorType],  # (2)

1. See SimpleConditionTypeDef
2. See OperatorType

MultiConditionalBranchTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import MultiConditionalBranchTypeDef

def get_value() -> MultiConditionalBranchTypeDef:
    return {
        "Condition": ...,
    }

Definition

class MultiConditionalBranchTypeDef(TypedDict):
    Condition: NotRequired[SimpleConditionTypeDef],  # (1)
    NextActivity: NotRequired[str],

1. See SimpleConditionTypeDef

TreatmentResourceTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import TreatmentResourceTypeDef

def get_value() -> TreatmentResourceTypeDef:
    return {
        "Id": ...,
        "SizePercent": ...,
    }

Definition

class TreatmentResourceTypeDef(TypedDict):
    Id: str,
    SizePercent: int,
    CustomDeliveryConfiguration: NotRequired[CustomDeliveryConfigurationTypeDef],  # (1)
    MessageConfiguration: NotRequired[MessageConfigurationTypeDef],  # (2)
    Schedule: NotRequired[ScheduleTypeDef],  # (3)
    State: NotRequired[CampaignStateTypeDef],  # (4)
    TemplateConfiguration: NotRequired[TemplateConfigurationTypeDef],  # (5)
    TreatmentDescription: NotRequired[str],
    TreatmentName: NotRequired[str],

1. See CustomDeliveryConfigurationTypeDef
2. See MessageConfigurationTypeDef
3. See ScheduleTypeDef
4. See CampaignStateTypeDef
5. See TemplateConfigurationTypeDef

WriteTreatmentResourceTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import WriteTreatmentResourceTypeDef

def get_value() -> WriteTreatmentResourceTypeDef:
    return {
        "SizePercent": ...,
    }

Definition

class WriteTreatmentResourceTypeDef(TypedDict):
    SizePercent: int,
    CustomDeliveryConfiguration: NotRequired[CustomDeliveryConfigurationTypeDef],  # (1)
    MessageConfiguration: NotRequired[MessageConfigurationTypeDef],  # (2)
    Schedule: NotRequired[ScheduleTypeDef],  # (3)
    TemplateConfiguration: NotRequired[TemplateConfigurationTypeDef],  # (4)
    TreatmentDescription: NotRequired[str],
    TreatmentName: NotRequired[str],

1. See CustomDeliveryConfigurationTypeDef
2. See MessageConfigurationTypeDef
3. See ScheduleTypeDef
4. See TemplateConfigurationTypeDef

InAppMessagesResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import InAppMessagesResponseTypeDef

def get_value() -> InAppMessagesResponseTypeDef:
    return {
        "InAppMessageCampaigns": ...,
    }

Definition

class InAppMessagesResponseTypeDef(TypedDict):
    InAppMessageCampaigns: NotRequired[List[InAppMessageCampaignTypeDef]],  # (1)

1. See InAppMessageCampaignTypeDef

SendMessagesRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import SendMessagesRequestRequestTypeDef

def get_value() -> SendMessagesRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "MessageRequest": ...,
    }

Definition

class SendMessagesRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    MessageRequest: MessageRequestTypeDef,  # (1)

1. See MessageRequestTypeDef

SendUsersMessagesRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import SendUsersMessagesRequestRequestTypeDef

def get_value() -> SendUsersMessagesRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "SendUsersMessageRequest": ...,
    }

Definition

class SendUsersMessagesRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    SendUsersMessageRequest: SendUsersMessageRequestTypeDef,  # (1)

1. See SendUsersMessageRequestTypeDef

SegmentResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import SegmentResponseTypeDef

def get_value() -> SegmentResponseTypeDef:
    return {
        "ApplicationId": ...,
        "Arn": ...,
        "CreationDate": ...,
        "Id": ...,
        "SegmentType": ...,
    }

Definition

class SegmentResponseTypeDef(TypedDict):
    ApplicationId: str,
    Arn: str,
    CreationDate: str,
    Id: str,
    SegmentType: SegmentTypeType,  # (4)
    Dimensions: NotRequired[SegmentDimensionsTypeDef],  # (1)
    ImportDefinition: NotRequired[SegmentImportResourceTypeDef],  # (2)
    LastModifiedDate: NotRequired[str],
    Name: NotRequired[str],
    SegmentGroups: NotRequired[SegmentGroupListTypeDef],  # (3)
    tags: NotRequired[Dict[str, str]],
    Version: NotRequired[int],

1. See SegmentDimensionsTypeDef
2. See SegmentImportResourceTypeDef
3. See SegmentGroupListTypeDef
4. See SegmentTypeType

WriteSegmentRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import WriteSegmentRequestTypeDef

def get_value() -> WriteSegmentRequestTypeDef:
    return {
        "Dimensions": ...,
    }

Definition

class WriteSegmentRequestTypeDef(TypedDict):
    Dimensions: NotRequired[SegmentDimensionsTypeDef],  # (1)
    Name: NotRequired[str],
    SegmentGroups: NotRequired[SegmentGroupListTypeDef],  # (2)
    tags: NotRequired[Mapping[str, str]],

1. See SegmentDimensionsTypeDef
2. See SegmentGroupListTypeDef

ConditionalSplitActivityTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import ConditionalSplitActivityTypeDef

def get_value() -> ConditionalSplitActivityTypeDef:
    return {
        "Condition": ...,
    }

Definition

class ConditionalSplitActivityTypeDef(TypedDict):
    Condition: NotRequired[ConditionTypeDef],  # (1)
    EvaluationWaitTime: NotRequired[WaitTimeTypeDef],  # (2)
    FalseActivity: NotRequired[str],
    TrueActivity: NotRequired[str],

1. See ConditionTypeDef
2. See WaitTimeTypeDef

MultiConditionalSplitActivityTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import MultiConditionalSplitActivityTypeDef

def get_value() -> MultiConditionalSplitActivityTypeDef:
    return {
        "Branches": ...,
    }

Definition

class MultiConditionalSplitActivityTypeDef(TypedDict):
    Branches: NotRequired[Sequence[MultiConditionalBranchTypeDef]],  # (1)
    DefaultActivity: NotRequired[str],
    EvaluationWaitTime: NotRequired[WaitTimeTypeDef],  # (2)

1. See MultiConditionalBranchTypeDef
2. See WaitTimeTypeDef

CampaignResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import CampaignResponseTypeDef

def get_value() -> CampaignResponseTypeDef:
    return {
        "ApplicationId": ...,
        "Arn": ...,
        "CreationDate": ...,
        "Id": ...,
        "LastModifiedDate": ...,
        "SegmentId": ...,
        "SegmentVersion": ...,
    }

Definition

class CampaignResponseTypeDef(TypedDict):
    ApplicationId: str,
    Arn: str,
    CreationDate: str,
    Id: str,
    LastModifiedDate: str,
    SegmentId: str,
    SegmentVersion: int,
    AdditionalTreatments: NotRequired[List[TreatmentResourceTypeDef]],  # (1)
    CustomDeliveryConfiguration: NotRequired[CustomDeliveryConfigurationTypeDef],  # (2)
    DefaultState: NotRequired[CampaignStateTypeDef],  # (3)
    Description: NotRequired[str],
    HoldoutPercent: NotRequired[int],
    Hook: NotRequired[CampaignHookTypeDef],  # (4)
    IsPaused: NotRequired[bool],
    Limits: NotRequired[CampaignLimitsTypeDef],  # (5)
    MessageConfiguration: NotRequired[MessageConfigurationTypeDef],  # (6)
    Name: NotRequired[str],
    Schedule: NotRequired[ScheduleTypeDef],  # (7)
    State: NotRequired[CampaignStateTypeDef],  # (3)
    tags: NotRequired[Dict[str, str]],
    TemplateConfiguration: NotRequired[TemplateConfigurationTypeDef],  # (9)
    TreatmentDescription: NotRequired[str],
    TreatmentName: NotRequired[str],
    Version: NotRequired[int],
    Priority: NotRequired[int],

1. See TreatmentResourceTypeDef
2. See CustomDeliveryConfigurationTypeDef
3. See CampaignStateTypeDef
4. See CampaignHookTypeDef
5. See CampaignLimitsTypeDef
6. See MessageConfigurationTypeDef
7. See ScheduleTypeDef
8. See CampaignStateTypeDef
9. See TemplateConfigurationTypeDef

WriteCampaignRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import WriteCampaignRequestTypeDef

def get_value() -> WriteCampaignRequestTypeDef:
    return {
        "AdditionalTreatments": ...,
    }

Definition

class WriteCampaignRequestTypeDef(TypedDict):
    AdditionalTreatments: NotRequired[Sequence[WriteTreatmentResourceTypeDef]],  # (1)
    CustomDeliveryConfiguration: NotRequired[CustomDeliveryConfigurationTypeDef],  # (2)
    Description: NotRequired[str],
    HoldoutPercent: NotRequired[int],
    Hook: NotRequired[CampaignHookTypeDef],  # (3)
    IsPaused: NotRequired[bool],
    Limits: NotRequired[CampaignLimitsTypeDef],  # (4)
    MessageConfiguration: NotRequired[MessageConfigurationTypeDef],  # (5)
    Name: NotRequired[str],
    Schedule: NotRequired[ScheduleTypeDef],  # (6)
    SegmentId: NotRequired[str],
    SegmentVersion: NotRequired[int],
    tags: NotRequired[Mapping[str, str]],
    TemplateConfiguration: NotRequired[TemplateConfigurationTypeDef],  # (7)
    TreatmentDescription: NotRequired[str],
    TreatmentName: NotRequired[str],
    Priority: NotRequired[int],

1. See WriteTreatmentResourceTypeDef
2. See CustomDeliveryConfigurationTypeDef
3. See CampaignHookTypeDef
4. See CampaignLimitsTypeDef
5. See MessageConfigurationTypeDef
6. See ScheduleTypeDef
7. See TemplateConfigurationTypeDef

GetInAppMessagesResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetInAppMessagesResponseTypeDef

def get_value() -> GetInAppMessagesResponseTypeDef:
    return {
        "InAppMessagesResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetInAppMessagesResponseTypeDef(TypedDict):
    InAppMessagesResponse: InAppMessagesResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See InAppMessagesResponseTypeDef
2. See ResponseMetadataTypeDef

CreateSegmentResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import CreateSegmentResponseTypeDef

def get_value() -> CreateSegmentResponseTypeDef:
    return {
        "SegmentResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class CreateSegmentResponseTypeDef(TypedDict):
    SegmentResponse: SegmentResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See SegmentResponseTypeDef
2. See ResponseMetadataTypeDef

DeleteSegmentResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import DeleteSegmentResponseTypeDef

def get_value() -> DeleteSegmentResponseTypeDef:
    return {
        "SegmentResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class DeleteSegmentResponseTypeDef(TypedDict):
    SegmentResponse: SegmentResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See SegmentResponseTypeDef
2. See ResponseMetadataTypeDef

GetSegmentResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetSegmentResponseTypeDef

def get_value() -> GetSegmentResponseTypeDef:
    return {
        "SegmentResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetSegmentResponseTypeDef(TypedDict):
    SegmentResponse: SegmentResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See SegmentResponseTypeDef
2. See ResponseMetadataTypeDef

GetSegmentVersionResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetSegmentVersionResponseTypeDef

def get_value() -> GetSegmentVersionResponseTypeDef:
    return {
        "SegmentResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetSegmentVersionResponseTypeDef(TypedDict):
    SegmentResponse: SegmentResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See SegmentResponseTypeDef
2. See ResponseMetadataTypeDef

SegmentsResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import SegmentsResponseTypeDef

def get_value() -> SegmentsResponseTypeDef:
    return {
        "Item": ...,
    }

Definition

class SegmentsResponseTypeDef(TypedDict):
    Item: List[SegmentResponseTypeDef],  # (1)
    NextToken: NotRequired[str],

1. See SegmentResponseTypeDef

UpdateSegmentResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateSegmentResponseTypeDef

def get_value() -> UpdateSegmentResponseTypeDef:
    return {
        "SegmentResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class UpdateSegmentResponseTypeDef(TypedDict):
    SegmentResponse: SegmentResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See SegmentResponseTypeDef
2. See ResponseMetadataTypeDef

CreateSegmentRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import CreateSegmentRequestRequestTypeDef

def get_value() -> CreateSegmentRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "WriteSegmentRequest": ...,
    }

Definition

class CreateSegmentRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    WriteSegmentRequest: WriteSegmentRequestTypeDef,  # (1)

1. See WriteSegmentRequestTypeDef

UpdateSegmentRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateSegmentRequestRequestTypeDef

def get_value() -> UpdateSegmentRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "SegmentId": ...,
        "WriteSegmentRequest": ...,
    }

Definition

class UpdateSegmentRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    SegmentId: str,
    WriteSegmentRequest: WriteSegmentRequestTypeDef,  # (1)

1. See WriteSegmentRequestTypeDef

ActivityTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import ActivityTypeDef

def get_value() -> ActivityTypeDef:
    return {
        "CUSTOM": ...,
    }

Definition

class ActivityTypeDef(TypedDict):
    CUSTOM: NotRequired[CustomMessageActivityTypeDef],  # (1)
    ConditionalSplit: NotRequired[ConditionalSplitActivityTypeDef],  # (2)
    Description: NotRequired[str],
    EMAIL: NotRequired[EmailMessageActivityTypeDef],  # (3)
    Holdout: NotRequired[HoldoutActivityTypeDef],  # (4)
    MultiCondition: NotRequired[MultiConditionalSplitActivityTypeDef],  # (5)
    PUSH: NotRequired[PushMessageActivityTypeDef],  # (6)
    RandomSplit: NotRequired[RandomSplitActivityTypeDef],  # (7)
    SMS: NotRequired[SMSMessageActivityTypeDef],  # (8)
    Wait: NotRequired[WaitActivityTypeDef],  # (9)
    ContactCenter: NotRequired[ContactCenterActivityTypeDef],  # (10)

1. See CustomMessageActivityTypeDef
2. See ConditionalSplitActivityTypeDef
3. See EmailMessageActivityTypeDef
4. See HoldoutActivityTypeDef
5. See MultiConditionalSplitActivityTypeDef
6. See PushMessageActivityTypeDef
7. See RandomSplitActivityTypeDef
8. See SMSMessageActivityTypeDef
9. See WaitActivityTypeDef
10. See ContactCenterActivityTypeDef

CampaignsResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import CampaignsResponseTypeDef

def get_value() -> CampaignsResponseTypeDef:
    return {
        "Item": ...,
    }

Definition

class CampaignsResponseTypeDef(TypedDict):
    Item: List[CampaignResponseTypeDef],  # (1)
    NextToken: NotRequired[str],

1. See CampaignResponseTypeDef

CreateCampaignResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import CreateCampaignResponseTypeDef

def get_value() -> CreateCampaignResponseTypeDef:
    return {
        "CampaignResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class CreateCampaignResponseTypeDef(TypedDict):
    CampaignResponse: CampaignResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See CampaignResponseTypeDef
2. See ResponseMetadataTypeDef

DeleteCampaignResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import DeleteCampaignResponseTypeDef

def get_value() -> DeleteCampaignResponseTypeDef:
    return {
        "CampaignResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class DeleteCampaignResponseTypeDef(TypedDict):
    CampaignResponse: CampaignResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See CampaignResponseTypeDef
2. See ResponseMetadataTypeDef

GetCampaignResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetCampaignResponseTypeDef

def get_value() -> GetCampaignResponseTypeDef:
    return {
        "CampaignResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetCampaignResponseTypeDef(TypedDict):
    CampaignResponse: CampaignResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See CampaignResponseTypeDef
2. See ResponseMetadataTypeDef

GetCampaignVersionResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetCampaignVersionResponseTypeDef

def get_value() -> GetCampaignVersionResponseTypeDef:
    return {
        "CampaignResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetCampaignVersionResponseTypeDef(TypedDict):
    CampaignResponse: CampaignResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See CampaignResponseTypeDef
2. See ResponseMetadataTypeDef

UpdateCampaignResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateCampaignResponseTypeDef

def get_value() -> UpdateCampaignResponseTypeDef:
    return {
        "CampaignResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class UpdateCampaignResponseTypeDef(TypedDict):
    CampaignResponse: CampaignResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See CampaignResponseTypeDef
2. See ResponseMetadataTypeDef

CreateCampaignRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import CreateCampaignRequestRequestTypeDef

def get_value() -> CreateCampaignRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "WriteCampaignRequest": ...,
    }

Definition

class CreateCampaignRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    WriteCampaignRequest: WriteCampaignRequestTypeDef,  # (1)

1. See WriteCampaignRequestTypeDef

UpdateCampaignRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateCampaignRequestRequestTypeDef

def get_value() -> UpdateCampaignRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "CampaignId": ...,
        "WriteCampaignRequest": ...,
    }

Definition

class UpdateCampaignRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    CampaignId: str,
    WriteCampaignRequest: WriteCampaignRequestTypeDef,  # (1)

1. See WriteCampaignRequestTypeDef

GetSegmentVersionsResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetSegmentVersionsResponseTypeDef

def get_value() -> GetSegmentVersionsResponseTypeDef:
    return {
        "SegmentsResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetSegmentVersionsResponseTypeDef(TypedDict):
    SegmentsResponse: SegmentsResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See SegmentsResponseTypeDef
2. See ResponseMetadataTypeDef

GetSegmentsResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetSegmentsResponseTypeDef

def get_value() -> GetSegmentsResponseTypeDef:
    return {
        "SegmentsResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetSegmentsResponseTypeDef(TypedDict):
    SegmentsResponse: SegmentsResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See SegmentsResponseTypeDef
2. See ResponseMetadataTypeDef

JourneyResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import JourneyResponseTypeDef

def get_value() -> JourneyResponseTypeDef:
    return {
        "ApplicationId": ...,
        "Id": ...,
        "Name": ...,
    }

Definition

class JourneyResponseTypeDef(TypedDict):
    ApplicationId: str,
    Id: str,
    Name: str,
    Activities: NotRequired[Dict[str, ActivityTypeDef]],  # (1)
    CreationDate: NotRequired[str],
    LastModifiedDate: NotRequired[str],
    Limits: NotRequired[JourneyLimitsTypeDef],  # (2)
    LocalTime: NotRequired[bool],
    QuietTime: NotRequired[QuietTimeTypeDef],  # (3)
    RefreshFrequency: NotRequired[str],
    Schedule: NotRequired[JourneyScheduleTypeDef],  # (4)
    StartActivity: NotRequired[str],
    StartCondition: NotRequired[StartConditionTypeDef],  # (5)
    State: NotRequired[StateType],  # (6)
    tags: NotRequired[Dict[str, str]],
    WaitForQuietTime: NotRequired[bool],
    RefreshOnSegmentUpdate: NotRequired[bool],
    JourneyChannelSettings: NotRequired[JourneyChannelSettingsTypeDef],  # (7)
    SendingSchedule: NotRequired[bool],
    OpenHours: NotRequired[OpenHoursTypeDef],  # (8)
    ClosedDays: NotRequired[ClosedDaysTypeDef],  # (9)

1. See ActivityTypeDef
2. See JourneyLimitsTypeDef
3. See QuietTimeTypeDef
4. See JourneyScheduleTypeDef
5. See StartConditionTypeDef
6. See StateType
7. See JourneyChannelSettingsTypeDef
8. See OpenHoursTypeDef
9. See ClosedDaysTypeDef

WriteJourneyRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import WriteJourneyRequestTypeDef

def get_value() -> WriteJourneyRequestTypeDef:
    return {
        "Name": ...,
    }

Definition

class WriteJourneyRequestTypeDef(TypedDict):
    Name: str,
    Activities: NotRequired[Mapping[str, ActivityTypeDef]],  # (1)
    CreationDate: NotRequired[str],
    LastModifiedDate: NotRequired[str],
    Limits: NotRequired[JourneyLimitsTypeDef],  # (2)
    LocalTime: NotRequired[bool],
    QuietTime: NotRequired[QuietTimeTypeDef],  # (3)
    RefreshFrequency: NotRequired[str],
    Schedule: NotRequired[JourneyScheduleTypeDef],  # (4)
    StartActivity: NotRequired[str],
    StartCondition: NotRequired[StartConditionTypeDef],  # (5)
    State: NotRequired[StateType],  # (6)
    WaitForQuietTime: NotRequired[bool],
    RefreshOnSegmentUpdate: NotRequired[bool],
    JourneyChannelSettings: NotRequired[JourneyChannelSettingsTypeDef],  # (7)
    SendingSchedule: NotRequired[bool],
    OpenHours: NotRequired[OpenHoursTypeDef],  # (8)
    ClosedDays: NotRequired[ClosedDaysTypeDef],  # (9)

1. See ActivityTypeDef
2. See JourneyLimitsTypeDef
3. See QuietTimeTypeDef
4. See JourneyScheduleTypeDef
5. See StartConditionTypeDef
6. See StateType
7. See JourneyChannelSettingsTypeDef
8. See OpenHoursTypeDef
9. See ClosedDaysTypeDef

GetCampaignVersionsResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetCampaignVersionsResponseTypeDef

def get_value() -> GetCampaignVersionsResponseTypeDef:
    return {
        "CampaignsResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetCampaignVersionsResponseTypeDef(TypedDict):
    CampaignsResponse: CampaignsResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See CampaignsResponseTypeDef
2. See ResponseMetadataTypeDef

GetCampaignsResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetCampaignsResponseTypeDef

def get_value() -> GetCampaignsResponseTypeDef:
    return {
        "CampaignsResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetCampaignsResponseTypeDef(TypedDict):
    CampaignsResponse: CampaignsResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See CampaignsResponseTypeDef
2. See ResponseMetadataTypeDef

CreateJourneyResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import CreateJourneyResponseTypeDef

def get_value() -> CreateJourneyResponseTypeDef:
    return {
        "JourneyResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class CreateJourneyResponseTypeDef(TypedDict):
    JourneyResponse: JourneyResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See JourneyResponseTypeDef
2. See ResponseMetadataTypeDef

DeleteJourneyResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import DeleteJourneyResponseTypeDef

def get_value() -> DeleteJourneyResponseTypeDef:
    return {
        "JourneyResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class DeleteJourneyResponseTypeDef(TypedDict):
    JourneyResponse: JourneyResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See JourneyResponseTypeDef
2. See ResponseMetadataTypeDef

GetJourneyResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import GetJourneyResponseTypeDef

def get_value() -> GetJourneyResponseTypeDef:
    return {
        "JourneyResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetJourneyResponseTypeDef(TypedDict):
    JourneyResponse: JourneyResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See JourneyResponseTypeDef
2. See ResponseMetadataTypeDef

JourneysResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import JourneysResponseTypeDef

def get_value() -> JourneysResponseTypeDef:
    return {
        "Item": ...,
    }

Definition

class JourneysResponseTypeDef(TypedDict):
    Item: List[JourneyResponseTypeDef],  # (1)
    NextToken: NotRequired[str],

1. See JourneyResponseTypeDef

UpdateJourneyResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateJourneyResponseTypeDef

def get_value() -> UpdateJourneyResponseTypeDef:
    return {
        "JourneyResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class UpdateJourneyResponseTypeDef(TypedDict):
    JourneyResponse: JourneyResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See JourneyResponseTypeDef
2. See ResponseMetadataTypeDef

UpdateJourneyStateResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateJourneyStateResponseTypeDef

def get_value() -> UpdateJourneyStateResponseTypeDef:
    return {
        "JourneyResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class UpdateJourneyStateResponseTypeDef(TypedDict):
    JourneyResponse: JourneyResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See JourneyResponseTypeDef
2. See ResponseMetadataTypeDef

CreateJourneyRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import CreateJourneyRequestRequestTypeDef

def get_value() -> CreateJourneyRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "WriteJourneyRequest": ...,
    }

Definition

class CreateJourneyRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    WriteJourneyRequest: WriteJourneyRequestTypeDef,  # (1)

1. See WriteJourneyRequestTypeDef

UpdateJourneyRequestRequestTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import UpdateJourneyRequestRequestTypeDef

def get_value() -> UpdateJourneyRequestRequestTypeDef:
    return {
        "ApplicationId": ...,
        "JourneyId": ...,
        "WriteJourneyRequest": ...,
    }

Definition

class UpdateJourneyRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    JourneyId: str,
    WriteJourneyRequest: WriteJourneyRequestTypeDef,  # (1)

1. See WriteJourneyRequestTypeDef

ListJourneysResponseTypeDef

Usage Example

from mypy_boto3_pinpoint.type_defs import ListJourneysResponseTypeDef

def get_value() -> ListJourneysResponseTypeDef:
    return {
        "JourneysResponse": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListJourneysResponseTypeDef(TypedDict):
    JourneysResponse: JourneysResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See JourneysResponseTypeDef
2. See ResponseMetadataTypeDef