Skip to content

Type definitions#

Index > Pinpoint > Type definitions

Auto-generated documentation for Pinpoint type annotations stubs module mypy-boto3-pinpoint.

BlobTypeDef#

# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    StreamingBody,
]

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

AttributeDimensionUnionTypeDef#

# AttributeDimensionUnionTypeDef definition

AttributeDimensionUnionTypeDef = Union[
    AttributeDimensionTypeDef,  # (1)
    AttributeDimensionOutputTypeDef,  # (2)
]
  1. See AttributeDimensionTypeDef
  2. See AttributeDimensionOutputTypeDef

CustomDeliveryConfigurationUnionTypeDef#

# CustomDeliveryConfigurationUnionTypeDef definition

CustomDeliveryConfigurationUnionTypeDef = Union[
    CustomDeliveryConfigurationTypeDef,  # (1)
    CustomDeliveryConfigurationOutputTypeDef,  # (2)
]
  1. See CustomDeliveryConfigurationTypeDef
  2. See CustomDeliveryConfigurationOutputTypeDef

EndpointUserUnionTypeDef#

# EndpointUserUnionTypeDef definition

EndpointUserUnionTypeDef = Union[
    EndpointUserTypeDef,  # (1)
    EndpointUserOutputTypeDef,  # (2)
]
  1. See EndpointUserTypeDef
  2. See EndpointUserOutputTypeDef

SetDimensionUnionTypeDef#

# SetDimensionUnionTypeDef definition

SetDimensionUnionTypeDef = Union[
    SetDimensionTypeDef,  # (1)
    SetDimensionOutputTypeDef,  # (2)
]
  1. See SetDimensionTypeDef
  2. See SetDimensionOutputTypeDef

CampaignEmailMessageUnionTypeDef#

# CampaignEmailMessageUnionTypeDef definition

CampaignEmailMessageUnionTypeDef = Union[
    CampaignEmailMessageTypeDef,  # (1)
    CampaignEmailMessageOutputTypeDef,  # (2)
]
  1. See CampaignEmailMessageTypeDef
  2. See CampaignEmailMessageOutputTypeDef

ClosedDaysUnionTypeDef#

# ClosedDaysUnionTypeDef definition

ClosedDaysUnionTypeDef = Union[
    ClosedDaysTypeDef,  # (1)
    ClosedDaysOutputTypeDef,  # (2)
]
  1. See ClosedDaysTypeDef
  2. See ClosedDaysOutputTypeDef

CustomMessageActivityUnionTypeDef#

# CustomMessageActivityUnionTypeDef definition

CustomMessageActivityUnionTypeDef = Union[
    CustomMessageActivityTypeDef,  # (1)
    CustomMessageActivityOutputTypeDef,  # (2)
]
  1. See CustomMessageActivityTypeDef
  2. See CustomMessageActivityOutputTypeDef

JourneyScheduleUnionTypeDef#

# JourneyScheduleUnionTypeDef definition

JourneyScheduleUnionTypeDef = Union[
    JourneyScheduleTypeDef,  # (1)
    JourneyScheduleOutputTypeDef,  # (2)
]
  1. See JourneyScheduleTypeDef
  2. See JourneyScheduleOutputTypeDef

OpenHoursUnionTypeDef#

# OpenHoursUnionTypeDef definition

OpenHoursUnionTypeDef = Union[
    OpenHoursTypeDef,  # (1)
    OpenHoursOutputTypeDef,  # (2)
]
  1. See OpenHoursTypeDef
  2. See OpenHoursOutputTypeDef

RandomSplitActivityUnionTypeDef#

# RandomSplitActivityUnionTypeDef definition

RandomSplitActivityUnionTypeDef = Union[
    RandomSplitActivityTypeDef,  # (1)
    RandomSplitActivityOutputTypeDef,  # (2)
]
  1. See RandomSplitActivityTypeDef
  2. See RandomSplitActivityOutputTypeDef

EventDimensionsUnionTypeDef#

# EventDimensionsUnionTypeDef definition

EventDimensionsUnionTypeDef = Union[
    EventDimensionsTypeDef,  # (1)
    EventDimensionsOutputTypeDef,  # (2)
]
  1. See EventDimensionsTypeDef
  2. See EventDimensionsOutputTypeDef

SegmentDemographicsUnionTypeDef#

# SegmentDemographicsUnionTypeDef definition

SegmentDemographicsUnionTypeDef = Union[
    SegmentDemographicsTypeDef,  # (1)
    SegmentDemographicsOutputTypeDef,  # (2)
]
  1. See SegmentDemographicsTypeDef
  2. See SegmentDemographicsOutputTypeDef

SegmentLocationUnionTypeDef#

# SegmentLocationUnionTypeDef definition

SegmentLocationUnionTypeDef = Union[
    SegmentLocationTypeDef,  # (1)
    SegmentLocationOutputTypeDef,  # (2)
]
  1. See SegmentLocationTypeDef
  2. See SegmentLocationOutputTypeDef

CampaignInAppMessageUnionTypeDef#

# CampaignInAppMessageUnionTypeDef definition

CampaignInAppMessageUnionTypeDef = Union[
    CampaignInAppMessageTypeDef,  # (1)
    CampaignInAppMessageOutputTypeDef,  # (2)
]
  1. See CampaignInAppMessageTypeDef
  2. See CampaignInAppMessageOutputTypeDef

CampaignEventFilterUnionTypeDef#

# CampaignEventFilterUnionTypeDef definition

CampaignEventFilterUnionTypeDef = Union[
    CampaignEventFilterTypeDef,  # (1)
    CampaignEventFilterOutputTypeDef,  # (2)
]
  1. See CampaignEventFilterTypeDef
  2. See CampaignEventFilterOutputTypeDef

EventConditionUnionTypeDef#

# EventConditionUnionTypeDef definition

EventConditionUnionTypeDef = Union[
    EventConditionTypeDef,  # (1)
    EventConditionOutputTypeDef,  # (2)
]
  1. See EventConditionTypeDef
  2. See EventConditionOutputTypeDef

EventFilterUnionTypeDef#

# EventFilterUnionTypeDef definition

EventFilterUnionTypeDef = Union[
    EventFilterTypeDef,  # (1)
    EventFilterOutputTypeDef,  # (2)
]
  1. See EventFilterTypeDef
  2. See EventFilterOutputTypeDef

SegmentDimensionsUnionTypeDef#

# SegmentDimensionsUnionTypeDef definition

SegmentDimensionsUnionTypeDef = Union[
    SegmentDimensionsTypeDef,  # (1)
    SegmentDimensionsOutputTypeDef,  # (2)
]
  1. See SegmentDimensionsTypeDef
  2. See SegmentDimensionsOutputTypeDef

MessageConfigurationUnionTypeDef#

# MessageConfigurationUnionTypeDef definition

MessageConfigurationUnionTypeDef = Union[
    MessageConfigurationTypeDef,  # (1)
    MessageConfigurationOutputTypeDef,  # (2)
]
  1. See MessageConfigurationTypeDef
  2. See MessageConfigurationOutputTypeDef

ScheduleUnionTypeDef#

# ScheduleUnionTypeDef definition

ScheduleUnionTypeDef = Union[
    ScheduleTypeDef,  # (1)
    ScheduleOutputTypeDef,  # (2)
]
  1. See ScheduleTypeDef
  2. See ScheduleOutputTypeDef

EventStartConditionUnionTypeDef#

# EventStartConditionUnionTypeDef definition

EventStartConditionUnionTypeDef = Union[
    EventStartConditionTypeDef,  # (1)
    EventStartConditionOutputTypeDef,  # (2)
]
  1. See EventStartConditionTypeDef
  2. See EventStartConditionOutputTypeDef

SegmentGroupUnionTypeDef#

# SegmentGroupUnionTypeDef definition

SegmentGroupUnionTypeDef = Union[
    SegmentGroupTypeDef,  # (1)
    SegmentGroupOutputTypeDef,  # (2)
]
  1. See SegmentGroupTypeDef
  2. See SegmentGroupOutputTypeDef

SimpleConditionUnionTypeDef#

# SimpleConditionUnionTypeDef definition

SimpleConditionUnionTypeDef = Union[
    SimpleConditionTypeDef,  # (1)
    SimpleConditionOutputTypeDef,  # (2)
]
  1. See SimpleConditionTypeDef
  2. See SimpleConditionOutputTypeDef

StartConditionUnionTypeDef#

# StartConditionUnionTypeDef definition

StartConditionUnionTypeDef = Union[
    StartConditionTypeDef,  # (1)
    StartConditionOutputTypeDef,  # (2)
]
  1. See StartConditionTypeDef
  2. See StartConditionOutputTypeDef

SegmentGroupListUnionTypeDef#

# SegmentGroupListUnionTypeDef definition

SegmentGroupListUnionTypeDef = Union[
    SegmentGroupListTypeDef,  # (1)
    SegmentGroupListOutputTypeDef,  # (2)
]
  1. See SegmentGroupListTypeDef
  2. See SegmentGroupListOutputTypeDef

ConditionUnionTypeDef#

# ConditionUnionTypeDef definition

ConditionUnionTypeDef = Union[
    ConditionTypeDef,  # (1)
    ConditionOutputTypeDef,  # (2)
]
  1. See ConditionTypeDef
  2. See ConditionOutputTypeDef

MultiConditionalBranchUnionTypeDef#

# MultiConditionalBranchUnionTypeDef definition

MultiConditionalBranchUnionTypeDef = Union[
    MultiConditionalBranchTypeDef,  # (1)
    MultiConditionalBranchOutputTypeDef,  # (2)
]
  1. See MultiConditionalBranchTypeDef
  2. See MultiConditionalBranchOutputTypeDef

ConditionalSplitActivityUnionTypeDef#

# ConditionalSplitActivityUnionTypeDef definition

ConditionalSplitActivityUnionTypeDef = Union[
    ConditionalSplitActivityTypeDef,  # (1)
    ConditionalSplitActivityOutputTypeDef,  # (2)
]
  1. See ConditionalSplitActivityTypeDef
  2. See ConditionalSplitActivityOutputTypeDef

MultiConditionalSplitActivityUnionTypeDef#

# MultiConditionalSplitActivityUnionTypeDef definition

MultiConditionalSplitActivityUnionTypeDef = Union[
    MultiConditionalSplitActivityTypeDef,  # (1)
    MultiConditionalSplitActivityOutputTypeDef,  # (2)
]
  1. See MultiConditionalSplitActivityTypeDef
  2. See MultiConditionalSplitActivityOutputTypeDef

ActivityUnionTypeDef#

# ActivityUnionTypeDef definition

ActivityUnionTypeDef = Union[
    ActivityTypeDef,  # (1)
    ActivityOutputTypeDef,  # (2)
]
  1. See ActivityTypeDef
  2. See ActivityOutputTypeDef

ADMChannelRequestTypeDef#

# ADMChannelRequestTypeDef definition

class ADMChannelRequestTypeDef(TypedDict):
    ClientId: str,
    ClientSecret: str,
    Enabled: NotRequired[bool],

ADMChannelResponseTypeDef#

# ADMChannelResponseTypeDef definition

class ADMChannelResponseTypeDef(TypedDict):
    Platform: str,
    ApplicationId: NotRequired[str],
    CreationDate: NotRequired[str],
    Enabled: NotRequired[bool],
    HasCredential: NotRequired[bool],
    Id: NotRequired[str],
    IsArchived: NotRequired[bool],
    LastModifiedBy: NotRequired[str],
    LastModifiedDate: NotRequired[str],
    Version: NotRequired[int],

ADMMessageTypeDef#

# ADMMessageTypeDef 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#

# APNSChannelRequestTypeDef definition

class APNSChannelRequestTypeDef(TypedDict):
    BundleId: NotRequired[str],
    Certificate: NotRequired[str],
    DefaultAuthenticationMethod: NotRequired[str],
    Enabled: NotRequired[bool],
    PrivateKey: NotRequired[str],
    TeamId: NotRequired[str],
    TokenKey: NotRequired[str],
    TokenKeyId: NotRequired[str],

APNSChannelResponseTypeDef#

# APNSChannelResponseTypeDef definition

class APNSChannelResponseTypeDef(TypedDict):
    Platform: str,
    ApplicationId: NotRequired[str],
    CreationDate: NotRequired[str],
    DefaultAuthenticationMethod: NotRequired[str],
    Enabled: NotRequired[bool],
    HasCredential: NotRequired[bool],
    HasTokenKey: NotRequired[bool],
    Id: NotRequired[str],
    IsArchived: NotRequired[bool],
    LastModifiedBy: NotRequired[str],
    LastModifiedDate: NotRequired[str],
    Version: NotRequired[int],

APNSMessageTypeDef#

# APNSMessageTypeDef 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#

# APNSPushNotificationTemplateTypeDef definition

class APNSPushNotificationTemplateTypeDef(TypedDict):
    Action: NotRequired[ActionType],  # (1)
    Body: NotRequired[str],
    MediaUrl: NotRequired[str],
    RawContent: NotRequired[str],
    Sound: NotRequired[str],
    Title: NotRequired[str],
    Url: NotRequired[str],
  1. See ActionType

APNSSandboxChannelRequestTypeDef#

# APNSSandboxChannelRequestTypeDef definition

class APNSSandboxChannelRequestTypeDef(TypedDict):
    BundleId: NotRequired[str],
    Certificate: NotRequired[str],
    DefaultAuthenticationMethod: NotRequired[str],
    Enabled: NotRequired[bool],
    PrivateKey: NotRequired[str],
    TeamId: NotRequired[str],
    TokenKey: NotRequired[str],
    TokenKeyId: NotRequired[str],

APNSSandboxChannelResponseTypeDef#

# APNSSandboxChannelResponseTypeDef definition

class APNSSandboxChannelResponseTypeDef(TypedDict):
    Platform: str,
    ApplicationId: NotRequired[str],
    CreationDate: NotRequired[str],
    DefaultAuthenticationMethod: NotRequired[str],
    Enabled: NotRequired[bool],
    HasCredential: NotRequired[bool],
    HasTokenKey: NotRequired[bool],
    Id: NotRequired[str],
    IsArchived: NotRequired[bool],
    LastModifiedBy: NotRequired[str],
    LastModifiedDate: NotRequired[str],
    Version: NotRequired[int],

APNSVoipChannelRequestTypeDef#

