pinpoint-2016-12-01 library Null safety

Classes

ActivitiesResponse
Provides information about the activities that were performed by a campaign.
Activity
Specifies the configuration and other settings for an activity in a journey.
ActivityResponse
Provides information about an activity that was performed by a campaign.
AddressConfiguration
Specifies address-based configuration settings for a message that's sent directly to an endpoint.
ADMChannelRequest
Specifies the status and settings of the ADM (Amazon Device Messaging) channel for an application.
ADMChannelResponse
Provides information about the status and settings of the ADM (Amazon Device Messaging) channel for an application.
ADMMessage
Specifies the settings for a one-time message that's sent directly to an endpoint through the ADM (Amazon Device Messaging) channel.
AndroidPushNotificationTemplate
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.
APNSChannelRequest
Specifies the status and settings of the APNs (Apple Push Notification service) channel for an application.
APNSChannelResponse
Provides information about the status and settings of the APNs (Apple Push Notification service) channel for an application.
APNSMessage
Specifies the settings for a one-time message that's sent directly to an endpoint through the APNs (Apple Push Notification service) channel.
APNSPushNotificationTemplate
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.
APNSSandboxChannelRequest
Specifies the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.
APNSSandboxChannelResponse
Provides information about the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.
APNSVoipChannelRequest
Specifies the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.
APNSVoipChannelResponse
Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.
APNSVoipSandboxChannelRequest
Specifies the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.
APNSVoipSandboxChannelResponse
Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.
ApplicationDateRangeKpiResponse
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.
ApplicationResponse
Provides information about an application.
ApplicationSettingsResource
Provides information about an application, including the default settings for an application.
ApplicationsResponse
Provides information about all of your applications.
AttributeDimension
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributesResource
Provides information about the type and the names of attributes that were removed from all the endpoints that are associated with an application.
AwsClientCredentials
AWS credentials.
BaiduChannelRequest
Specifies the status and settings of the Baidu (Baidu Cloud Push) channel for an application.
BaiduChannelResponse
Provides information about the status and settings of the Baidu (Baidu Cloud Push) channel for an application.
BaiduMessage
Specifies the settings for a one-time message that's sent directly to an endpoint through the Baidu (Baidu Cloud Push) channel.
BaseKpiResult
Provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey.
CampaignCustomMessage
Specifies the contents of a message that's sent through a custom channel to recipients of a campaign.
CampaignDateRangeKpiResponse
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.
CampaignEmailMessage
Specifies the content and "From" address for an email message that's sent to recipients of a campaign.
CampaignEventFilter
Specifies the settings for events that cause a campaign to be sent.
CampaignHook
Specifies settings for invoking an AWS Lambda function that customizes a segment for a campaign.
CampaignLimits
For a campaign, specifies limits on the messages that the campaign can send. For an application, specifies the default limits for messages that campaigns in the application can send.
CampaignResponse
Provides information about the status, configuration, and other settings for a campaign.
CampaignSmsMessage
Specifies the content and settings for an SMS message that's sent to recipients of a campaign.
CampaignsResponse
Provides information about the configuration and other settings for all the campaigns that are associated with an application.
CampaignState
Provides information about the status of a campaign.
ChannelResponse
Provides information about the general settings and status of a channel for an application.
ChannelsResponse
Provides information about the general settings and status of all channels for an application, including channels that aren't enabled for the application.
Condition
Specifies the conditions to evaluate for an activity in a journey, and how to evaluate those conditions.
ConditionalSplitActivity
Specifies the settings for a yes/no split activity in a journey. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.
CreateApplicationRequest
Specifies the display name of an application and the tags to associate with the application.
CreateAppResponse
CreateCampaignResponse
CreateEmailTemplateResponse
CreateExportJobResponse
CreateImportJobResponse
CreateJourneyResponse
CreatePushTemplateResponse
CreateRecommenderConfiguration
Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.
CreateRecommenderConfigurationResponse
CreateSegmentResponse
CreateSmsTemplateResponse
CreateTemplateMessageBody
Provides information about a request to create a message template.
CreateVoiceTemplateResponse
CustomDeliveryConfiguration
Specifies the delivery configuration settings for sending a campaign or campaign treatment through a custom channel. This object is required if you use the CampaignCustomMessage object to define the message to send for the campaign or campaign treatment.
CustomMessageActivity
The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.
DefaultMessage
Specifies the default message for all channels.
DefaultPushNotificationMessage
Specifies the default settings and content for a push notification that's sent directly to an endpoint.
DefaultPushNotificationTemplate
Specifies the default settings and content for a message template that can be used in messages that are sent through a push notification channel.
DeleteAdmChannelResponse
DeleteApnsChannelResponse
DeleteApnsSandboxChannelResponse
DeleteApnsVoipChannelResponse
DeleteApnsVoipSandboxChannelResponse
DeleteAppResponse
DeleteBaiduChannelResponse
DeleteCampaignResponse
DeleteEmailChannelResponse
DeleteEmailTemplateResponse
DeleteEndpointResponse
DeleteEventStreamResponse
DeleteGcmChannelResponse
DeleteJourneyResponse
DeletePushTemplateResponse
DeleteRecommenderConfigurationResponse
DeleteSegmentResponse
DeleteSmsChannelResponse
DeleteSmsTemplateResponse
DeleteUserEndpointsResponse
DeleteVoiceChannelResponse
DeleteVoiceTemplateResponse
DirectMessageConfiguration
Specifies the settings and content for the default message and any default messages that you tailored for specific channels.
EmailChannelRequest
Specifies the status and settings of the email channel for an application.
EmailChannelResponse
Provides information about the status and settings of the email channel for an application.
EmailMessage
Specifies the default settings and content for a one-time email message that's sent directly to an endpoint.
EmailMessageActivity
Specifies the settings for an email activity in a journey. This type of activity sends an email message to participants.
EmailTemplateRequest
Specifies the content and settings for a message template that can be used in messages that are sent through the email channel.
EmailTemplateResponse
Provides information about the content and settings for a message template that can be used in messages that are sent through the email channel.
EndpointBatchItem
Specifies an endpoint to create or update and the settings and attributes to set or change for the endpoint.
EndpointBatchRequest
Specifies a batch of endpoints to create or update and the settings and attributes to set or change for each endpoint.
EndpointDemographic
Specifies demographic information about an endpoint, such as the applicable time zone and platform.
EndpointItemResponse
Provides the status code and message that result from processing data for an endpoint.
EndpointLocation
Specifies geographic information about an endpoint.
EndpointMessageResult
Provides information about the delivery status and results of sending a message directly to an endpoint.
EndpointRequest
Specifies the channel type and other settings for an endpoint.
EndpointResponse
Provides information about the channel type and other settings for an endpoint.
EndpointSendConfiguration
Specifies the content, including message variables and attributes, to use in a message that's sent directly to an endpoint.
EndpointsResponse
Provides information about all the endpoints that are associated with a user ID.
EndpointUser
Specifies data for one or more attributes that describe the user who's associated with an endpoint.
Event
Specifies information about an event that reports data to Amazon Pinpoint.
EventCondition
Specifies the conditions to evaluate for an event that applies to an activity in a journey.
EventDimensions
Specifies the dimensions for an event filter that determines when a campaign is sent or a journey activity is performed.
EventFilter
Specifies the settings for an event that causes a campaign to be sent or a journey activity to be performed.
EventItemResponse
Provides the status code and message that result from processing an event.
EventsBatch
Specifies a batch of endpoints and events to process.
EventsRequest
Specifies a batch of events to process.
EventsResponse
Provides information about endpoints and the events that they're associated with.
EventStartCondition
Specifies the settings for an event that causes a journey activity to start.
EventStream
Specifies settings for publishing event data to an Amazon Kinesis data stream or an Amazon Kinesis Data Firehose delivery stream.
ExportJobRequest
Specifies the settings for a job that exports endpoint definitions to an Amazon Simple Storage Service (Amazon S3) bucket.
ExportJobResource
Provides information about the resource settings for a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or downloaded directly to a computer by using the Amazon Pinpoint console.
ExportJobResponse
Provides information about the status and settings of a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or downloaded directly to a computer by using the Amazon Pinpoint console.
ExportJobsResponse
Provides information about all the export jobs that are associated with an application or segment. An export job is a job that exports endpoint definitions to a file.
GCMChannelRequest
Specifies the status and settings of the GCM channel for an application. This channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.
GCMChannelResponse
Provides information about the status and settings of the GCM channel for an application. The GCM channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.
GCMMessage
Specifies the settings for a one-time message that's sent directly to an endpoint through the GCM channel. The GCM channel enables Amazon Pinpoint to send messages to the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.
GetAdmChannelResponse
GetApnsChannelResponse
GetApnsSandboxChannelResponse
GetApnsVoipChannelResponse
GetApnsVoipSandboxChannelResponse
GetApplicationDateRangeKpiResponse
GetApplicationSettingsResponse
GetAppResponse
GetAppsResponse
GetBaiduChannelResponse
GetCampaignActivitiesResponse
GetCampaignDateRangeKpiResponse
GetCampaignResponse
GetCampaignsResponse
GetCampaignVersionResponse
GetCampaignVersionsResponse
GetChannelsResponse
GetEmailChannelResponse
GetEmailTemplateResponse
GetEndpointResponse
GetEventStreamResponse
GetExportJobResponse
GetExportJobsResponse
GetGcmChannelResponse
GetImportJobResponse
GetImportJobsResponse
GetJourneyDateRangeKpiResponse
GetJourneyExecutionActivityMetricsResponse
GetJourneyExecutionMetricsResponse
GetJourneyResponse
GetPushTemplateResponse
GetRecommenderConfigurationResponse
GetRecommenderConfigurationsResponse
GetSegmentExportJobsResponse
GetSegmentImportJobsResponse
GetSegmentResponse
GetSegmentsResponse
GetSegmentVersionResponse
GetSegmentVersionsResponse
GetSmsChannelResponse
GetSmsTemplateResponse
GetUserEndpointsResponse
GetVoiceChannelResponse
GetVoiceTemplateResponse
GPSCoordinates
Specifies the GPS coordinates of a location.
GPSPointDimension
Specifies GPS-based criteria for including or excluding endpoints from a segment.
HoldoutActivity
Specifies the settings for a holdout activity in a journey. This type of activity stops a journey for a specified percentage of participants.
ImportJobRequest
Specifies the settings for a job that imports endpoint definitions from an Amazon Simple Storage Service (Amazon S3) bucket.
ImportJobResource
Provides information about the resource settings for a job that imports endpoint definitions from one or more files. The files can be stored in an Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from a computer by using the Amazon Pinpoint console.
ImportJobResponse
Provides information about the status and settings of a job that imports endpoint definitions from one or more files. The files can be stored in an Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from a computer by using the Amazon Pinpoint console.
ImportJobsResponse
Provides information about the status and settings of all the import jobs that are associated with an application or segment. An import job is a job that imports endpoint definitions from one or more files.
ItemResponse
Provides information about the results of a request to create or update an endpoint that's associated with an event.
JourneyCustomMessage
Specifies the message content for a custom channel message that's sent to participants in a journey.
JourneyDateRangeKpiResponse
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.
JourneyEmailMessage
Specifies the "From" address for an email message that's sent to participants in a journey.
JourneyExecutionActivityMetricsResponse
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.
JourneyExecutionMetricsResponse
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.
JourneyLimits
Specifies limits on the messages that a journey can send and the number of times participants can enter a journey.
JourneyPushMessage
Specifies the message configuration for a push notification that's sent to participants in a journey.
JourneyResponse
Provides information about the status, configuration, and other settings for a journey.
JourneySchedule
Specifies the schedule settings for a journey.
JourneySMSMessage
Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.
JourneysResponse
Provides information about the status, configuration, and other settings for all the journeys that are associated with an application.
JourneyStateRequest
Changes the status of a journey.
ListJourneysResponse
ListRecommenderConfigurationsResponse
Provides information about all the recommender model configurations that are associated with your Amazon Pinpoint account.
ListTagsForResourceResponse
ListTemplatesResponse
ListTemplateVersionsResponse
Message
Specifies the content and settings for a push notification that's sent to recipients of a campaign.
MessageBody
Provides information about an API request or response.
MessageConfiguration
Specifies the message configuration settings for a campaign.
MessageRequest
Specifies the configuration and other settings for a message.
MessageResponse
Provides information about the results of a request to send a message to an endpoint address.
MessageResult
Provides information about the results of sending a message directly to an endpoint address.
MetricDimension
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
MultiConditionalBranch
Specifies a condition to evaluate for an activity path in a journey.
MultiConditionalSplitActivity
Specifies the settings for a multivariate split activity in a journey. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify.
NumberValidateRequest
Specifies a phone number to validate and retrieve information about.
NumberValidateResponse
Provides information about a phone number.
PhoneNumberValidateResponse
Pinpoint
Doc Engage API - Amazon Pinpoint API
PublicEndpoint
Specifies the properties and attributes of an endpoint that's associated with an event.
PushMessageActivity
Specifies the settings for a push notification activity in a journey. This type of activity sends a push notification to participants.
PushNotificationTemplateRequest
Specifies the content and settings for a message template that can be used in messages that are sent through a push notification channel.
PushNotificationTemplateResponse
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.
PutEventsResponse
PutEventStreamResponse
QuietTime
Specifies the start and end times that define a time range when messages aren't sent to endpoints.
RandomSplitActivity
Specifies the settings for a random split activity in a journey. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.
RandomSplitEntry
Specifies the settings for a path in a random split activity in a journey.
RawEmail
Specifies the contents of an email message, represented as a raw MIME message.
RecencyDimension
Specifies criteria for including or excluding endpoints from a segment based on how recently an endpoint was active.
RecommenderConfigurationResponse
Provides information about Amazon Pinpoint configuration settings for retrieving and processing data from a recommender model.
RemoveAttributesResponse
ResultRow
Provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey.
ResultRowValue
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.
Schedule
Specifies the schedule settings for a campaign.
SegmentBehaviors
Specifies dimension settings for including or excluding endpoints from a segment based on how recently an endpoint was active.
SegmentCondition
Specifies a segment to associate with an activity in a journey.
SegmentDemographics
Specifies demographic-based dimension settings for including or excluding endpoints from a segment. These settings derive from characteristics of endpoint devices, such as platform, make, and model.
SegmentDimensions
Specifies the dimension settings for a segment.
SegmentGroup
Specifies the base segments and dimensions for a segment, and the relationships between these base segments and dimensions.
SegmentGroupList
Specifies the settings that define the relationships between segment groups for a segment.
SegmentImportResource
Provides information about the import job that created a segment. An import job is a job that creates a user segment by importing endpoint definitions.
SegmentLocation
Specifies geographical dimension settings for a segment.
SegmentReference
Specifies the segment identifier and version of a segment.
SegmentResponse
Provides information about the configuration, dimension, and other settings for a segment.
SegmentsResponse
Provides information about all the segments that are associated with an application.
SendMessagesResponse
SendUsersMessageRequest
Specifies the configuration and other settings for a message to send to all the endpoints that are associated with a list of users.
SendUsersMessageResponse
Provides information about which users and endpoints a message was sent to.
SendUsersMessagesResponse
Session
Provides information about a session.
SetDimension
Specifies the dimension type and values for a segment dimension.
SimpleCondition
Specifies a condition to evaluate for an activity in a journey.
SimpleEmail
Specifies the contents of an email message, composed of a subject, a text part, and an HTML part.
SimpleEmailPart
Specifies the subject or body of an email message, represented as textual email data and the applicable character set.
SMSChannelRequest
Specifies the status and settings of the SMS channel for an application.
SMSChannelResponse
Provides information about the status and settings of the SMS channel for an application.
SMSMessage
Specifies the default settings for a one-time SMS message that's sent directly to an endpoint.
SMSMessageActivity
Specifies the settings for an SMS activity in a journey. This type of activity sends a text message to participants.
SMSTemplateRequest
Specifies the content and settings for a message template that can be used in text messages that are sent through the SMS channel.
SMSTemplateResponse
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.
StartCondition
Specifies the conditions for the first activity in a journey. This activity and its conditions determine which users are participants in a journey.
TagsModel
Specifies the tags (keys and values) for an application, campaign, message template, or segment.
Template
Specifies the name and version of the message template to use for the message.
TemplateActiveVersionRequest
Specifies which version of a message template to use as the active version of the template.
TemplateConfiguration
Specifies the message template to use for the message, for each type of channel.
TemplateResponse
Provides information about a message template that's associated with your Amazon Pinpoint account.
TemplatesResponse
Provides information about all the message templates that are associated with your Amazon Pinpoint account.
TemplateVersionResponse
Provides information about a specific version of a message template.
TemplateVersionsResponse
Provides information about all the versions of a specific message template.
TreatmentResource
Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
UpdateAdmChannelResponse
UpdateApnsChannelResponse
UpdateApnsSandboxChannelResponse
UpdateApnsVoipChannelResponse
UpdateApnsVoipSandboxChannelResponse
UpdateApplicationSettingsResponse
UpdateAttributesRequest
Specifies one or more attributes to remove from all the endpoints that are associated with an application.
UpdateBaiduChannelResponse
UpdateCampaignResponse
UpdateEmailChannelResponse
UpdateEmailTemplateResponse
UpdateEndpointResponse
UpdateEndpointsBatchResponse
UpdateGcmChannelResponse
UpdateJourneyResponse
UpdateJourneyStateResponse
UpdatePushTemplateResponse
UpdateRecommenderConfiguration
Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.
UpdateRecommenderConfigurationResponse
UpdateSegmentResponse
UpdateSmsChannelResponse
UpdateSmsTemplateResponse
UpdateTemplateActiveVersionResponse
UpdateVoiceChannelResponse
UpdateVoiceTemplateResponse
VoiceChannelRequest
Specifies the status and settings of the voice channel for an application.
VoiceChannelResponse
Provides information about the status and settings of the voice channel for an application.
VoiceMessage
Specifies the settings for a one-time voice message that's sent directly to an endpoint through the voice channel.
VoiceTemplateRequest
Specifies the content and settings for a message template that can be used in messages that are sent through the voice channel.
VoiceTemplateResponse
Provides information about the content and settings for a message template that can be used in messages that are sent through the voice channel.
WaitActivity
Specifies the settings for a wait activity in a journey. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.
WaitTime
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.
WriteApplicationSettingsRequest
Specifies the default settings for an application.
WriteCampaignRequest
Specifies the configuration and other settings for a campaign.
WriteEventStream
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.
WriteJourneyRequest
Specifies the configuration and other settings for a journey.
WriteSegmentRequest
Specifies the configuration, dimension, and other settings for a segment. A WriteSegmentRequest object can include a Dimensions object or a SegmentGroups object, but not both.
WriteTreatmentResource
Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

Enums

Action
AttributeType
CampaignStatus
ChannelType
DeliveryStatus
DimensionType
Duration
EndpointTypesElement
FilterType
Format
Frequency
Include
JobStatus
MessageType
Mode
Operator
RecencyType
SegmentType
SourceType
State
TemplateType
Type

Exceptions / Errors

BadRequestException
ConflictException
ForbiddenException
InternalServerErrorException
MethodNotAllowedException
NotFoundException
PayloadTooLargeException
TooManyRequestsException