# Packages
Package pinpointiface provides an interface to enable mocking the Amazon Pinpoint service client for testing your code.
# Functions
Action_Values returns all elements of the Action enum.
Alignment_Values returns all elements of the Alignment enum.
AttributeType_Values returns all elements of the AttributeType enum.
ButtonAction_Values returns all elements of the ButtonAction enum.
CampaignStatus_Values returns all elements of the CampaignStatus enum.
ChannelType_Values returns all elements of the ChannelType enum.
DayOfWeek_Values returns all elements of the DayOfWeek enum.
DeliveryStatus_Values returns all elements of the DeliveryStatus enum.
DimensionType_Values returns all elements of the DimensionType enum.
Duration_Values returns all elements of the Duration enum.
EndpointTypesElement_Values returns all elements of the EndpointTypesElement enum.
FilterType_Values returns all elements of the FilterType enum.
Format_Values returns all elements of the Format enum.
Frequency_Values returns all elements of the Frequency enum.
Include_Values returns all elements of the Include enum.
JobStatus_Values returns all elements of the JobStatus enum.
JourneyRunStatus_Values returns all elements of the JourneyRunStatus enum.
Layout_Values returns all elements of the Layout enum.
MessageType_Values returns all elements of the MessageType enum.
Mode_Values returns all elements of the Mode enum.
New creates a new instance of the Pinpoint client with a session.
Operator_Values returns all elements of the Operator enum.
RecencyType_Values returns all elements of the RecencyType enum.
SegmentType_Values returns all elements of the SegmentType enum.
SourceType_Values returns all elements of the SourceType enum.
State_Values returns all elements of the State enum.
TemplateType_Values returns all elements of the TemplateType enum.
TimezoneEstimationMethodsElement_Values returns all elements of the TimezoneEstimationMethodsElement enum.
Type_Values returns all elements of the Type enum.
# Constants
ActionDeepLink is a Action enum value.
ActionOpenApp is a Action enum value.
ActionUrl is a Action enum value.
AlignmentCenter is a Alignment enum value.
AlignmentLeft is a Alignment enum value.
AlignmentRight is a Alignment enum value.
AttributeTypeAfter is a AttributeType enum value.
AttributeTypeBefore is a AttributeType enum value.
AttributeTypeBetween is a AttributeType enum value.
AttributeTypeContains is a AttributeType enum value.
AttributeTypeExclusive is a AttributeType enum value.
AttributeTypeInclusive is a AttributeType enum value.
AttributeTypeOn is a AttributeType enum value.
ButtonActionClose is a ButtonAction enum value.
ButtonActionDeepLink is a ButtonAction enum value.
ButtonActionLink is a ButtonAction enum value.
CampaignStatusCompleted is a CampaignStatus enum value.
CampaignStatusDeleted is a CampaignStatus enum value.
CampaignStatusExecuting is a CampaignStatus enum value.
CampaignStatusInvalid is a CampaignStatus enum value.
CampaignStatusPaused is a CampaignStatus enum value.
CampaignStatusPendingNextRun is a CampaignStatus enum value.
CampaignStatusScheduled is a CampaignStatus enum value.
ChannelTypeAdm is a ChannelType enum value.
ChannelTypeApns is a ChannelType enum value.
ChannelTypeApnsSandbox is a ChannelType enum value.
ChannelTypeApnsVoip is a ChannelType enum value.
ChannelTypeApnsVoipSandbox is a ChannelType enum value.
ChannelTypeBaidu is a ChannelType enum value.
ChannelTypeCustom is a ChannelType enum value.
ChannelTypeEmail is a ChannelType enum value.
ChannelTypeGcm is a ChannelType enum value.
ChannelTypeInApp is a ChannelType enum value.
ChannelTypePush is a ChannelType enum value.
ChannelTypeSms is a ChannelType enum value.
ChannelTypeVoice is a ChannelType enum value.
DayOfWeekFriday is a DayOfWeek enum value.
DayOfWeekMonday is a DayOfWeek enum value.
DayOfWeekSaturday is a DayOfWeek enum value.
DayOfWeekSunday is a DayOfWeek enum value.
DayOfWeekThursday is a DayOfWeek enum value.
DayOfWeekTuesday is a DayOfWeek enum value.
DayOfWeekWednesday is a DayOfWeek enum value.
DeliveryStatusDuplicate is a DeliveryStatus enum value.
DeliveryStatusOptOut is a DeliveryStatus enum value.
DeliveryStatusPermanentFailure is a DeliveryStatus enum value.
DeliveryStatusSuccessful is a DeliveryStatus enum value.
DeliveryStatusTemporaryFailure is a DeliveryStatus enum value.
DeliveryStatusThrottled is a DeliveryStatus enum value.
DeliveryStatusUnknownFailure is a DeliveryStatus enum value.
DimensionTypeExclusive is a DimensionType enum value.
DimensionTypeInclusive is a DimensionType enum value.
DurationDay14 is a Duration enum value.
DurationDay30 is a Duration enum value.
DurationDay7 is a Duration enum value.
DurationHr24 is a Duration enum value.
ID to lookup a service endpoint with.
EndpointTypesElementAdm is a EndpointTypesElement enum value.
EndpointTypesElementApns is a EndpointTypesElement enum value.
EndpointTypesElementApnsSandbox is a EndpointTypesElement enum value.
EndpointTypesElementApnsVoip is a EndpointTypesElement enum value.
EndpointTypesElementApnsVoipSandbox is a EndpointTypesElement enum value.
EndpointTypesElementBaidu is a EndpointTypesElement enum value.
EndpointTypesElementCustom is a EndpointTypesElement enum value.
EndpointTypesElementEmail is a EndpointTypesElement enum value.
EndpointTypesElementGcm is a EndpointTypesElement enum value.
EndpointTypesElementInApp is a EndpointTypesElement enum value.
EndpointTypesElementPush is a EndpointTypesElement enum value.
EndpointTypesElementSms is a EndpointTypesElement enum value.
EndpointTypesElementVoice is a EndpointTypesElement enum value.
ErrCodeBadRequestException for service response error code "BadRequestException".
ErrCodeConflictException for service response error code "ConflictException".
ErrCodeForbiddenException for service response error code "ForbiddenException".
ErrCodeInternalServerErrorException for service response error code "InternalServerErrorException".
ErrCodeMethodNotAllowedException for service response error code "MethodNotAllowedException".
ErrCodeNotFoundException for service response error code "NotFoundException".
ErrCodePayloadTooLargeException for service response error code "PayloadTooLargeException".
ErrCodeTooManyRequestsException for service response error code "TooManyRequestsException".
FilterTypeEndpoint is a FilterType enum value.
FilterTypeSystem is a FilterType enum value.
FormatCsv is a Format enum value.
FormatJson is a Format enum value.
FrequencyDaily is a Frequency enum value.
FrequencyEvent is a Frequency enum value.
FrequencyHourly is a Frequency enum value.
FrequencyInAppEvent is a Frequency enum value.
FrequencyMonthly is a Frequency enum value.
FrequencyOnce is a Frequency enum value.
FrequencyWeekly is a Frequency enum value.
IncludeAll is a Include enum value.
IncludeAny is a Include enum value.
IncludeNone is a Include enum value.
JobStatusCompleted is a JobStatus enum value.
JobStatusCompleting is a JobStatus enum value.
JobStatusCreated is a JobStatus enum value.
JobStatusFailed is a JobStatus enum value.
JobStatusFailing is a JobStatus enum value.
JobStatusInitializing is a JobStatus enum value.
JobStatusPendingJob is a JobStatus enum value.
JobStatusPreparingForInitialization is a JobStatus enum value.
JobStatusProcessing is a JobStatus enum value.
JourneyRunStatusCancelled is a JourneyRunStatus enum value.
JourneyRunStatusCompleted is a JourneyRunStatus enum value.
JourneyRunStatusRunning is a JourneyRunStatus enum value.
JourneyRunStatusScheduled is a JourneyRunStatus enum value.
LayoutBottomBanner is a Layout enum value.
LayoutCarousel is a Layout enum value.
LayoutMiddleBanner is a Layout enum value.
LayoutMobileFeed is a Layout enum value.
LayoutOverlays is a Layout enum value.
LayoutTopBanner is a Layout enum value.
MessageTypePromotional is a MessageType enum value.
MessageTypeTransactional is a MessageType enum value.
ModeDelivery is a Mode enum value.
ModeFilter is a Mode enum value.
OperatorAll is a Operator enum value.
OperatorAny is a Operator enum value.
RecencyTypeActive is a RecencyType enum value.
RecencyTypeInactive is a RecencyType enum value.
SegmentTypeDimensional is a SegmentType enum value.
SegmentTypeImport is a SegmentType enum value.
ServiceID is a unique identifier of a specific service.
Name of service.
SourceTypeAll is a SourceType enum value.
SourceTypeAny is a SourceType enum value.
SourceTypeNone is a SourceType enum value.
StateActive is a State enum value.
StateCancelled is a State enum value.
StateClosed is a State enum value.
StateCompleted is a State enum value.
StateDraft is a State enum value.
StatePaused is a State enum value.
TemplateTypeEmail is a TemplateType enum value.
TemplateTypeInapp is a TemplateType enum value.
TemplateTypePush is a TemplateType enum value.
TemplateTypeSms is a TemplateType enum value.
TemplateTypeVoice is a TemplateType enum value.
TimezoneEstimationMethodsElementPhoneNumber is a TimezoneEstimationMethodsElement enum value.
TimezoneEstimationMethodsElementPostalCode is a TimezoneEstimationMethodsElement enum value.
TypeAll is a Type enum value.
TypeAny is a Type enum value.
TypeNone is a Type enum value.
# Structs
Provides information about the activities that were performed by a campaign.
Specifies the configuration and other settings for an activity in a journey.
Provides information about an activity that was performed by a campaign.
Specifies address-based configuration settings for a message that's sent directly to an endpoint.
Specifies the status and settings of the ADM (Amazon Device Messaging) channel for an application.
Provides information about the status and settings of the ADM (Amazon Device Messaging) channel for an application.
Specifies the settings for a one-time message that's sent directly to an endpoint through the ADM (Amazon Device Messaging) channel.
Specifies channel-specific content and settings for a message template that can be used in push notifications that are sent through the ADM (Amazon Device Messaging), Baidu (Baidu Cloud Push), or GCM (Firebase Cloud Messaging, formerly Google Cloud Messaging) channel.
Specifies the status and settings of the APNs (Apple Push Notification service) channel for an application.
Provides information about the status and settings of the APNs (Apple Push Notification service) channel for an application.
Specifies the settings for a one-time message that's sent directly to an endpoint through the APNs (Apple Push Notification service) channel.
Specifies channel-specific content and settings for a message template that can be used in push notifications that are sent through the APNs (Apple Push Notification service) channel.
Specifies the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.
Provides information about the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.
Specifies the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.
Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.
Specifies the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.
Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.
Provides the results of a query that retrieved the data for a standard metric that applies to an application, and provides information about that query.
Provides information about an application.
The default sending limits for journeys in the application.
Provides information about an application, including the default settings for an application.
Provides information about all of your applications.
Specifies attribute-based criteria for including or excluding endpoints from a segment.
Provides information about the type and the names of attributes that were removed from all the endpoints that are associated with an application.
Provides information about an API request or response.
Specifies the status and settings of the Baidu (Baidu Cloud Push) channel for an application.
Provides information about the status and settings of the Baidu (Baidu Cloud Push) channel for an application.
Specifies the settings for a one-time message that's sent directly to an endpoint through the Baidu (Baidu Cloud Push) channel.
Provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey.
Specifies the contents of a message that's sent through a custom channel to recipients of a campaign.
Provides the results of a query that retrieved the data for a standard metric that applies to a campaign, and provides information about that query.
Specifies the content and "From" address for an email message that's sent to recipients of a campaign.
Specifies the settings for events that cause a campaign to be sent.
Specifies settings for invoking an AWS Lambda function that customizes a segment for a campaign.
In-app message configuration.
For a campaign, specifies limits on the messages that the campaign can send.
Provides information about the status, configuration, and other settings for a campaign.
Specifies the content and settings for an SMS message that's sent to recipients of a campaign.
Provides information about the configuration and other settings for all the campaigns that are associated with an application.
Provides information about the status of a campaign.
Provides information about the general settings and status of a channel for an application.
Provides information about the general settings and status of all channels for an application, including channels that aren't enabled for the application.
The time when a journey will not send messages.
Specifies the rule settings for when messages can't be sent.
Specifies the conditions to evaluate for an activity in a journey, and how to evaluate those conditions.
Specifies the settings for a yes/no split activity in a journey.
Provides information about an API request or response.
The settings for a connect activity.
Specifies the display name of an application and the tags to associate with the application.
Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.
Provides information about a request to create a message template.
Specifies the delivery configuration settings for sending a campaign or campaign treatment through a custom channel.
The settings for a custom message activity.
Default button configuration.
Specifies the default message for all channels.
Specifies the default settings and content for a push notification that's sent directly to an endpoint.
Specifies the default settings and content for a message template that can be used in messages that are sent through a push notification channel.
Specifies the settings and content for the default message and any default messages that you tailored for specific channels.
Specifies the status and settings of the email channel for an application.
Provides information about the status and settings of the email channel for an application.
Specifies the default settings and content for a one-time email message that's sent directly to an endpoint.
Specifies the settings for an email activity in a journey.
Specifies the content and settings for a message template that can be used in messages that are sent through the email channel.
Provides information about the content and settings for a message template that can be used in messages that are sent through the email channel.
Specifies an endpoint to create or update and the settings and attributes to set or change for the endpoint.
Specifies a batch of endpoints to create or update and the settings and attributes to set or change for each endpoint.
Specifies demographic information about an endpoint, such as the applicable time zone and platform.
Provides the status code and message that result from processing data for an endpoint.
Specifies geographic information about an endpoint.
Provides information about the delivery status and results of sending a message directly to an endpoint.
Specifies the channel type and other settings for an endpoint.
Provides information about the channel type and other settings for an endpoint.
Specifies the content, including message variables and attributes, to use in a message that's sent directly to an endpoint.
Provides information about all the endpoints that are associated with a user ID.
Specifies data for one or more attributes that describe the user who's associated with an endpoint.
Specifies information about an event that reports data to Amazon Pinpoint.
Specifies the conditions to evaluate for an event that applies to an activity in a journey.
Specifies the dimensions for an event filter that determines when a campaign is sent or a journey activity is performed.
Specifies the settings for an event that causes a campaign to be sent or a journey activity to be performed.
Provides the status code and message that result from processing an event.
Specifies a batch of endpoints and events to process.
Specifies a batch of events to process.
Provides information about endpoints and the events that they're associated with.
Specifies the settings for an event that causes a journey activity to start.
Specifies settings for publishing event data to an Amazon Kinesis data stream or an Amazon Kinesis Data Firehose delivery stream.
Specifies the settings for a job that exports endpoint definitions to an Amazon Simple Storage Service (Amazon S3) bucket.
Provides information about the resource settings for a job that exports endpoint definitions to a file.
Provides information about the status and settings of a job that exports endpoint definitions to a file.
Provides information about all the export jobs that are associated with an application or segment.
Provides information about an API request or response.
Specifies the status and settings of the GCM channel for an application.
Provides information about the status and settings of the GCM channel for an application.
Specifies the settings for a one-time message that's sent directly to an endpoint through the GCM channel.
Specifies the GPS coordinates of a location.
Specifies GPS-based criteria for including or excluding endpoints from a segment.
Specifies the settings for a holdout activity in a journey.
Specifies the settings for a job that imports endpoint definitions from an Amazon Simple Storage Service (Amazon S3) bucket.
Provides information about the resource settings for a job that imports endpoint definitions from one or more files.
Provides information about the status and settings of a job that imports endpoint definitions from one or more files.
Provides information about the status and settings of all the import jobs that are associated with an application or segment.
Provides all fields required for building an in-app message.
Text config for Message Body.
Button Config for an in-app message.
The configuration for the message content.
Text config for Message Header.
Get in-app messages response object.
In-App Template Request.
In-App Template Response.
Provides information about an API request or response.
Provides information about the results of a request to create or update an endpoint that's associated with an event.
The channel-specific configurations for the journey.
Specifies the message content for a custom channel message that's sent to participants in a journey.
Provides the results of a query that retrieved the data for a standard engagement metric that applies to a journey, and provides information about that query.
Specifies the "From" address for an email message that's sent to participants in a journey.
Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey activity, and provides information about that query.
Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey, and provides information about that query.
Specifies limits on the messages that a journey can send and the number of times participants can enter a journey.
Specifies the message configuration for a push notification that's sent to participants in a journey.
Provides information about the status, configuration, and other settings for a journey.
Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey activity for a particular journey run, and provides information about that query.
Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey run, and provides information about that query.
Provides information from a specified run of a journey.
Provides information from all runs of a journey.
Specifies the schedule settings for a journey.
Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.
Provides information about the status, configuration, and other settings for all the journeys that are associated with an application.
Changes the status of a journey.
The number of messages that can be sent to an endpoint during the specified timeframe for all journeys.
Provides information about all the recommender model configurations that are associated with your Amazon Pinpoint account.
Specifies the content and settings for a push notification that's sent to recipients of a campaign.
Provides information about an API request or response.
Specifies the message configuration settings for a campaign.
Contains the name and value pair of an email header to add to your email.
Specifies the configuration and other settings for a message.
Provides information about the results of a request to send a message to an endpoint address.
Provides information about the results of sending a message directly to an endpoint address.
Provides information about an API request or response.
Specifies metric-based criteria for including or excluding endpoints from a segment.
Specifies a condition to evaluate for an activity path in a journey.
Specifies the settings for a multivariate split activity in a journey.
Provides information about an API request or response.
Specifies a phone number to validate and retrieve information about.
Provides information about a phone number.
Specifies the times when message are allowed to be sent to endpoints.
Specifies the start and end time for OpenHours.
Override button configuration.
Provides information about an API request or response.
Pinpoint provides the API operation methods for making requests to Amazon Pinpoint.
Specifies the properties and attributes of an endpoint that's associated with an event.
Specifies the settings for a push notification activity in a journey.
Specifies the content and settings for a message template that can be used in messages that are sent through a push notification channel.
Provides information about the content and settings for a message template that can be used in messages that are sent through a push notification channel.
Specifies the start and end times that define a time range when messages aren't sent to endpoints.
Specifies the settings for a random split activity in a journey.
Specifies the settings for a path in a random split activity in a journey.
Specifies the contents of an email message, represented as a raw MIME message.
Specifies criteria for including or excluding endpoints from a segment based on how recently an endpoint was active.
Provides information about Amazon Pinpoint configuration settings for retrieving and processing data from a recommender model.
Provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey.
Provides a single value and metadata about that value as part of an array of query results for a standard metric that applies to an application, campaign, or journey.
Specifies the schedule settings for a campaign.
Specifies dimension settings for including or excluding endpoints from a segment based on how recently an endpoint was active.
Specifies a segment to associate with an activity in a journey.
Specifies demographic-based dimension settings for including or excluding endpoints from a segment.
Specifies the dimension settings for a segment.
Specifies the base segments and dimensions for a segment, and the relationships between these base segments and dimensions.
Specifies the settings that define the relationships between segment groups for a segment.
Provides information about the import job that created a segment.
Specifies geographical dimension settings for a segment.
Specifies the segment identifier and version of a segment.
Provides information about the configuration, dimension, and other settings for a segment.
Provides information about all the segments that are associated with an application.
Send OTP message request parameters.
Specifies the configuration and other settings for a message to send to all the endpoints that are associated with a list of users.
Provides information about which users and endpoints a message was sent to.
Provides information about a session.
Specifies the dimension type and values for a segment dimension.
Specifies a condition to evaluate for an activity in a journey.
Specifies the contents of an email message, composed of a subject, a text part, and an HTML part.
Specifies the subject or body of an email message, represented as textual email data and the applicable character set.
Specifies the status and settings of the SMS channel for an application.
Provides information about the status and settings of the SMS channel for an application.
Specifies the default settings for a one-time SMS message that's sent directly to an endpoint.
Specifies the settings for an SMS activity in a journey.
Specifies the content and settings for a message template that can be used in text messages that are sent through the SMS channel.
Provides information about the content and settings for a message template that can be used in text messages that are sent through the SMS channel.
Specifies the conditions for the first activity in a journey.
Specifies the tags (keys and values) for an application, campaign, message template, or segment.
Specifies the name and version of the message template to use for the message.
Specifies which version of a message template to use as the active version of the template.
Specifies the message template to use for the message, for each type of channel.
Provides information about a request to create a message template.
Provides information about a message template that's associated with your Amazon Pinpoint account.
Provides information about all the message templates that are associated with your Amazon Pinpoint account.
Provides information about a specific version of a message template.
Provides information about all the versions of a specific message template.
Provides information about an API request or response.
Specifies the settings for a campaign treatment.
Specifies one or more attributes to remove from all the endpoints that are associated with an application.
Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.
Verify OTP Message Response.
Verify OTP message request.
Specifies the status and settings of the voice channel for an application.
Provides information about the status and settings of the voice channel for an application.
Specifies the settings for a one-time voice message that's sent directly to an endpoint through the voice channel.
Specifies the content and settings for a message template that can be used in messages that are sent through the voice channel.
Provides information about the content and settings for a message template that can be used in messages that are sent through the voice channel.
Specifies the settings for a wait activity in a journey.
Specifies a duration or a date and time that indicates when Amazon Pinpoint determines whether an activity's conditions have been met or an activity moves participants to the next activity in a journey.
Specifies the default settings for an application.
Specifies the configuration and other settings for a campaign.
Specifies the Amazon Resource Name (ARN) of an event stream to publish events to and the AWS Identity and Access Management (IAM) role to use when publishing those events.
Specifies the configuration and other settings for a journey.
Specifies the configuration, dimension, and other settings for a segment.
Specifies the settings for a campaign treatment.