# APNSVoipChannelRequestTypeDef definition

class APNSVoipChannelRequestTypeDef(TypedDict):
    BundleId: NotRequired[str],
    Certificate: NotRequired[str],
    DefaultAuthenticationMethod: NotRequired[str],
    Enabled: NotRequired[bool],
    PrivateKey: NotRequired[str],
    TeamId: NotRequired[str],
    TokenKey: NotRequired[str],
    TokenKeyId: NotRequired[str],

APNSVoipChannelResponseTypeDef#

# APNSVoipChannelResponseTypeDef definition

class APNSVoipChannelResponseTypeDef(TypedDict):
    Platform: str,
    ApplicationId: NotRequired[str],
    CreationDate: NotRequired[str],
    DefaultAuthenticationMethod: NotRequired[str],
    Enabled: NotRequired[bool],
    HasCredential: NotRequired[bool],
    HasTokenKey: NotRequired[bool],
    Id: NotRequired[str],
    IsArchived: NotRequired[bool],
    LastModifiedBy: NotRequired[str],
    LastModifiedDate: NotRequired[str],
    Version: NotRequired[int],

APNSVoipSandboxChannelRequestTypeDef#

# APNSVoipSandboxChannelRequestTypeDef definition

class APNSVoipSandboxChannelRequestTypeDef(TypedDict):
    BundleId: NotRequired[str],
    Certificate: NotRequired[str],
    DefaultAuthenticationMethod: NotRequired[str],
    Enabled: NotRequired[bool],
    PrivateKey: NotRequired[str],
    TeamId: NotRequired[str],
    TokenKey: NotRequired[str],
    TokenKeyId: NotRequired[str],

APNSVoipSandboxChannelResponseTypeDef#

# APNSVoipSandboxChannelResponseTypeDef definition

class APNSVoipSandboxChannelResponseTypeDef(TypedDict):
    Platform: str,
    ApplicationId: NotRequired[str],
    CreationDate: NotRequired[str],
    DefaultAuthenticationMethod: NotRequired[str],
    Enabled: NotRequired[bool],
    HasCredential: NotRequired[bool],
    HasTokenKey: NotRequired[bool],
    Id: NotRequired[str],
    IsArchived: NotRequired[bool],
    LastModifiedBy: NotRequired[str],
    LastModifiedDate: NotRequired[str],
    Version: NotRequired[int],

ActivityResponseTypeDef#

# ActivityResponseTypeDef definition

class ActivityResponseTypeDef(TypedDict):
    ApplicationId: str,
    CampaignId: str,
    Id: str,
    End: NotRequired[str],
    Result: NotRequired[str],
    ScheduledStart: NotRequired[str],
    Start: NotRequired[str],
    State: NotRequired[str],
    SuccessfulEndpointCount: NotRequired[int],
    TimezonesCompletedCount: NotRequired[int],
    TimezonesTotalCount: NotRequired[int],
    TotalEndpointCount: NotRequired[int],
    TreatmentId: NotRequired[str],
    ExecutionMetrics: NotRequired[dict[str, str]],

ContactCenterActivityTypeDef#

# ContactCenterActivityTypeDef definition

class ContactCenterActivityTypeDef(TypedDict):
    NextActivity: NotRequired[str],

HoldoutActivityTypeDef#

# HoldoutActivityTypeDef definition

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

AddressConfigurationTypeDef#

# AddressConfigurationTypeDef definition

class AddressConfigurationTypeDef(TypedDict):
    BodyOverride: NotRequired[str],
    ChannelType: NotRequired[ChannelTypeType],  # (1)
    Context: NotRequired[Mapping[str, str]],
    RawContent: NotRequired[str],
    Substitutions: NotRequired[Mapping[str, Sequence[str]]],
    TitleOverride: NotRequired[str],
  1. See ChannelTypeType

AndroidPushNotificationTemplateTypeDef#

# AndroidPushNotificationTemplateTypeDef definition

class AndroidPushNotificationTemplateTypeDef(TypedDict):
    Action: NotRequired[ActionType],  # (1)
    Body: NotRequired[str],
    ImageIconUrl: NotRequired[str],
    ImageUrl: NotRequired[str],
    RawContent: NotRequired[str],
    SmallImageIconUrl: NotRequired[str],
    Sound: NotRequired[str],
    Title: NotRequired[str],
    Url: NotRequired[str],
  1. See ActionType

ApplicationResponseTypeDef#

# ApplicationResponseTypeDef definition

class ApplicationResponseTypeDef(TypedDict):
    Arn: str,
    Id: str,
    Name: str,
    tags: NotRequired[dict[str, str]],
    CreationDate: NotRequired[str],

JourneyTimeframeCapTypeDef#

# JourneyTimeframeCapTypeDef definition

class JourneyTimeframeCapTypeDef(TypedDict):
    Cap: NotRequired[int],
    Days: NotRequired[int],

CampaignHookTypeDef#

# CampaignHookTypeDef definition

class CampaignHookTypeDef(TypedDict):
    LambdaFunctionName: NotRequired[str],
    Mode: NotRequired[ModeType],  # (1)
    WebUrl: NotRequired[str],
  1. See ModeType

CampaignLimitsTypeDef#

# CampaignLimitsTypeDef definition

class CampaignLimitsTypeDef(TypedDict):
    Daily: NotRequired[int],
    MaximumDuration: NotRequired[int],
    MessagesPerSecond: NotRequired[int],
    Total: NotRequired[int],
    Session: NotRequired[int],

QuietTimeTypeDef#

# QuietTimeTypeDef definition

class QuietTimeTypeDef(TypedDict):
    End: NotRequired[str],
    Start: NotRequired[str],

AttributeDimensionOutputTypeDef#

# AttributeDimensionOutputTypeDef definition

class AttributeDimensionOutputTypeDef(TypedDict):
    Values: list[str],
    AttributeType: NotRequired[AttributeTypeType],  # (1)
  1. See AttributeTypeType

AttributeDimensionTypeDef#

# AttributeDimensionTypeDef definition

class AttributeDimensionTypeDef(TypedDict):
    Values: Sequence[str],
    AttributeType: NotRequired[AttributeTypeType],  # (1)
  1. See AttributeTypeType

AttributesResourceTypeDef#

# AttributesResourceTypeDef definition

class AttributesResourceTypeDef(TypedDict):
    ApplicationId: str,
    AttributeType: str,
    Attributes: NotRequired[list[str]],

BaiduChannelRequestTypeDef#

# BaiduChannelRequestTypeDef definition

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

BaiduChannelResponseTypeDef#

# BaiduChannelResponseTypeDef definition

class BaiduChannelResponseTypeDef(TypedDict):
    Credential: str,
    Platform: str,
    ApplicationId: NotRequired[str],
    CreationDate: NotRequired[str],
    Enabled: NotRequired[bool],
    HasCredential: NotRequired[bool],
    Id: NotRequired[str],
    IsArchived: NotRequired[bool],
    LastModifiedBy: NotRequired[str],
    LastModifiedDate: NotRequired[str],
    Version: NotRequired[int],

BaiduMessageTypeDef#

# BaiduMessageTypeDef 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#

# CampaignCustomMessageTypeDef definition

class CampaignCustomMessageTypeDef(TypedDict):
    Data: NotRequired[str],

MessageHeaderTypeDef#

# MessageHeaderTypeDef definition

class MessageHeaderTypeDef(TypedDict):
    Name: NotRequired[str],
    Value: NotRequired[str],

CampaignStateTypeDef#

# CampaignStateTypeDef definition

class CampaignStateTypeDef(TypedDict):
    CampaignStatus: NotRequired[CampaignStatusType],  # (1)
  1. See CampaignStatusType

CustomDeliveryConfigurationOutputTypeDef#

# CustomDeliveryConfigurationOutputTypeDef definition

class CustomDeliveryConfigurationOutputTypeDef(TypedDict):
    DeliveryUri: str,
    EndpointTypes: NotRequired[list[EndpointTypesElementType]],  # (1)
  1. See EndpointTypesElementType

CampaignSmsMessageTypeDef#

# CampaignSmsMessageTypeDef 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#

# ChannelResponseTypeDef definition

class ChannelResponseTypeDef(TypedDict):
    ApplicationId: NotRequired[str],
    CreationDate: NotRequired[str],
    Enabled: NotRequired[bool],
    HasCredential: NotRequired[bool],
    Id: NotRequired[str],
    IsArchived: NotRequired[bool],
    LastModifiedBy: NotRequired[str],
    LastModifiedDate: NotRequired[str],
    Version: NotRequired[int],

ClosedDaysRuleTypeDef#

# ClosedDaysRuleTypeDef definition

class ClosedDaysRuleTypeDef(TypedDict):
    Name: NotRequired[str],
    StartDateTime: NotRequired[str],
    EndDateTime: NotRequired[str],

WaitTimeTypeDef#

# WaitTimeTypeDef definition

class WaitTimeTypeDef(TypedDict):
    WaitFor: NotRequired[str],
    WaitUntil: NotRequired[str],

CreateApplicationRequestTypeDef#

# CreateApplicationRequestTypeDef definition

class CreateApplicationRequestTypeDef(TypedDict):
    Name: str,
    tags: NotRequired[Mapping[str, str]],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

CreateTemplateMessageBodyTypeDef#

# CreateTemplateMessageBodyTypeDef definition

class CreateTemplateMessageBodyTypeDef(TypedDict):
    Arn: NotRequired[str],
    Message: NotRequired[str],
    RequestID: NotRequired[str],

ExportJobRequestTypeDef#

# ExportJobRequestTypeDef definition

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

ImportJobRequestTypeDef#

# ImportJobRequestTypeDef definition

class ImportJobRequestTypeDef(TypedDict):
    Format: FormatType,  # (1)
    RoleArn: str,
    S3Url: str,
    DefineSegment: NotRequired[bool],
    ExternalId: NotRequired[str],
    RegisterEndpoints: NotRequired[bool],
    SegmentId: NotRequired[str],
    SegmentName: NotRequired[str],
  1. See FormatType

TemplateCreateMessageBodyTypeDef#

# TemplateCreateMessageBodyTypeDef definition

class TemplateCreateMessageBodyTypeDef(TypedDict):
    Arn: NotRequired[str],
    Message: NotRequired[str],
    RequestID: NotRequired[str],

CreateRecommenderConfigurationTypeDef#

# CreateRecommenderConfigurationTypeDef definition

class CreateRecommenderConfigurationTypeDef(TypedDict):
    RecommendationProviderRoleArn: str,
    RecommendationProviderUri: str,
    Attributes: NotRequired[Mapping[str, str]],
    Description: NotRequired[str],
    Name: NotRequired[str],
    RecommendationProviderIdType: NotRequired[str],
    RecommendationTransformerUri: NotRequired[str],
    RecommendationsDisplayName: NotRequired[str],
    RecommendationsPerMessage: NotRequired[int],

RecommenderConfigurationResponseTypeDef#

# RecommenderConfigurationResponseTypeDef definition

class RecommenderConfigurationResponseTypeDef(TypedDict):
    CreationDate: str,
    Id: str,
    LastModifiedDate: str,
    RecommendationProviderRoleArn: str,
    RecommendationProviderUri: str,
    Attributes: NotRequired[dict[str, str]],
    Description: NotRequired[str],
    Name: NotRequired[str],
    RecommendationProviderIdType: NotRequired[str],
    RecommendationTransformerUri: NotRequired[str],
    RecommendationsDisplayName: NotRequired[str],
    RecommendationsPerMessage: NotRequired[int],

SMSTemplateRequestTypeDef#

# SMSTemplateRequestTypeDef definition

class SMSTemplateRequestTypeDef(TypedDict):
    Body: NotRequired[str],
    DefaultSubstitutions: NotRequired[str],
    RecommenderId: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
    TemplateDescription: NotRequired[str],

VoiceTemplateRequestTypeDef#

# VoiceTemplateRequestTypeDef definition

class VoiceTemplateRequestTypeDef(TypedDict):
    Body: NotRequired[str],
    DefaultSubstitutions: NotRequired[str],
    LanguageCode: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
    TemplateDescription: NotRequired[str],
    VoiceId: NotRequired[str],

CustomDeliveryConfigurationTypeDef#

# CustomDeliveryConfigurationTypeDef definition

class CustomDeliveryConfigurationTypeDef(TypedDict):
    DeliveryUri: str,
    EndpointTypes: NotRequired[Sequence[EndpointTypesElementType]],  # (1)
  1. See EndpointTypesElementType

JourneyCustomMessageTypeDef#

# JourneyCustomMessageTypeDef definition

class JourneyCustomMessageTypeDef(TypedDict):
    Data: NotRequired[str],

DefaultButtonConfigurationTypeDef#

# DefaultButtonConfigurationTypeDef 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#

# DefaultMessageTypeDef definition

class DefaultMessageTypeDef(TypedDict):
    Body: NotRequired[str],
    Substitutions: NotRequired[Mapping[str, Sequence[str]]],

DefaultPushNotificationMessageTypeDef#

# DefaultPushNotificationMessageTypeDef definition

class DefaultPushNotificationMessageTypeDef(TypedDict):
    Action: NotRequired[ActionType],  # (1)
    Body: NotRequired[str],
    Data: NotRequired[Mapping[str, str]],
    SilentPush: NotRequired[bool],
    Substitutions: NotRequired[Mapping[str, Sequence[str]]],
    Title: NotRequired[str],
    Url: NotRequired[str],
  1. See ActionType

DefaultPushNotificationTemplateTypeDef#

# DefaultPushNotificationTemplateTypeDef definition

class DefaultPushNotificationTemplateTypeDef(TypedDict):
    Action: NotRequired[ActionType],  # (1)
    Body: NotRequired[str],
    Sound: NotRequired[str],
    Title: NotRequired[str],
    Url: NotRequired[str],
  1. See ActionType

DeleteAdmChannelRequestRequestTypeDef#

# DeleteAdmChannelRequestRequestTypeDef definition

class DeleteAdmChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

DeleteApnsChannelRequestRequestTypeDef#

# DeleteApnsChannelRequestRequestTypeDef definition

class DeleteApnsChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

DeleteApnsSandboxChannelRequestRequestTypeDef#

# DeleteApnsSandboxChannelRequestRequestTypeDef definition

class DeleteApnsSandboxChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

DeleteApnsVoipChannelRequestRequestTypeDef#

# DeleteApnsVoipChannelRequestRequestTypeDef definition

class DeleteApnsVoipChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

DeleteApnsVoipSandboxChannelRequestRequestTypeDef#

# DeleteApnsVoipSandboxChannelRequestRequestTypeDef definition

class DeleteApnsVoipSandboxChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

DeleteAppRequestRequestTypeDef#

# DeleteAppRequestRequestTypeDef definition

class DeleteAppRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

DeleteBaiduChannelRequestRequestTypeDef#

# DeleteBaiduChannelRequestRequestTypeDef definition

class DeleteBaiduChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

DeleteCampaignRequestRequestTypeDef#

# DeleteCampaignRequestRequestTypeDef definition

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

DeleteEmailChannelRequestRequestTypeDef#

# DeleteEmailChannelRequestRequestTypeDef definition

class DeleteEmailChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

EmailChannelResponseTypeDef#

# EmailChannelResponseTypeDef definition

class EmailChannelResponseTypeDef(TypedDict):
    Platform: str,
    ApplicationId: NotRequired[str],
    ConfigurationSet: NotRequired[str],
    CreationDate: NotRequired[str],
    Enabled: NotRequired[bool],
    FromAddress: NotRequired[str],
    HasCredential: NotRequired[bool],
    Id: NotRequired[str],
    Identity: NotRequired[str],
    IsArchived: NotRequired[bool],
    LastModifiedBy: NotRequired[str],
    LastModifiedDate: NotRequired[str],
    MessagesPerSecond: NotRequired[int],
    RoleArn: NotRequired[str],
    OrchestrationSendingRoleArn: NotRequired[str],
    Version: NotRequired[int],

DeleteEmailTemplateRequestRequestTypeDef#

# DeleteEmailTemplateRequestRequestTypeDef definition

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

MessageBodyTypeDef#

# MessageBodyTypeDef definition

class MessageBodyTypeDef(TypedDict):
    Message: NotRequired[str],
    RequestID: NotRequired[str],

DeleteEndpointRequestRequestTypeDef#

# DeleteEndpointRequestRequestTypeDef definition

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

DeleteEventStreamRequestRequestTypeDef#

# DeleteEventStreamRequestRequestTypeDef definition

class DeleteEventStreamRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

EventStreamTypeDef#

# EventStreamTypeDef definition

class EventStreamTypeDef(TypedDict):
    ApplicationId: str,
    DestinationStreamArn: str,
    RoleArn: str,
    ExternalId: NotRequired[str],
    LastModifiedDate: NotRequired[str],
    LastUpdatedBy: NotRequired[str],

DeleteGcmChannelRequestRequestTypeDef#

# DeleteGcmChannelRequestRequestTypeDef definition

class DeleteGcmChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

GCMChannelResponseTypeDef#

# GCMChannelResponseTypeDef definition

class GCMChannelResponseTypeDef(TypedDict):
    Platform: str,
    ApplicationId: NotRequired[str],
    CreationDate: NotRequired[str],
    Credential: NotRequired[str],
    DefaultAuthenticationMethod: NotRequired[str],
    Enabled: NotRequired[bool],
    HasCredential: NotRequired[bool],
    HasFcmServiceCredentials: NotRequired[bool],
    Id: NotRequired[str],
    IsArchived: NotRequired[bool],
    LastModifiedBy: NotRequired[str],
    LastModifiedDate: NotRequired[str],
    Version: NotRequired[int],

DeleteInAppTemplateRequestRequestTypeDef#

# DeleteInAppTemplateRequestRequestTypeDef definition

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

DeleteJourneyRequestRequestTypeDef#

# DeleteJourneyRequestRequestTypeDef definition

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

DeletePushTemplateRequestRequestTypeDef#

# DeletePushTemplateRequestRequestTypeDef definition

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

DeleteRecommenderConfigurationRequestRequestTypeDef#

# DeleteRecommenderConfigurationRequestRequestTypeDef definition

class DeleteRecommenderConfigurationRequestRequestTypeDef(TypedDict):
    RecommenderId: str,

DeleteSegmentRequestRequestTypeDef#

# DeleteSegmentRequestRequestTypeDef definition

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

DeleteSmsChannelRequestRequestTypeDef#

# DeleteSmsChannelRequestRequestTypeDef definition

class DeleteSmsChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

SMSChannelResponseTypeDef#

# SMSChannelResponseTypeDef definition

class SMSChannelResponseTypeDef(TypedDict):
    Platform: str,
    ApplicationId: NotRequired[str],
    CreationDate: NotRequired[str],
    Enabled: NotRequired[bool],
    HasCredential: NotRequired[bool],
    Id: NotRequired[str],
    IsArchived: NotRequired[bool],
    LastModifiedBy: NotRequired[str],
    LastModifiedDate: NotRequired[str],
    PromotionalMessagesPerSecond: NotRequired[int],
    SenderId: NotRequired[str],
    ShortCode: NotRequired[str],
    TransactionalMessagesPerSecond: NotRequired[int],
    Version: NotRequired[int],

DeleteSmsTemplateRequestRequestTypeDef#

# DeleteSmsTemplateRequestRequestTypeDef definition

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

DeleteUserEndpointsRequestRequestTypeDef#

# DeleteUserEndpointsRequestRequestTypeDef definition

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

DeleteVoiceChannelRequestRequestTypeDef#

# DeleteVoiceChannelRequestRequestTypeDef definition

class DeleteVoiceChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

VoiceChannelResponseTypeDef#

# VoiceChannelResponseTypeDef definition

class VoiceChannelResponseTypeDef(TypedDict):
    Platform: str,
    ApplicationId: NotRequired[str],
    CreationDate: NotRequired[str],
    Enabled: NotRequired[bool],
    HasCredential: NotRequired[bool],
    Id: NotRequired[str],
    IsArchived: NotRequired[bool],
    LastModifiedBy: NotRequired[str],
    LastModifiedDate: NotRequired[str],
    Version: NotRequired[int],

DeleteVoiceTemplateRequestRequestTypeDef#

# DeleteVoiceTemplateRequestRequestTypeDef definition

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

GCMMessageTypeDef#

# GCMMessageTypeDef definition

class GCMMessageTypeDef(TypedDict):
    Action: NotRequired[ActionType],  # (1)
    Body: NotRequired[str],
    CollapseKey: NotRequired[str],
    Data: NotRequired[Mapping[str, str]],
    IconReference: NotRequired[str],
    ImageIconUrl: NotRequired[str],
    ImageUrl: NotRequired[str],
    PreferredAuthenticationMethod: 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#

# SMSMessageTypeDef definition

class SMSMessageTypeDef(TypedDict):
    Body: NotRequired[str],
    Keyword: NotRequired[str],
    MediaUrl: NotRequired[str],
    MessageType: NotRequired[MessageTypeType],  # (1)
    OriginationNumber: NotRequired[str],
    SenderId: NotRequired[str],
    Substitutions: NotRequired[Mapping[str, Sequence[str]]],
    EntityId: NotRequired[str],
    TemplateId: NotRequired[str],
  1. See MessageTypeType

VoiceMessageTypeDef#

# VoiceMessageTypeDef definition

class VoiceMessageTypeDef(TypedDict):
    Body: NotRequired[str],
    LanguageCode: NotRequired[str],
    OriginationNumber: NotRequired[str],
    Substitutions: NotRequired[Mapping[str, Sequence[str]]],
    VoiceId: NotRequired[str],

EmailChannelRequestTypeDef#

# EmailChannelRequestTypeDef definition

class EmailChannelRequestTypeDef(TypedDict):
    FromAddress: str,
    Identity: str,
    ConfigurationSet: NotRequired[str],
    Enabled: NotRequired[bool],
    RoleArn: NotRequired[str],
    OrchestrationSendingRoleArn: NotRequired[str],

JourneyEmailMessageTypeDef#

# JourneyEmailMessageTypeDef definition

class JourneyEmailMessageTypeDef(TypedDict):
    FromAddress: NotRequired[str],

EndpointDemographicTypeDef#

# EndpointDemographicTypeDef definition

class EndpointDemographicTypeDef(TypedDict):
    AppVersion: NotRequired[str],
    Locale: NotRequired[str],
    Make: NotRequired[str],
    Model: NotRequired[str],
    ModelVersion: NotRequired[str],
    Platform: NotRequired[str],
    PlatformVersion: NotRequired[str],
    Timezone: NotRequired[str],

EndpointLocationTypeDef#

# EndpointLocationTypeDef definition

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

EndpointItemResponseTypeDef#

# EndpointItemResponseTypeDef definition

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

EndpointMessageResultTypeDef#

# EndpointMessageResultTypeDef definition

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

EndpointUserOutputTypeDef#

# EndpointUserOutputTypeDef definition

class EndpointUserOutputTypeDef(TypedDict):
    UserAttributes: NotRequired[dict[str, list[str]]],
    UserId: NotRequired[str],

EndpointSendConfigurationTypeDef#

# EndpointSendConfigurationTypeDef definition

class EndpointSendConfigurationTypeDef(TypedDict):
    BodyOverride: NotRequired[str],
    Context: NotRequired[Mapping[str, str]],
    RawContent: NotRequired[str],
    Substitutions: NotRequired[Mapping[str, Sequence[str]]],
    TitleOverride: NotRequired[str],

EndpointUserTypeDef#

# EndpointUserTypeDef definition

class EndpointUserTypeDef(TypedDict):
    UserAttributes: NotRequired[Mapping[str, Sequence[str]]],
    UserId: NotRequired[str],

MetricDimensionTypeDef#

# MetricDimensionTypeDef definition

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

SetDimensionOutputTypeDef#

# SetDimensionOutputTypeDef definition

class SetDimensionOutputTypeDef(TypedDict):
    Values: list[str],
    DimensionType: NotRequired[DimensionTypeType],  # (1)
  1. See DimensionTypeType

EventItemResponseTypeDef#

# EventItemResponseTypeDef definition

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

SessionTypeDef#

# SessionTypeDef definition

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

ExportJobResourceTypeDef#

# ExportJobResourceTypeDef definition

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

GCMChannelRequestTypeDef#

# GCMChannelRequestTypeDef definition

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

GPSCoordinatesTypeDef#

# GPSCoordinatesTypeDef definition

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

GetAdmChannelRequestRequestTypeDef#

# GetAdmChannelRequestRequestTypeDef definition

class GetAdmChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

GetApnsChannelRequestRequestTypeDef#

# GetApnsChannelRequestRequestTypeDef definition

class GetApnsChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

GetApnsSandboxChannelRequestRequestTypeDef#

# GetApnsSandboxChannelRequestRequestTypeDef definition

class GetApnsSandboxChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

GetApnsVoipChannelRequestRequestTypeDef#

# GetApnsVoipChannelRequestRequestTypeDef definition

class GetApnsVoipChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

GetApnsVoipSandboxChannelRequestRequestTypeDef#

# GetApnsVoipSandboxChannelRequestRequestTypeDef definition

class GetApnsVoipSandboxChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

GetAppRequestRequestTypeDef#

# GetAppRequestRequestTypeDef definition

class GetAppRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

GetApplicationSettingsRequestRequestTypeDef#

# GetApplicationSettingsRequestRequestTypeDef definition

class GetApplicationSettingsRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

GetAppsRequestRequestTypeDef#

# GetAppsRequestRequestTypeDef definition

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

GetBaiduChannelRequestRequestTypeDef#

# GetBaiduChannelRequestRequestTypeDef definition

class GetBaiduChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

GetCampaignActivitiesRequestRequestTypeDef#

# GetCampaignActivitiesRequestRequestTypeDef definition

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

GetCampaignRequestRequestTypeDef#

# GetCampaignRequestRequestTypeDef definition

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

GetCampaignVersionRequestRequestTypeDef#

# GetCampaignVersionRequestRequestTypeDef definition

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

GetCampaignVersionsRequestRequestTypeDef#

# GetCampaignVersionsRequestRequestTypeDef definition

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

GetCampaignsRequestRequestTypeDef#

# GetCampaignsRequestRequestTypeDef definition

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

GetChannelsRequestRequestTypeDef#

# GetChannelsRequestRequestTypeDef definition

class GetChannelsRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

GetEmailChannelRequestRequestTypeDef#

# GetEmailChannelRequestRequestTypeDef definition

class GetEmailChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

GetEmailTemplateRequestRequestTypeDef#

# GetEmailTemplateRequestRequestTypeDef definition

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

GetEndpointRequestRequestTypeDef#

# GetEndpointRequestRequestTypeDef definition

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

GetEventStreamRequestRequestTypeDef#

# GetEventStreamRequestRequestTypeDef definition

class GetEventStreamRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

GetExportJobRequestRequestTypeDef#

# GetExportJobRequestRequestTypeDef definition

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

GetExportJobsRequestRequestTypeDef#

# GetExportJobsRequestRequestTypeDef definition

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

GetGcmChannelRequestRequestTypeDef#

# GetGcmChannelRequestRequestTypeDef definition

class GetGcmChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

GetImportJobRequestRequestTypeDef#

# GetImportJobRequestRequestTypeDef definition

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

GetImportJobsRequestRequestTypeDef#

# GetImportJobsRequestRequestTypeDef definition

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

GetInAppMessagesRequestRequestTypeDef#

# GetInAppMessagesRequestRequestTypeDef definition

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

GetInAppTemplateRequestRequestTypeDef#

# GetInAppTemplateRequestRequestTypeDef definition

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

GetJourneyExecutionActivityMetricsRequestRequestTypeDef#

# GetJourneyExecutionActivityMetricsRequestRequestTypeDef definition

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

JourneyExecutionActivityMetricsResponseTypeDef#

# JourneyExecutionActivityMetricsResponseTypeDef definition

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

GetJourneyExecutionMetricsRequestRequestTypeDef#

# GetJourneyExecutionMetricsRequestRequestTypeDef definition

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

JourneyExecutionMetricsResponseTypeDef#

# JourneyExecutionMetricsResponseTypeDef definition

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

GetJourneyRequestRequestTypeDef#

# GetJourneyRequestRequestTypeDef definition

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

GetJourneyRunExecutionActivityMetricsRequestRequestTypeDef#

# GetJourneyRunExecutionActivityMetricsRequestRequestTypeDef definition

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

JourneyRunExecutionActivityMetricsResponseTypeDef#

# JourneyRunExecutionActivityMetricsResponseTypeDef definition

class JourneyRunExecutionActivityMetricsResponseTypeDef(TypedDict):
    ActivityType: str,
    ApplicationId: str,
    JourneyActivityId: str,
    JourneyId: str,
    LastEvaluatedTime: str,
    Metrics: dict[str, str],
    RunId: str,

GetJourneyRunExecutionMetricsRequestRequestTypeDef#

# GetJourneyRunExecutionMetricsRequestRequestTypeDef definition

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

JourneyRunExecutionMetricsResponseTypeDef#

# JourneyRunExecutionMetricsResponseTypeDef definition

class JourneyRunExecutionMetricsResponseTypeDef(TypedDict):
    ApplicationId: str,
    JourneyId: str,
    LastEvaluatedTime: str,
    Metrics: dict[str, str],
    RunId: str,

GetJourneyRunsRequestRequestTypeDef#

# GetJourneyRunsRequestRequestTypeDef definition

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

GetPushTemplateRequestRequestTypeDef#

# GetPushTemplateRequestRequestTypeDef definition

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

GetRecommenderConfigurationRequestRequestTypeDef#

# GetRecommenderConfigurationRequestRequestTypeDef definition

class GetRecommenderConfigurationRequestRequestTypeDef(TypedDict):
    RecommenderId: str,

GetRecommenderConfigurationsRequestRequestTypeDef#

# GetRecommenderConfigurationsRequestRequestTypeDef definition

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

GetSegmentExportJobsRequestRequestTypeDef#

# GetSegmentExportJobsRequestRequestTypeDef definition

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

GetSegmentImportJobsRequestRequestTypeDef#

# GetSegmentImportJobsRequestRequestTypeDef definition

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

GetSegmentRequestRequestTypeDef#

# GetSegmentRequestRequestTypeDef definition

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

GetSegmentVersionRequestRequestTypeDef#

# GetSegmentVersionRequestRequestTypeDef definition

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

GetSegmentVersionsRequestRequestTypeDef#

# GetSegmentVersionsRequestRequestTypeDef definition

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

GetSegmentsRequestRequestTypeDef#

# GetSegmentsRequestRequestTypeDef definition

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

GetSmsChannelRequestRequestTypeDef#

# GetSmsChannelRequestRequestTypeDef definition

class GetSmsChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

GetSmsTemplateRequestRequestTypeDef#

# GetSmsTemplateRequestRequestTypeDef definition

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

SMSTemplateResponseTypeDef#

# SMSTemplateResponseTypeDef definition

class SMSTemplateResponseTypeDef(TypedDict):
    CreationDate: str,
    LastModifiedDate: str,
    TemplateName: str,
    TemplateType: TemplateTypeType,  # (1)
    Arn: NotRequired[str],
    Body: NotRequired[str],
    DefaultSubstitutions: NotRequired[str],
    RecommenderId: NotRequired[str],
    tags: NotRequired[dict[str, str]],
    TemplateDescription: NotRequired[str],
    Version: NotRequired[str],
  1. See TemplateTypeType

GetUserEndpointsRequestRequestTypeDef#

# GetUserEndpointsRequestRequestTypeDef definition

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

GetVoiceChannelRequestRequestTypeDef#

# GetVoiceChannelRequestRequestTypeDef definition

class GetVoiceChannelRequestRequestTypeDef(TypedDict):
    ApplicationId: str,

GetVoiceTemplateRequestRequestTypeDef#

# GetVoiceTemplateRequestRequestTypeDef definition

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

VoiceTemplateResponseTypeDef#

# VoiceTemplateResponseTypeDef definition

class VoiceTemplateResponseTypeDef(TypedDict):
    CreationDate: str,
    LastModifiedDate: str,
    TemplateName: str,
    TemplateType: TemplateTypeType,  # (1)
    Arn: NotRequired[str],
    Body: NotRequired[str],
    DefaultSubstitutions: NotRequired[str],
    LanguageCode: NotRequired[str],
    tags: NotRequired[dict[str, str]],
    TemplateDescription: NotRequired[str],
    Version: NotRequired[str],
    VoiceId: NotRequired[str],
  1. See TemplateTypeType

ImportJobResourceTypeDef#

# ImportJobResourceTypeDef definition

class ImportJobResourceTypeDef(TypedDict):
    Format: FormatType,  # (1)
    RoleArn: str,
    S3Url: str,
    DefineSegment: NotRequired[bool],
    ExternalId: NotRequired[str],
    RegisterEndpoints: NotRequired[bool],
    SegmentId: NotRequired[str],
    SegmentName: NotRequired[str],
  1. See FormatType

InAppMessageBodyConfigTypeDef#

# InAppMessageBodyConfigTypeDef definition

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

OverrideButtonConfigurationTypeDef#

# OverrideButtonConfigurationTypeDef definition

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

InAppMessageHeaderConfigTypeDef#

# InAppMessageHeaderConfigTypeDef definition

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

JourneyChannelSettingsTypeDef#

# JourneyChannelSettingsTypeDef definition

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

JourneyPushMessageTypeDef#

# JourneyPushMessageTypeDef definition

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

JourneyScheduleOutputTypeDef#

# JourneyScheduleOutputTypeDef definition

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

JourneyRunResponseTypeDef#

# JourneyRunResponseTypeDef definition

class JourneyRunResponseTypeDef(TypedDict):
    CreationTime: str,
    LastUpdateTime: str,
    RunId: str,
    Status: JourneyRunStatusType,  # (1)
  1. See JourneyRunStatusType

JourneySMSMessageTypeDef#

# JourneySMSMessageTypeDef definition

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

JourneyStateRequestTypeDef#

# JourneyStateRequestTypeDef definition

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

ListJourneysRequestRequestTypeDef#

# ListJourneysRequestRequestTypeDef definition

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

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

TagsModelOutputTypeDef#

# TagsModelOutputTypeDef definition

class TagsModelOutputTypeDef(TypedDict):
    tags: dict[str, str],

ListTemplateVersionsRequestRequestTypeDef#

# ListTemplateVersionsRequestRequestTypeDef definition

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

ListTemplatesRequestRequestTypeDef#

# ListTemplatesRequestRequestTypeDef definition

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

MessageTypeDef#

# MessageTypeDef definition

class MessageTypeDef(TypedDict):
    Action: NotRequired[ActionType],  # (1)
    Body: NotRequired[str],
    ImageIconUrl: NotRequired[str],
    ImageSmallIconUrl: NotRequired[str],
    ImageUrl: NotRequired[str],
    JsonBody: NotRequired[str],
    MediaUrl: NotRequired[str],
    RawContent: NotRequired[str],
    SilentPush: NotRequired[bool],
    TimeToLive: NotRequired[int],
    Title: NotRequired[str],
    Url: NotRequired[str],
  1. See ActionType

MessageResultTypeDef#

# MessageResultTypeDef definition

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

NumberValidateRequestTypeDef#

# NumberValidateRequestTypeDef definition

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

NumberValidateResponseTypeDef#

# NumberValidateResponseTypeDef definition

class NumberValidateResponseTypeDef(TypedDict):
    Carrier: NotRequired[str],
    City: NotRequired[str],
    CleansedPhoneNumberE164: NotRequired[str],
    CleansedPhoneNumberNational: NotRequired[str],
    Country: NotRequired[str],
    CountryCodeIso2: NotRequired[str],
    CountryCodeNumeric: NotRequired[str],
    County: NotRequired[str],
    OriginalCountryCodeIso2: NotRequired[str],
    OriginalPhoneNumber: NotRequired[str],
    PhoneType: NotRequired[str],
    PhoneTypeCode: NotRequired[int],
    Timezone: NotRequired[str],
    ZipCode: NotRequired[str],

OpenHoursRuleTypeDef#

# OpenHoursRuleTypeDef definition

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

WriteEventStreamTypeDef#

# WriteEventStreamTypeDef definition

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

RandomSplitEntryTypeDef#

# RandomSplitEntryTypeDef definition

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

RecencyDimensionTypeDef#

# RecencyDimensionTypeDef definition

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

UpdateAttributesRequestTypeDef#

# UpdateAttributesRequestTypeDef definition

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

ResultRowValueTypeDef#

# ResultRowValueTypeDef definition

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

SMSChannelRequestTypeDef#

# SMSChannelRequestTypeDef definition

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

SegmentConditionTypeDef#

# SegmentConditionTypeDef definition

class SegmentConditionTypeDef(TypedDict):
    SegmentId: str,

SegmentReferenceTypeDef#

# SegmentReferenceTypeDef definition

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

SegmentImportResourceTypeDef#

# SegmentImportResourceTypeDef definition

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

SendOTPMessageRequestParametersTypeDef#

# SendOTPMessageRequestParametersTypeDef definition

class SendOTPMessageRequestParametersTypeDef(TypedDict):
    BrandName: str,
    Channel: str,
    DestinationIdentity: str,
    OriginationIdentity: str,
    ReferenceId: str,
    AllowedAttempts: NotRequired[int],
    CodeLength: NotRequired[int],
    EntityId: NotRequired[str],
    Language: NotRequired[str],
    TemplateId: NotRequired[str],
    ValidityPeriod: NotRequired[int],

SetDimensionTypeDef#

# SetDimensionTypeDef definition

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

SimpleEmailPartTypeDef#

# SimpleEmailPartTypeDef definition

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

TagsModelTypeDef#

# TagsModelTypeDef definition

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

TemplateActiveVersionRequestTypeDef#

# TemplateActiveVersionRequestTypeDef definition

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

TemplateTypeDef#

# TemplateTypeDef definition

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

TemplateResponseTypeDef#

# TemplateResponseTypeDef definition

class TemplateResponseTypeDef(TypedDict):
    CreationDate: str,
    LastModifiedDate: str,
    TemplateName: str,
    TemplateType: TemplateTypeType,  # (1)
    Arn: NotRequired[str],
    DefaultSubstitutions: NotRequired[str],
    tags: NotRequired[dict[str, str]],
    TemplateDescription: NotRequired[str],
    Version: NotRequired[str],
  1. See TemplateTypeType

TemplateVersionResponseTypeDef#

# TemplateVersionResponseTypeDef definition

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

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

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

UpdateRecommenderConfigurationTypeDef#

# UpdateRecommenderConfigurationTypeDef definition

class UpdateRecommenderConfigurationTypeDef(TypedDict):
    RecommendationProviderRoleArn: str,
    RecommendationProviderUri: str,
    Attributes: NotRequired[Mapping[str, str]],
    Description: NotRequired[str],
    Name: NotRequired[str],
    RecommendationProviderIdType: NotRequired[str],
    RecommendationTransformerUri: NotRequired[str],
    RecommendationsDisplayName: NotRequired[str],
    RecommendationsPerMessage: NotRequired[int],

VoiceChannelRequestTypeDef#

# VoiceChannelRequestTypeDef definition

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

VerificationResponseTypeDef#

# VerificationResponseTypeDef definition

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

VerifyOTPMessageRequestParametersTypeDef#

# VerifyOTPMessageRequestParametersTypeDef definition

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

UpdateAdmChannelRequestRequestTypeDef#

# UpdateAdmChannelRequestRequestTypeDef definition

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

UpdateApnsChannelRequestRequestTypeDef#

# UpdateApnsChannelRequestRequestTypeDef definition

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

UpdateApnsSandboxChannelRequestRequestTypeDef#

# UpdateApnsSandboxChannelRequestRequestTypeDef definition

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

UpdateApnsVoipChannelRequestRequestTypeDef#

# UpdateApnsVoipChannelRequestRequestTypeDef definition

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

UpdateApnsVoipSandboxChannelRequestRequestTypeDef#

# UpdateApnsVoipSandboxChannelRequestRequestTypeDef definition

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

ActivitiesResponseTypeDef#

# ActivitiesResponseTypeDef definition

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

ApplicationsResponseTypeDef#

# ApplicationsResponseTypeDef definition

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

ApplicationSettingsJourneyLimitsTypeDef#

# ApplicationSettingsJourneyLimitsTypeDef definition

class ApplicationSettingsJourneyLimitsTypeDef(TypedDict):
    DailyCap: NotRequired[int],
    TimeframeCap: NotRequired[JourneyTimeframeCapTypeDef],  # (1)
    TotalCap: NotRequired[int],
  1. See JourneyTimeframeCapTypeDef

JourneyLimitsTypeDef#

# JourneyLimitsTypeDef definition

class JourneyLimitsTypeDef(TypedDict):
    DailyCap: NotRequired[int],
    EndpointReentryCap: NotRequired[int],
    MessagesPerSecond: NotRequired[int],
    EndpointReentryInterval: NotRequired[str],
    TimeframeCap: NotRequired[JourneyTimeframeCapTypeDef],  # (1)
    TotalCap: NotRequired[int],
  1. See JourneyTimeframeCapTypeDef

UpdateBaiduChannelRequestRequestTypeDef#

# UpdateBaiduChannelRequestRequestTypeDef definition

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

RawEmailTypeDef#

# RawEmailTypeDef definition

class RawEmailTypeDef(TypedDict):
    Data: NotRequired[BlobTypeDef],

CampaignEmailMessageOutputTypeDef#

# CampaignEmailMessageOutputTypeDef definition

class CampaignEmailMessageOutputTypeDef(TypedDict):
    Body: NotRequired[str],
    FromAddress: NotRequired[str],
    Headers: NotRequired[list[MessageHeaderTypeDef]],  # (1)
    HtmlBody: NotRequired[str],
    Title: NotRequired[str],
  1. See MessageHeaderTypeDef

CampaignEmailMessageTypeDef#

# CampaignEmailMessageTypeDef definition

class CampaignEmailMessageTypeDef(TypedDict):
    Body: NotRequired[str],
    FromAddress: NotRequired[str],
    Headers: NotRequired[Sequence[MessageHeaderTypeDef]],  # (1)
    HtmlBody: NotRequired[str],
    Title: NotRequired[str],
  1. See MessageHeaderTypeDef

EmailTemplateRequestTypeDef#

# EmailTemplateRequestTypeDef definition

class EmailTemplateRequestTypeDef(TypedDict):
    DefaultSubstitutions: NotRequired[str],
    HtmlPart: NotRequired[str],
    RecommenderId: NotRequired[str],
    Subject: NotRequired[str],
    Headers: NotRequired[Sequence[MessageHeaderTypeDef]],  # (1)
    tags: NotRequired[Mapping[str, str]],
    TemplateDescription: NotRequired[str],
    TextPart: NotRequired[str],
  1. See MessageHeaderTypeDef

EmailTemplateResponseTypeDef#

# EmailTemplateResponseTypeDef definition

class EmailTemplateResponseTypeDef(TypedDict):
    CreationDate: str,
    LastModifiedDate: str,
    TemplateName: str,
    TemplateType: TemplateTypeType,  # (2)
    Arn: NotRequired[str],
    DefaultSubstitutions: NotRequired[str],
    HtmlPart: NotRequired[str],
    RecommenderId: NotRequired[str],
    Subject: NotRequired[str],
    Headers: NotRequired[list[MessageHeaderTypeDef]],  # (1)
    tags: NotRequired[dict[str, str]],
    TemplateDescription: NotRequired[str],
    TextPart: NotRequired[str],
    Version: NotRequired[str],
  1. See MessageHeaderTypeDef
  2. See TemplateTypeType

ChannelsResponseTypeDef#

# ChannelsResponseTypeDef definition

class ChannelsResponseTypeDef(TypedDict):
    Channels: dict[str, ChannelResponseTypeDef],  # (1)
  1. See ChannelResponseTypeDef

ClosedDaysOutputTypeDef#

# ClosedDaysOutputTypeDef definition

class ClosedDaysOutputTypeDef(TypedDict):
    EMAIL: NotRequired[list[ClosedDaysRuleTypeDef]],  # (1)
    SMS: NotRequired[list[ClosedDaysRuleTypeDef]],  # (1)
    PUSH: NotRequired[list[ClosedDaysRuleTypeDef]],  # (1)
    VOICE: NotRequired[list[ClosedDaysRuleTypeDef]],  # (1)
    CUSTOM: NotRequired[list[ClosedDaysRuleTypeDef]],  # (1)
  1. See ClosedDaysRuleTypeDef
  2. See ClosedDaysRuleTypeDef
  3. See ClosedDaysRuleTypeDef
  4. See ClosedDaysRuleTypeDef
  5. See ClosedDaysRuleTypeDef

ClosedDaysTypeDef#

# ClosedDaysTypeDef 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#

# WaitActivityTypeDef definition

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

CreateAppRequestRequestTypeDef#

# CreateAppRequestRequestTypeDef definition

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

CreateAppResponseTypeDef#

# CreateAppResponseTypeDef definition

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

DeleteAdmChannelResponseTypeDef#

# DeleteAdmChannelResponseTypeDef definition

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

DeleteApnsChannelResponseTypeDef#

# DeleteApnsChannelResponseTypeDef definition

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

DeleteApnsSandboxChannelResponseTypeDef#

# DeleteApnsSandboxChannelResponseTypeDef definition

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

DeleteApnsVoipChannelResponseTypeDef#

# DeleteApnsVoipChannelResponseTypeDef definition

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

DeleteApnsVoipSandboxChannelResponseTypeDef#

# DeleteApnsVoipSandboxChannelResponseTypeDef definition

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

DeleteAppResponseTypeDef#

# DeleteAppResponseTypeDef definition

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

DeleteBaiduChannelResponseTypeDef#

# DeleteBaiduChannelResponseTypeDef definition

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

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

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

GetAdmChannelResponseTypeDef#

# GetAdmChannelResponseTypeDef definition

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

GetApnsChannelResponseTypeDef#

# GetApnsChannelResponseTypeDef definition

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

GetApnsSandboxChannelResponseTypeDef#

# GetApnsSandboxChannelResponseTypeDef definition

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

GetApnsVoipChannelResponseTypeDef#

# GetApnsVoipChannelResponseTypeDef definition

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

GetApnsVoipSandboxChannelResponseTypeDef#

# GetApnsVoipSandboxChannelResponseTypeDef definition

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

GetAppResponseTypeDef#

# GetAppResponseTypeDef definition

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

GetBaiduChannelResponseTypeDef#

# GetBaiduChannelResponseTypeDef definition

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

RemoveAttributesResponseTypeDef#

# RemoveAttributesResponseTypeDef definition

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

UpdateAdmChannelResponseTypeDef#

# UpdateAdmChannelResponseTypeDef definition

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

UpdateApnsChannelResponseTypeDef#

# UpdateApnsChannelResponseTypeDef definition

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

UpdateApnsSandboxChannelResponseTypeDef#

# UpdateApnsSandboxChannelResponseTypeDef definition

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

UpdateApnsVoipChannelResponseTypeDef#

# UpdateApnsVoipChannelResponseTypeDef definition

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

UpdateApnsVoipSandboxChannelResponseTypeDef#

# UpdateApnsVoipSandboxChannelResponseTypeDef definition

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

UpdateBaiduChannelResponseTypeDef#

# UpdateBaiduChannelResponseTypeDef definition

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

CreateEmailTemplateResponseTypeDef#

# CreateEmailTemplateResponseTypeDef definition

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

CreatePushTemplateResponseTypeDef#

# CreatePushTemplateResponseTypeDef definition

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

CreateSmsTemplateResponseTypeDef#

# CreateSmsTemplateResponseTypeDef definition

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

CreateVoiceTemplateResponseTypeDef#

# CreateVoiceTemplateResponseTypeDef definition

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

CreateExportJobRequestRequestTypeDef#

# CreateExportJobRequestRequestTypeDef definition

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

CreateImportJobRequestRequestTypeDef#

# CreateImportJobRequestRequestTypeDef definition

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

CreateInAppTemplateResponseTypeDef#

# CreateInAppTemplateResponseTypeDef definition

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

CreateRecommenderConfigurationRequestRequestTypeDef#

# CreateRecommenderConfigurationRequestRequestTypeDef definition

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

CreateRecommenderConfigurationResponseTypeDef#

# CreateRecommenderConfigurationResponseTypeDef definition

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

DeleteRecommenderConfigurationResponseTypeDef#

# DeleteRecommenderConfigurationResponseTypeDef definition

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

GetRecommenderConfigurationResponseTypeDef#

# GetRecommenderConfigurationResponseTypeDef definition

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

ListRecommenderConfigurationsResponseTypeDef#

# ListRecommenderConfigurationsResponseTypeDef definition

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

UpdateRecommenderConfigurationResponseTypeDef#

# UpdateRecommenderConfigurationResponseTypeDef definition

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

CreateSmsTemplateRequestRequestTypeDef#

# CreateSmsTemplateRequestRequestTypeDef definition

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

UpdateSmsTemplateRequestRequestTypeDef#

# UpdateSmsTemplateRequestRequestTypeDef definition

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

CreateVoiceTemplateRequestRequestTypeDef#

# CreateVoiceTemplateRequestRequestTypeDef definition

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

UpdateVoiceTemplateRequestRequestTypeDef#

# UpdateVoiceTemplateRequestRequestTypeDef definition

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

CustomMessageActivityOutputTypeDef#

# CustomMessageActivityOutputTypeDef definition

class CustomMessageActivityOutputTypeDef(TypedDict):
    DeliveryUri: NotRequired[str],
    EndpointTypes: NotRequired[list[EndpointTypesElementType]],  # (1)
    MessageConfig: NotRequired[JourneyCustomMessageTypeDef],  # (2)
    NextActivity: NotRequired[str],
    TemplateName: NotRequired[str],
    TemplateVersion: NotRequired[str],
  1. See EndpointTypesElementType
  2. See JourneyCustomMessageTypeDef

CustomMessageActivityTypeDef#

# CustomMessageActivityTypeDef 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#

# PushNotificationTemplateRequestTypeDef 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#

# PushNotificationTemplateResponseTypeDef 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#

# DeleteEmailChannelResponseTypeDef definition

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

GetEmailChannelResponseTypeDef#

# GetEmailChannelResponseTypeDef definition

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

UpdateEmailChannelResponseTypeDef#

# UpdateEmailChannelResponseTypeDef definition

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

DeleteEmailTemplateResponseTypeDef#

# DeleteEmailTemplateResponseTypeDef definition

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

DeleteInAppTemplateResponseTypeDef#

# DeleteInAppTemplateResponseTypeDef definition

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

DeletePushTemplateResponseTypeDef#

# DeletePushTemplateResponseTypeDef definition

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

DeleteSmsTemplateResponseTypeDef#

# DeleteSmsTemplateResponseTypeDef definition

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

DeleteVoiceTemplateResponseTypeDef#

# DeleteVoiceTemplateResponseTypeDef definition

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

UpdateEmailTemplateResponseTypeDef#

# UpdateEmailTemplateResponseTypeDef definition

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

UpdateEndpointResponseTypeDef#

# UpdateEndpointResponseTypeDef definition

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

UpdateEndpointsBatchResponseTypeDef#

# UpdateEndpointsBatchResponseTypeDef definition

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

UpdateInAppTemplateResponseTypeDef#

# UpdateInAppTemplateResponseTypeDef definition

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

UpdatePushTemplateResponseTypeDef#

# UpdatePushTemplateResponseTypeDef definition

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

UpdateSmsTemplateResponseTypeDef#

# UpdateSmsTemplateResponseTypeDef definition

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

UpdateTemplateActiveVersionResponseTypeDef#

# UpdateTemplateActiveVersionResponseTypeDef definition

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

UpdateVoiceTemplateResponseTypeDef#

# UpdateVoiceTemplateResponseTypeDef definition

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

DeleteEventStreamResponseTypeDef#

# DeleteEventStreamResponseTypeDef definition

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

GetEventStreamResponseTypeDef#

# GetEventStreamResponseTypeDef definition

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

PutEventStreamResponseTypeDef#

# PutEventStreamResponseTypeDef definition

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

DeleteGcmChannelResponseTypeDef#

# DeleteGcmChannelResponseTypeDef definition

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

GetGcmChannelResponseTypeDef#

# GetGcmChannelResponseTypeDef definition

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

UpdateGcmChannelResponseTypeDef#

# UpdateGcmChannelResponseTypeDef definition

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

DeleteSmsChannelResponseTypeDef#

# DeleteSmsChannelResponseTypeDef definition

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

GetSmsChannelResponseTypeDef#

# GetSmsChannelResponseTypeDef definition

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

UpdateSmsChannelResponseTypeDef#

# UpdateSmsChannelResponseTypeDef definition

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

DeleteVoiceChannelResponseTypeDef#

# DeleteVoiceChannelResponseTypeDef definition

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

GetVoiceChannelResponseTypeDef#

# GetVoiceChannelResponseTypeDef definition

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

UpdateVoiceChannelResponseTypeDef#

# UpdateVoiceChannelResponseTypeDef definition

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

UpdateEmailChannelRequestRequestTypeDef#

# UpdateEmailChannelRequestRequestTypeDef definition

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

EmailMessageActivityTypeDef#

# EmailMessageActivityTypeDef definition

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

SendUsersMessageResponseTypeDef#

# SendUsersMessageResponseTypeDef definition

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

EndpointResponseTypeDef#

# EndpointResponseTypeDef 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[EndpointUserOutputTypeDef],  # (4)
  1. See ChannelTypeType
  2. See EndpointDemographicTypeDef
  3. See EndpointLocationTypeDef
  4. See EndpointUserOutputTypeDef

EventDimensionsOutputTypeDef#

# EventDimensionsOutputTypeDef definition

class EventDimensionsOutputTypeDef(TypedDict):
    Attributes: NotRequired[dict[str, AttributeDimensionOutputTypeDef]],  # (1)
    EventType: NotRequired[SetDimensionOutputTypeDef],  # (2)
    Metrics: NotRequired[dict[str, MetricDimensionTypeDef]],  # (3)
  1. See AttributeDimensionOutputTypeDef
  2. See SetDimensionOutputTypeDef
  3. See MetricDimensionTypeDef

SegmentDemographicsOutputTypeDef#

# SegmentDemographicsOutputTypeDef definition

class SegmentDemographicsOutputTypeDef(TypedDict):
    AppVersion: NotRequired[SetDimensionOutputTypeDef],  # (1)
    Channel: NotRequired[SetDimensionOutputTypeDef],  # (1)
    DeviceType: NotRequired[SetDimensionOutputTypeDef],  # (1)
    Make: NotRequired[SetDimensionOutputTypeDef],  # (1)
    Model: NotRequired[SetDimensionOutputTypeDef],  # (1)
    Platform: NotRequired[SetDimensionOutputTypeDef],  # (1)
  1. See SetDimensionOutputTypeDef
  2. See SetDimensionOutputTypeDef
  3. See SetDimensionOutputTypeDef
  4. See SetDimensionOutputTypeDef
  5. See SetDimensionOutputTypeDef
  6. See SetDimensionOutputTypeDef

ItemResponseTypeDef#

# ItemResponseTypeDef definition

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

EventTypeDef#

# EventTypeDef 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#

# ExportJobResponseTypeDef 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#

# UpdateGcmChannelRequestRequestTypeDef definition

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

GPSPointDimensionTypeDef#

# GPSPointDimensionTypeDef definition

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

GetApplicationDateRangeKpiRequestRequestTypeDef#

# GetApplicationDateRangeKpiRequestRequestTypeDef definition

class GetApplicationDateRangeKpiRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    KpiName: str,
    EndTime: NotRequired[TimestampTypeDef],
    NextToken: NotRequired[str],
    PageSize: NotRequired[str],
    StartTime: NotRequired[TimestampTypeDef],

GetCampaignDateRangeKpiRequestRequestTypeDef#

# GetCampaignDateRangeKpiRequestRequestTypeDef definition

class GetCampaignDateRangeKpiRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    CampaignId: str,
    KpiName: str,
    EndTime: NotRequired[TimestampTypeDef],
    NextToken: NotRequired[str],
    PageSize: NotRequired[str],
    StartTime: NotRequired[TimestampTypeDef],

GetJourneyDateRangeKpiRequestRequestTypeDef#

# GetJourneyDateRangeKpiRequestRequestTypeDef definition

class GetJourneyDateRangeKpiRequestRequestTypeDef(TypedDict):
    ApplicationId: str,
    JourneyId: str,
    KpiName: str,
    EndTime: NotRequired[TimestampTypeDef],
    NextToken: NotRequired[str],
    PageSize: NotRequired[str],
    StartTime: NotRequired[TimestampTypeDef],

JourneyScheduleTypeDef#

# JourneyScheduleTypeDef definition

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

GetJourneyExecutionActivityMetricsResponseTypeDef#

# GetJourneyExecutionActivityMetricsResponseTypeDef definition

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

GetJourneyExecutionMetricsResponseTypeDef#

# GetJourneyExecutionMetricsResponseTypeDef definition

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

GetJourneyRunExecutionActivityMetricsResponseTypeDef#

# GetJourneyRunExecutionActivityMetricsResponseTypeDef definition

class GetJourneyRunExecutionActivityMetricsResponseTypeDef(TypedDict):
    JourneyRunExecutionActivityMetricsResponse: JourneyRunExecutionActivityMetricsResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JourneyRunExecutionActivityMetricsResponseTypeDef
  2. See ResponseMetadataTypeDef

GetJourneyRunExecutionMetricsResponseTypeDef#

# GetJourneyRunExecutionMetricsResponseTypeDef definition

class GetJourneyRunExecutionMetricsResponseTypeDef(TypedDict):
    JourneyRunExecutionMetricsResponse: JourneyRunExecutionMetricsResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JourneyRunExecutionMetricsResponseTypeDef
  2. See ResponseMetadataTypeDef

GetSmsTemplateResponseTypeDef#

# GetSmsTemplateResponseTypeDef definition

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

GetVoiceTemplateResponseTypeDef#

# GetVoiceTemplateResponseTypeDef definition

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

ImportJobResponseTypeDef#

# ImportJobResponseTypeDef 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#

# InAppMessageButtonTypeDef 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#

# PushMessageActivityTypeDef definition

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

JourneyRunsResponseTypeDef#

# JourneyRunsResponseTypeDef definition

class JourneyRunsResponseTypeDef(TypedDict):
    Item: list[JourneyRunResponseTypeDef],  # (1)
    NextToken: NotRequired[str],
  1. See JourneyRunResponseTypeDef

SMSMessageActivityTypeDef#

# SMSMessageActivityTypeDef definition

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

UpdateJourneyStateRequestRequestTypeDef#

# UpdateJourneyStateRequestRequestTypeDef definition

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

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    TagsModel: TagsModelOutputTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagsModelOutputTypeDef
  2. See ResponseMetadataTypeDef

MessageResponseTypeDef#

# MessageResponseTypeDef 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#

# PhoneNumberValidateRequestRequestTypeDef definition

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

PhoneNumberValidateResponseTypeDef#

# PhoneNumberValidateResponseTypeDef definition

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

OpenHoursOutputTypeDef#

# OpenHoursOutputTypeDef definition

class OpenHoursOutputTypeDef(TypedDict):
    EMAIL: NotRequired[dict[DayOfWeekType, list[OpenHoursRuleTypeDef]]],  # (1)
    SMS: NotRequired[dict[DayOfWeekType, list[OpenHoursRuleTypeDef]]],  # (1)
    PUSH: NotRequired[dict[DayOfWeekType, list[OpenHoursRuleTypeDef]]],  # (1)
    VOICE: NotRequired[dict[DayOfWeekType, list[OpenHoursRuleTypeDef]]],  # (1)
    CUSTOM: NotRequired[dict[DayOfWeekType, list[OpenHoursRuleTypeDef]]],  # (1)
  1. See DayOfWeekType OpenHoursRuleTypeDef
  2. See DayOfWeekType OpenHoursRuleTypeDef
  3. See DayOfWeekType OpenHoursRuleTypeDef
  4. See DayOfWeekType OpenHoursRuleTypeDef
  5. See DayOfWeekType OpenHoursRuleTypeDef

OpenHoursTypeDef#

# OpenHoursTypeDef 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#

# PutEventStreamRequestRequestTypeDef definition

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

RandomSplitActivityOutputTypeDef#

# RandomSplitActivityOutputTypeDef definition

class RandomSplitActivityOutputTypeDef(TypedDict):
    Branches: NotRequired[list[RandomSplitEntryTypeDef]],  # (1)
  1. See RandomSplitEntryTypeDef

RandomSplitActivityTypeDef#

# RandomSplitActivityTypeDef definition

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

SegmentBehaviorsTypeDef#

# SegmentBehaviorsTypeDef definition

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

RemoveAttributesRequestRequestTypeDef#

# RemoveAttributesRequestRequestTypeDef definition

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

ResultRowTypeDef#

# ResultRowTypeDef definition

class ResultRowTypeDef(TypedDict):
    GroupedBys: list[ResultRowValueTypeDef],  # (1)
    Values: list[ResultRowValueTypeDef],  # (1)
  1. See ResultRowValueTypeDef
  2. See ResultRowValueTypeDef

UpdateSmsChannelRequestRequestTypeDef#

# UpdateSmsChannelRequestRequestTypeDef definition

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

SendOTPMessageRequestRequestTypeDef#

# SendOTPMessageRequestRequestTypeDef definition

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

SimpleEmailTypeDef#

# SimpleEmailTypeDef definition

class SimpleEmailTypeDef(TypedDict):
    HtmlPart: NotRequired[SimpleEmailPartTypeDef],  # (1)
    Subject: NotRequired[SimpleEmailPartTypeDef],  # (1)
    TextPart: NotRequired[SimpleEmailPartTypeDef],  # (1)
    Headers: NotRequired[Sequence[MessageHeaderTypeDef]],  # (4)
  1. See SimpleEmailPartTypeDef
  2. See SimpleEmailPartTypeDef
  3. See SimpleEmailPartTypeDef
  4. See MessageHeaderTypeDef

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

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

UpdateTemplateActiveVersionRequestRequestTypeDef#

# UpdateTemplateActiveVersionRequestRequestTypeDef definition

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

TemplateConfigurationTypeDef#

# TemplateConfigurationTypeDef definition

class TemplateConfigurationTypeDef(TypedDict):
    EmailTemplate: NotRequired[TemplateTypeDef],  # (1)
    PushTemplate: NotRequired[TemplateTypeDef],  # (1)
    SMSTemplate: NotRequired[TemplateTypeDef],  # (1)
    VoiceTemplate: NotRequired[TemplateTypeDef],  # (1)
    InAppTemplate: NotRequired[TemplateTypeDef],  # (1)
  1. See TemplateTypeDef
  2. See TemplateTypeDef
  3. See TemplateTypeDef
  4. See TemplateTypeDef
  5. See TemplateTypeDef

TemplatesResponseTypeDef#

# TemplatesResponseTypeDef definition

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

TemplateVersionsResponseTypeDef#

# TemplateVersionsResponseTypeDef definition

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

UpdateRecommenderConfigurationRequestRequestTypeDef#

# UpdateRecommenderConfigurationRequestRequestTypeDef definition

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

UpdateVoiceChannelRequestRequestTypeDef#

# UpdateVoiceChannelRequestRequestTypeDef definition

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

VerifyOTPMessageResponseTypeDef#

# VerifyOTPMessageResponseTypeDef definition

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

VerifyOTPMessageRequestRequestTypeDef#

# VerifyOTPMessageRequestRequestTypeDef definition

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

GetCampaignActivitiesResponseTypeDef#

# GetCampaignActivitiesResponseTypeDef definition

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

GetAppsResponseTypeDef#

# GetAppsResponseTypeDef definition

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

ApplicationSettingsResourceTypeDef#

# ApplicationSettingsResourceTypeDef definition

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

WriteApplicationSettingsRequestTypeDef#

# WriteApplicationSettingsRequestTypeDef definition

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

CreateEmailTemplateRequestRequestTypeDef#

# CreateEmailTemplateRequestRequestTypeDef definition

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

UpdateEmailTemplateRequestRequestTypeDef#

# UpdateEmailTemplateRequestRequestTypeDef definition

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

GetEmailTemplateResponseTypeDef#

# GetEmailTemplateResponseTypeDef definition

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

GetChannelsResponseTypeDef#

# GetChannelsResponseTypeDef definition

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

GetRecommenderConfigurationsResponseTypeDef#

# GetRecommenderConfigurationsResponseTypeDef definition

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

CreatePushTemplateRequestRequestTypeDef#

# CreatePushTemplateRequestRequestTypeDef definition

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

UpdatePushTemplateRequestRequestTypeDef#

# UpdatePushTemplateRequestRequestTypeDef definition

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

GetPushTemplateResponseTypeDef#

# GetPushTemplateResponseTypeDef definition

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

SendUsersMessagesResponseTypeDef#

# SendUsersMessagesResponseTypeDef definition

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

DeleteEndpointResponseTypeDef#

# DeleteEndpointResponseTypeDef definition

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

EndpointsResponseTypeDef#

# EndpointsResponseTypeDef definition

class EndpointsResponseTypeDef(TypedDict):
    Item: list[EndpointResponseTypeDef],  # (1)
  1. See EndpointResponseTypeDef

GetEndpointResponseTypeDef#

# GetEndpointResponseTypeDef definition

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

EndpointBatchItemTypeDef#

# EndpointBatchItemTypeDef 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[EndpointUserUnionTypeDef],  # (4)
  1. See ChannelTypeType
  2. See EndpointDemographicTypeDef
  3. See EndpointLocationTypeDef
  4. See EndpointUserTypeDef EndpointUserOutputTypeDef

EndpointRequestTypeDef#

# EndpointRequestTypeDef 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[EndpointUserUnionTypeDef],  # (4)
  1. See ChannelTypeType
  2. See EndpointDemographicTypeDef
  3. See EndpointLocationTypeDef
  4. See EndpointUserTypeDef EndpointUserOutputTypeDef

PublicEndpointTypeDef#

# PublicEndpointTypeDef 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[EndpointUserUnionTypeDef],  # (4)
  1. See ChannelTypeType
  2. See EndpointDemographicTypeDef
  3. See EndpointLocationTypeDef
  4. See EndpointUserTypeDef EndpointUserOutputTypeDef

CampaignEventFilterOutputTypeDef#

# CampaignEventFilterOutputTypeDef definition

class CampaignEventFilterOutputTypeDef(TypedDict):
    Dimensions: EventDimensionsOutputTypeDef,  # (1)
    FilterType: FilterTypeType,  # (2)
  1. See EventDimensionsOutputTypeDef
  2. See FilterTypeType

EventConditionOutputTypeDef#

# EventConditionOutputTypeDef definition

class EventConditionOutputTypeDef(TypedDict):
    Dimensions: NotRequired[EventDimensionsOutputTypeDef],  # (1)
    MessageActivity: NotRequired[str],
  1. See EventDimensionsOutputTypeDef

EventFilterOutputTypeDef#

# EventFilterOutputTypeDef definition

class EventFilterOutputTypeDef(TypedDict):
    Dimensions: EventDimensionsOutputTypeDef,  # (1)
    FilterType: FilterTypeType,  # (2)
  1. See EventDimensionsOutputTypeDef
  2. See FilterTypeType

EventsResponseTypeDef#

# EventsResponseTypeDef definition

class EventsResponseTypeDef(TypedDict):
    Results: NotRequired[dict[str, ItemResponseTypeDef]],  # (1)
  1. See ItemResponseTypeDef

CreateExportJobResponseTypeDef#

# CreateExportJobResponseTypeDef definition

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

ExportJobsResponseTypeDef#

# ExportJobsResponseTypeDef definition

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

GetExportJobResponseTypeDef#

# GetExportJobResponseTypeDef definition

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

SegmentLocationOutputTypeDef#

# SegmentLocationOutputTypeDef definition

class SegmentLocationOutputTypeDef(TypedDict):
    Country: NotRequired[SetDimensionOutputTypeDef],  # (1)
    GPSPoint: NotRequired[GPSPointDimensionTypeDef],  # (2)
  1. See SetDimensionOutputTypeDef
  2. See GPSPointDimensionTypeDef

CreateImportJobResponseTypeDef#

# CreateImportJobResponseTypeDef definition

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

GetImportJobResponseTypeDef#

# GetImportJobResponseTypeDef definition

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

ImportJobsResponseTypeDef#

# ImportJobsResponseTypeDef definition

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

InAppMessageContentTypeDef#

# InAppMessageContentTypeDef 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

GetJourneyRunsResponseTypeDef#

# GetJourneyRunsResponseTypeDef definition

class GetJourneyRunsResponseTypeDef(TypedDict):
    JourneyRunsResponse: JourneyRunsResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JourneyRunsResponseTypeDef
  2. See ResponseMetadataTypeDef

SendMessagesResponseTypeDef#

# SendMessagesResponseTypeDef definition

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

SendOTPMessageResponseTypeDef#

# SendOTPMessageResponseTypeDef definition

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

BaseKpiResultTypeDef#

# BaseKpiResultTypeDef definition

class BaseKpiResultTypeDef(TypedDict):
    Rows: list[ResultRowTypeDef],  # (1)
  1. See ResultRowTypeDef

EventDimensionsTypeDef#

# EventDimensionsTypeDef definition

class EventDimensionsTypeDef(TypedDict):
    Attributes: NotRequired[Mapping[str, AttributeDimensionUnionTypeDef]],  # (1)
    EventType: NotRequired[SetDimensionUnionTypeDef],  # (2)
    Metrics: NotRequired[Mapping[str, MetricDimensionTypeDef]],  # (3)
  1. See AttributeDimensionTypeDef AttributeDimensionOutputTypeDef
  2. See SetDimensionTypeDef SetDimensionOutputTypeDef
  3. See MetricDimensionTypeDef

SegmentDemographicsTypeDef#

# SegmentDemographicsTypeDef definition

class SegmentDemographicsTypeDef(TypedDict):
    AppVersion: NotRequired[SetDimensionUnionTypeDef],  # (1)
    Channel: NotRequired[SetDimensionUnionTypeDef],  # (1)
    DeviceType: NotRequired[SetDimensionUnionTypeDef],  # (1)
    Make: NotRequired[SetDimensionUnionTypeDef],  # (1)
    Model: NotRequired[SetDimensionUnionTypeDef],  # (1)
    Platform: NotRequired[SetDimensionUnionTypeDef],  # (1)
  1. See SetDimensionTypeDef SetDimensionOutputTypeDef
  2. See SetDimensionTypeDef SetDimensionOutputTypeDef
  3. See SetDimensionTypeDef SetDimensionOutputTypeDef
  4. See SetDimensionTypeDef SetDimensionOutputTypeDef
  5. See SetDimensionTypeDef SetDimensionOutputTypeDef
  6. See SetDimensionTypeDef SetDimensionOutputTypeDef

SegmentLocationTypeDef#

# SegmentLocationTypeDef definition

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

EmailMessageTypeDef#

# EmailMessageTypeDef 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#

# ListTemplatesResponseTypeDef definition

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

ListTemplateVersionsResponseTypeDef#

# ListTemplateVersionsResponseTypeDef definition

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

GetApplicationSettingsResponseTypeDef#

# GetApplicationSettingsResponseTypeDef definition

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

UpdateApplicationSettingsResponseTypeDef#

# UpdateApplicationSettingsResponseTypeDef definition

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

UpdateApplicationSettingsRequestRequestTypeDef#

# UpdateApplicationSettingsRequestRequestTypeDef definition

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

DeleteUserEndpointsResponseTypeDef#

# DeleteUserEndpointsResponseTypeDef definition

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

GetUserEndpointsResponseTypeDef#

# GetUserEndpointsResponseTypeDef definition

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

EndpointBatchRequestTypeDef#

# EndpointBatchRequestTypeDef definition

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

UpdateEndpointRequestRequestTypeDef#

# UpdateEndpointRequestRequestTypeDef definition

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

EventsBatchTypeDef#

# EventsBatchTypeDef definition

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

InAppCampaignScheduleTypeDef#

# InAppCampaignScheduleTypeDef definition

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

ScheduleOutputTypeDef#

# ScheduleOutputTypeDef definition

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

EventStartConditionOutputTypeDef#

# EventStartConditionOutputTypeDef definition

class EventStartConditionOutputTypeDef(TypedDict):
    EventFilter: NotRequired[EventFilterOutputTypeDef],  # (1)
    SegmentId: NotRequired[str],
  1. See EventFilterOutputTypeDef

PutEventsResponseTypeDef#

# PutEventsResponseTypeDef definition

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

GetExportJobsResponseTypeDef#

# GetExportJobsResponseTypeDef definition

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

GetSegmentExportJobsResponseTypeDef#

# GetSegmentExportJobsResponseTypeDef definition

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

SegmentDimensionsOutputTypeDef#

# SegmentDimensionsOutputTypeDef definition

class SegmentDimensionsOutputTypeDef(TypedDict):
    Attributes: NotRequired[dict[str, AttributeDimensionOutputTypeDef]],  # (1)
    Behavior: NotRequired[SegmentBehaviorsTypeDef],  # (2)
    Demographic: NotRequired[SegmentDemographicsOutputTypeDef],  # (3)
    Location: NotRequired[SegmentLocationOutputTypeDef],  # (4)
    Metrics: NotRequired[dict[str, MetricDimensionTypeDef]],  # (5)
    UserAttributes: NotRequired[dict[str, AttributeDimensionOutputTypeDef]],  # (1)
  1. See AttributeDimensionOutputTypeDef
  2. See SegmentBehaviorsTypeDef
  3. See SegmentDemographicsOutputTypeDef
  4. See SegmentLocationOutputTypeDef
  5. See MetricDimensionTypeDef
  6. See AttributeDimensionOutputTypeDef

GetImportJobsResponseTypeDef#

# GetImportJobsResponseTypeDef definition

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

GetSegmentImportJobsResponseTypeDef#

# GetSegmentImportJobsResponseTypeDef definition

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

CampaignInAppMessageOutputTypeDef#

# CampaignInAppMessageOutputTypeDef definition

class CampaignInAppMessageOutputTypeDef(TypedDict):
    Body: NotRequired[str],
    Content: NotRequired[list[InAppMessageContentTypeDef]],  # (1)
    CustomConfig: NotRequired[dict[str, str]],
    Layout: NotRequired[LayoutType],  # (2)
  1. See InAppMessageContentTypeDef
  2. See LayoutType

CampaignInAppMessageTypeDef#

# CampaignInAppMessageTypeDef 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#

# InAppMessageTypeDef 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#

# InAppTemplateRequestTypeDef 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#

# InAppTemplateResponseTypeDef 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#

# ApplicationDateRangeKpiResponseTypeDef definition

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

CampaignDateRangeKpiResponseTypeDef#

# CampaignDateRangeKpiResponseTypeDef definition

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

JourneyDateRangeKpiResponseTypeDef#

# JourneyDateRangeKpiResponseTypeDef definition

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

DirectMessageConfigurationTypeDef#

# DirectMessageConfigurationTypeDef 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

UpdateEndpointsBatchRequestRequestTypeDef#

# UpdateEndpointsBatchRequestRequestTypeDef definition

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

EventsRequestTypeDef#

# EventsRequestTypeDef definition

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

StartConditionOutputTypeDef#

# StartConditionOutputTypeDef definition

class StartConditionOutputTypeDef(TypedDict):
    Description: NotRequired[str],
    EventStartCondition: NotRequired[EventStartConditionOutputTypeDef],  # (1)
    SegmentStartCondition: NotRequired[SegmentConditionTypeDef],  # (2)
  1. See EventStartConditionOutputTypeDef
  2. See SegmentConditionTypeDef

SegmentGroupOutputTypeDef#

# SegmentGroupOutputTypeDef definition

class SegmentGroupOutputTypeDef(TypedDict):
    Dimensions: NotRequired[list[SegmentDimensionsOutputTypeDef]],  # (1)
    SourceSegments: NotRequired[list[SegmentReferenceTypeDef]],  # (2)
    SourceType: NotRequired[SourceTypeType],  # (3)
    Type: NotRequired[TypeType],  # (4)
  1. See SegmentDimensionsOutputTypeDef
  2. See SegmentReferenceTypeDef
  3. See SourceTypeType
  4. See TypeType

SimpleConditionOutputTypeDef#

# SimpleConditionOutputTypeDef definition

class SimpleConditionOutputTypeDef(TypedDict):
    EventCondition: NotRequired[EventConditionOutputTypeDef],  # (1)
    SegmentCondition: NotRequired[SegmentConditionTypeDef],  # (2)
    SegmentDimensions: NotRequired[SegmentDimensionsOutputTypeDef],  # (3)
  1. See EventConditionOutputTypeDef
  2. See SegmentConditionTypeDef
  3. See SegmentDimensionsOutputTypeDef

MessageConfigurationOutputTypeDef#

# MessageConfigurationOutputTypeDef definition

class MessageConfigurationOutputTypeDef(TypedDict):
    ADMMessage: NotRequired[MessageTypeDef],  # (1)
    APNSMessage: NotRequired[MessageTypeDef],  # (1)
    BaiduMessage: NotRequired[MessageTypeDef],  # (1)
    CustomMessage: NotRequired[CampaignCustomMessageTypeDef],  # (4)
    DefaultMessage: NotRequired[MessageTypeDef],  # (1)
    EmailMessage: NotRequired[CampaignEmailMessageOutputTypeDef],  # (6)
    GCMMessage: NotRequired[MessageTypeDef],  # (1)
    SMSMessage: NotRequired[CampaignSmsMessageTypeDef],  # (8)
    InAppMessage: NotRequired[CampaignInAppMessageOutputTypeDef],  # (9)
  1. See MessageTypeDef
  2. See MessageTypeDef
  3. See MessageTypeDef
  4. See CampaignCustomMessageTypeDef
  5. See MessageTypeDef
  6. See CampaignEmailMessageOutputTypeDef
  7. See MessageTypeDef
  8. See CampaignSmsMessageTypeDef
  9. See CampaignInAppMessageOutputTypeDef

InAppMessageCampaignTypeDef#

# InAppMessageCampaignTypeDef 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#

# CreateInAppTemplateRequestRequestTypeDef definition

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

UpdateInAppTemplateRequestRequestTypeDef#

# UpdateInAppTemplateRequestRequestTypeDef definition

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

GetInAppTemplateResponseTypeDef#

# GetInAppTemplateResponseTypeDef definition

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

GetApplicationDateRangeKpiResponseTypeDef#

# GetApplicationDateRangeKpiResponseTypeDef definition

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

GetCampaignDateRangeKpiResponseTypeDef#

# GetCampaignDateRangeKpiResponseTypeDef definition

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

GetJourneyDateRangeKpiResponseTypeDef#

# GetJourneyDateRangeKpiResponseTypeDef definition

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

CampaignEventFilterTypeDef#

# CampaignEventFilterTypeDef definition

class CampaignEventFilterTypeDef(TypedDict):
    Dimensions: EventDimensionsUnionTypeDef,  # (1)
    FilterType: FilterTypeType,  # (2)
  1. See EventDimensionsTypeDef EventDimensionsOutputTypeDef
  2. See FilterTypeType

EventConditionTypeDef#

# EventConditionTypeDef definition

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

EventFilterTypeDef#

# EventFilterTypeDef definition

class EventFilterTypeDef(TypedDict):
    Dimensions: EventDimensionsUnionTypeDef,  # (1)
    FilterType: FilterTypeType,  # (2)
  1. See EventDimensionsTypeDef EventDimensionsOutputTypeDef
  2. See FilterTypeType

SegmentDimensionsTypeDef#

# SegmentDimensionsTypeDef definition

class SegmentDimensionsTypeDef(TypedDict):
    Attributes: NotRequired[Mapping[str, AttributeDimensionUnionTypeDef]],  # (1)
    Behavior: NotRequired[SegmentBehaviorsTypeDef],  # (2)
    Demographic: NotRequired[SegmentDemographicsUnionTypeDef],  # (3)
    Location: NotRequired[SegmentLocationUnionTypeDef],  # (4)
    Metrics: NotRequired[Mapping[str, MetricDimensionTypeDef]],  # (5)
    UserAttributes: NotRequired[Mapping[str, AttributeDimensionUnionTypeDef]],  # (1)
  1. See AttributeDimensionTypeDef AttributeDimensionOutputTypeDef
  2. See SegmentBehaviorsTypeDef
  3. See SegmentDemographicsTypeDef SegmentDemographicsOutputTypeDef
  4. See SegmentLocationTypeDef SegmentLocationOutputTypeDef
  5. See MetricDimensionTypeDef
  6. See AttributeDimensionTypeDef AttributeDimensionOutputTypeDef

MessageRequestTypeDef#

# MessageRequestTypeDef 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#

# SendUsersMessageRequestTypeDef 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

PutEventsRequestRequestTypeDef#

# PutEventsRequestRequestTypeDef definition

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

SegmentGroupListOutputTypeDef#

# SegmentGroupListOutputTypeDef definition

class SegmentGroupListOutputTypeDef(TypedDict):
    Groups: NotRequired[list[SegmentGroupOutputTypeDef]],  # (1)
    Include: NotRequired[IncludeType],  # (2)
  1. See SegmentGroupOutputTypeDef
  2. See IncludeType

ConditionOutputTypeDef#

# ConditionOutputTypeDef definition

class ConditionOutputTypeDef(TypedDict):
    Conditions: NotRequired[list[SimpleConditionOutputTypeDef]],  # (1)
    Operator: NotRequired[OperatorType],  # (2)
  1. See SimpleConditionOutputTypeDef
  2. See OperatorType

MultiConditionalBranchOutputTypeDef#

# MultiConditionalBranchOutputTypeDef definition

class MultiConditionalBranchOutputTypeDef(TypedDict):
    Condition: NotRequired[SimpleConditionOutputTypeDef],  # (1)
    NextActivity: NotRequired[str],
  1. See SimpleConditionOutputTypeDef

TreatmentResourceTypeDef#

# TreatmentResourceTypeDef definition

class TreatmentResourceTypeDef(TypedDict):
    Id: str,
    SizePercent: int,
    CustomDeliveryConfiguration: NotRequired[CustomDeliveryConfigurationOutputTypeDef],  # (1)
    MessageConfiguration: NotRequired[MessageConfigurationOutputTypeDef],  # (2)
    Schedule: NotRequired[ScheduleOutputTypeDef],  # (3)
    State: NotRequired[CampaignStateTypeDef],  # (4)
    TemplateConfiguration: NotRequired[TemplateConfigurationTypeDef],  # (5)
    TreatmentDescription: NotRequired[str],
    TreatmentName: NotRequired[str],
  1. See CustomDeliveryConfigurationOutputTypeDef
  2. See MessageConfigurationOutputTypeDef
  3. See ScheduleOutputTypeDef
  4. See CampaignStateTypeDef
  5. See TemplateConfigurationTypeDef

MessageConfigurationTypeDef#

# MessageConfigurationTypeDef 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[CampaignEmailMessageUnionTypeDef],  # (6)
    GCMMessage: NotRequired[MessageTypeDef],  # (1)
    SMSMessage: NotRequired[CampaignSmsMessageTypeDef],  # (8)
    InAppMessage: NotRequired[CampaignInAppMessageUnionTypeDef],  # (9)
  1. See MessageTypeDef
  2. See MessageTypeDef
  3. See MessageTypeDef
  4. See CampaignCustomMessageTypeDef
  5. See MessageTypeDef
  6. See CampaignEmailMessageTypeDef CampaignEmailMessageOutputTypeDef
  7. See MessageTypeDef
  8. See CampaignSmsMessageTypeDef
  9. See CampaignInAppMessageTypeDef CampaignInAppMessageOutputTypeDef

InAppMessagesResponseTypeDef#

# InAppMessagesResponseTypeDef definition

class InAppMessagesResponseTypeDef(TypedDict):
    InAppMessageCampaigns: NotRequired[list[InAppMessageCampaignTypeDef]],  # (1)
  1. See InAppMessageCampaignTypeDef

SendMessagesRequestRequestTypeDef#

# SendMessagesRequestRequestTypeDef definition

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

SendUsersMessagesRequestRequestTypeDef#

# SendUsersMessagesRequestRequestTypeDef definition

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

SegmentResponseTypeDef#

# SegmentResponseTypeDef definition

class SegmentResponseTypeDef(TypedDict):
    ApplicationId: str,
    Arn: str,
    CreationDate: str,
    Id: str,
    SegmentType: SegmentTypeType,  # (4)
    Dimensions: NotRequired[SegmentDimensionsOutputTypeDef],  # (1)
    ImportDefinition: NotRequired[SegmentImportResourceTypeDef],  # (2)
    LastModifiedDate: NotRequired[str],
    Name: NotRequired[str],
    SegmentGroups: NotRequired[SegmentGroupListOutputTypeDef],  # (3)
    tags: NotRequired[dict[str, str]],
    Version: NotRequired[int],
  1. See SegmentDimensionsOutputTypeDef
  2. See SegmentImportResourceTypeDef
  3. See SegmentGroupListOutputTypeDef
  4. See SegmentTypeType

ConditionalSplitActivityOutputTypeDef#

# ConditionalSplitActivityOutputTypeDef definition

class ConditionalSplitActivityOutputTypeDef(TypedDict):
    Condition: NotRequired[ConditionOutputTypeDef],  # (1)
    EvaluationWaitTime: NotRequired[WaitTimeTypeDef],  # (2)
    FalseActivity: NotRequired[str],
    TrueActivity: NotRequired[str],
  1. See ConditionOutputTypeDef
  2. See WaitTimeTypeDef

MultiConditionalSplitActivityOutputTypeDef#

# MultiConditionalSplitActivityOutputTypeDef definition

class MultiConditionalSplitActivityOutputTypeDef(TypedDict):
    Branches: NotRequired[list[MultiConditionalBranchOutputTypeDef]],  # (1)
    DefaultActivity: NotRequired[str],
    EvaluationWaitTime: NotRequired[WaitTimeTypeDef],  # (2)
  1. See MultiConditionalBranchOutputTypeDef
  2. See WaitTimeTypeDef

CampaignResponseTypeDef#

# CampaignResponseTypeDef 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[CustomDeliveryConfigurationOutputTypeDef],  # (2)
    DefaultState: NotRequired[CampaignStateTypeDef],  # (3)
    Description: NotRequired[str],
    HoldoutPercent: NotRequired[int],
    Hook: NotRequired[CampaignHookTypeDef],  # (4)
    IsPaused: NotRequired[bool],
    Limits: NotRequired[CampaignLimitsTypeDef],  # (5)
    MessageConfiguration: NotRequired[MessageConfigurationOutputTypeDef],  # (6)
    Name: NotRequired[str],
    Schedule: NotRequired[ScheduleOutputTypeDef],  # (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 CustomDeliveryConfigurationOutputTypeDef
  3. See CampaignStateTypeDef
  4. See CampaignHookTypeDef
  5. See CampaignLimitsTypeDef
  6. See MessageConfigurationOutputTypeDef
  7. See ScheduleOutputTypeDef
  8. See CampaignStateTypeDef
  9. See TemplateConfigurationTypeDef

GetInAppMessagesResponseTypeDef#

# GetInAppMessagesResponseTypeDef definition

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

ScheduleTypeDef#

# ScheduleTypeDef definition

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

EventStartConditionTypeDef#

# EventStartConditionTypeDef definition

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

SegmentGroupTypeDef#

# SegmentGroupTypeDef definition

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

SimpleConditionTypeDef#

# SimpleConditionTypeDef definition

class SimpleConditionTypeDef(TypedDict):
    EventCondition: NotRequired[EventConditionUnionTypeDef],  # (1)
    SegmentCondition: NotRequired[SegmentConditionTypeDef],  # (2)
    SegmentDimensions: NotRequired[SegmentDimensionsUnionTypeDef],  # (3)
  1. See EventConditionTypeDef EventConditionOutputTypeDef
  2. See SegmentConditionTypeDef
  3. See SegmentDimensionsTypeDef SegmentDimensionsOutputTypeDef

CreateSegmentResponseTypeDef#

# CreateSegmentResponseTypeDef definition

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

DeleteSegmentResponseTypeDef#

# DeleteSegmentResponseTypeDef definition

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

GetSegmentResponseTypeDef#

# GetSegmentResponseTypeDef definition

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

GetSegmentVersionResponseTypeDef#

# GetSegmentVersionResponseTypeDef definition

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

SegmentsResponseTypeDef#

# SegmentsResponseTypeDef definition

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

UpdateSegmentResponseTypeDef#

# UpdateSegmentResponseTypeDef definition

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

ActivityOutputTypeDef#

# ActivityOutputTypeDef definition

class ActivityOutputTypeDef(TypedDict):
    CUSTOM: NotRequired[CustomMessageActivityOutputTypeDef],  # (1)
    ConditionalSplit: NotRequired[ConditionalSplitActivityOutputTypeDef],  # (2)
    Description: NotRequired[str],
    EMAIL: NotRequired[EmailMessageActivityTypeDef],  # (3)
    Holdout: NotRequired[HoldoutActivityTypeDef],  # (4)
    MultiCondition: NotRequired[MultiConditionalSplitActivityOutputTypeDef],  # (5)
    PUSH: NotRequired[PushMessageActivityTypeDef],  # (6)
    RandomSplit: NotRequired[RandomSplitActivityOutputTypeDef],  # (7)
    SMS: NotRequired[SMSMessageActivityTypeDef],  # (8)
    Wait: NotRequired[WaitActivityTypeDef],  # (9)
    ContactCenter: NotRequired[ContactCenterActivityTypeDef],  # (10)
  1. See CustomMessageActivityOutputTypeDef
  2. See ConditionalSplitActivityOutputTypeDef
  3. See EmailMessageActivityTypeDef
  4. See HoldoutActivityTypeDef
  5. See MultiConditionalSplitActivityOutputTypeDef
  6. See PushMessageActivityTypeDef
  7. See RandomSplitActivityOutputTypeDef
  8. See SMSMessageActivityTypeDef
  9. See WaitActivityTypeDef
  10. See ContactCenterActivityTypeDef

CampaignsResponseTypeDef#

# CampaignsResponseTypeDef definition

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

CreateCampaignResponseTypeDef#

# CreateCampaignResponseTypeDef definition

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

DeleteCampaignResponseTypeDef#

# DeleteCampaignResponseTypeDef definition

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

GetCampaignResponseTypeDef#

# GetCampaignResponseTypeDef definition

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

GetCampaignVersionResponseTypeDef#

# GetCampaignVersionResponseTypeDef definition

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

UpdateCampaignResponseTypeDef#

# UpdateCampaignResponseTypeDef definition

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

GetSegmentVersionsResponseTypeDef#

# GetSegmentVersionsResponseTypeDef definition

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

GetSegmentsResponseTypeDef#

# GetSegmentsResponseTypeDef definition

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

JourneyResponseTypeDef#

# JourneyResponseTypeDef definition

class JourneyResponseTypeDef(TypedDict):
    ApplicationId: str,
    Id: str,
    Name: str,
    Activities: NotRequired[dict[str, ActivityOutputTypeDef]],  # (1)
    CreationDate: NotRequired[str],
    LastModifiedDate: NotRequired[str],
    Limits: NotRequired[JourneyLimitsTypeDef],  # (2)
    LocalTime: NotRequired[bool],
    QuietTime: NotRequired[QuietTimeTypeDef],  # (3)
    RefreshFrequency: NotRequired[str],
    Schedule: NotRequired[JourneyScheduleOutputTypeDef],  # (4)
    StartActivity: NotRequired[str],
    StartCondition: NotRequired[StartConditionOutputTypeDef],  # (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[OpenHoursOutputTypeDef],  # (8)
    ClosedDays: NotRequired[ClosedDaysOutputTypeDef],  # (9)
    TimezoneEstimationMethods: NotRequired[list[TimezoneEstimationMethodsElementType]],  # (10)
  1. See ActivityOutputTypeDef
  2. See JourneyLimitsTypeDef
  3. See QuietTimeTypeDef
  4. See JourneyScheduleOutputTypeDef
  5. See StartConditionOutputTypeDef
  6. See StateType
  7. See JourneyChannelSettingsTypeDef
  8. See OpenHoursOutputTypeDef
  9. See ClosedDaysOutputTypeDef
  10. See TimezoneEstimationMethodsElementType

GetCampaignVersionsResponseTypeDef#

# GetCampaignVersionsResponseTypeDef definition

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

GetCampaignsResponseTypeDef#

# GetCampaignsResponseTypeDef definition

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

WriteTreatmentResourceTypeDef#

# WriteTreatmentResourceTypeDef definition

class WriteTreatmentResourceTypeDef(TypedDict):
    SizePercent: int,
    CustomDeliveryConfiguration: NotRequired[CustomDeliveryConfigurationUnionTypeDef],  # (1)
    MessageConfiguration: NotRequired[MessageConfigurationUnionTypeDef],  # (2)
    Schedule: NotRequired[ScheduleUnionTypeDef],  # (3)
    TemplateConfiguration: NotRequired[TemplateConfigurationTypeDef],  # (4)
    TreatmentDescription: NotRequired[str],
    TreatmentName: NotRequired[str],
  1. See CustomDeliveryConfigurationTypeDef CustomDeliveryConfigurationOutputTypeDef
  2. See MessageConfigurationTypeDef MessageConfigurationOutputTypeDef
  3. See ScheduleTypeDef ScheduleOutputTypeDef
  4. See TemplateConfigurationTypeDef

StartConditionTypeDef#

# StartConditionTypeDef definition

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

SegmentGroupListTypeDef#

# SegmentGroupListTypeDef definition

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

ConditionTypeDef#

# ConditionTypeDef definition

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

MultiConditionalBranchTypeDef#

# MultiConditionalBranchTypeDef definition

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

CreateJourneyResponseTypeDef#

# CreateJourneyResponseTypeDef definition

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

DeleteJourneyResponseTypeDef#

# DeleteJourneyResponseTypeDef definition

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

GetJourneyResponseTypeDef#

# GetJourneyResponseTypeDef definition

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

JourneysResponseTypeDef#

# JourneysResponseTypeDef definition

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

UpdateJourneyResponseTypeDef#

# UpdateJourneyResponseTypeDef definition

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

UpdateJourneyStateResponseTypeDef#

# UpdateJourneyStateResponseTypeDef definition

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

WriteCampaignRequestTypeDef#

# WriteCampaignRequestTypeDef definition

class WriteCampaignRequestTypeDef(TypedDict):
    AdditionalTreatments: NotRequired[Sequence[WriteTreatmentResourceTypeDef]],  # (1)
    CustomDeliveryConfiguration: NotRequired[CustomDeliveryConfigurationUnionTypeDef],  # (2)
    Description: NotRequired[str],
    HoldoutPercent: NotRequired[int],
    Hook: NotRequired[CampaignHookTypeDef],  # (3)
    IsPaused: NotRequired[bool],
    Limits: NotRequired[CampaignLimitsTypeDef],  # (4)
    MessageConfiguration: NotRequired[MessageConfigurationUnionTypeDef],  # (5)
    Name: NotRequired[str],
    Schedule: NotRequired[ScheduleUnionTypeDef],  # (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 CustomDeliveryConfigurationOutputTypeDef
  3. See CampaignHookTypeDef
  4. See CampaignLimitsTypeDef
  5. See MessageConfigurationTypeDef MessageConfigurationOutputTypeDef
  6. See ScheduleTypeDef ScheduleOutputTypeDef
  7. See TemplateConfigurationTypeDef

ListJourneysResponseTypeDef#

# ListJourneysResponseTypeDef definition

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

CreateCampaignRequestRequestTypeDef#

# CreateCampaignRequestRequestTypeDef definition

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

UpdateCampaignRequestRequestTypeDef#

# UpdateCampaignRequestRequestTypeDef definition

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

WriteSegmentRequestTypeDef#

# WriteSegmentRequestTypeDef definition

class WriteSegmentRequestTypeDef(TypedDict):
    Dimensions: NotRequired[SegmentDimensionsUnionTypeDef],  # (1)
    Name: NotRequired[str],
    SegmentGroups: NotRequired[SegmentGroupListUnionTypeDef],  # (2)
    tags: NotRequired[Mapping[str, str]],
  1. See SegmentDimensionsTypeDef SegmentDimensionsOutputTypeDef
  2. See SegmentGroupListTypeDef SegmentGroupListOutputTypeDef

ConditionalSplitActivityTypeDef#

# ConditionalSplitActivityTypeDef definition

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

MultiConditionalSplitActivityTypeDef#

# MultiConditionalSplitActivityTypeDef definition

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

CreateSegmentRequestRequestTypeDef#

# CreateSegmentRequestRequestTypeDef definition

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

UpdateSegmentRequestRequestTypeDef#

# UpdateSegmentRequestRequestTypeDef definition

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

ActivityTypeDef#

# ActivityTypeDef definition

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

WriteJourneyRequestTypeDef#

# WriteJourneyRequestTypeDef definition

class WriteJourneyRequestTypeDef(TypedDict):
    Name: str,
    Activities: NotRequired[Mapping[str, ActivityUnionTypeDef]],  # (1)
    CreationDate: NotRequired[str],
    LastModifiedDate: NotRequired[str],
    Limits: NotRequired[JourneyLimitsTypeDef],  # (2)
    LocalTime: NotRequired[bool],
    QuietTime: NotRequired[QuietTimeTypeDef],  # (3)
    RefreshFrequency: NotRequired[str],
    Schedule: NotRequired[JourneyScheduleUnionTypeDef],  # (4)
    StartActivity: NotRequired[str],
    StartCondition: NotRequired[StartConditionUnionTypeDef],  # (5)
    State: NotRequired[StateType],  # (6)
    WaitForQuietTime: NotRequired[bool],
    RefreshOnSegmentUpdate: NotRequired[bool],
    JourneyChannelSettings: NotRequired[JourneyChannelSettingsTypeDef],  # (7)
    SendingSchedule: NotRequired[bool],
    OpenHours: NotRequired[OpenHoursUnionTypeDef],  # (8)
    ClosedDays: NotRequired[ClosedDaysUnionTypeDef],  # (9)
    TimezoneEstimationMethods: NotRequired[Sequence[TimezoneEstimationMethodsElementType]],  # (10)
  1. See ActivityTypeDef ActivityOutputTypeDef
  2. See JourneyLimitsTypeDef
  3. See QuietTimeTypeDef
  4. See JourneyScheduleTypeDef JourneyScheduleOutputTypeDef
  5. See StartConditionTypeDef StartConditionOutputTypeDef
  6. See StateType
  7. See JourneyChannelSettingsTypeDef
  8. See OpenHoursTypeDef OpenHoursOutputTypeDef
  9. See ClosedDaysTypeDef ClosedDaysOutputTypeDef
  10. See TimezoneEstimationMethodsElementType

CreateJourneyRequestRequestTypeDef#

# CreateJourneyRequestRequestTypeDef definition

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

UpdateJourneyRequestRequestTypeDef#

# UpdateJourneyRequestRequestTypeDef definition

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