| Class | Description |
|---|---|
| ActivitiesResponse |
Provides information about the activities that were performed by a campaign.
|
| 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.
|
| 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.
|
| 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.
|
| 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.
|
| 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.
|
| 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 the AWS Lambda function to use as a code hook for a campaign.
|
| CampaignLimits |
Specifies limits on the messages that a campaign 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.
|
| CreateApplicationRequest |
Specifies the display name of an application and the tags to associate with the application.
|
| CreateAppRequest | |
| CreateAppResult | |
| CreateCampaignRequest | |
| CreateCampaignResult | |
| CreateExportJobRequest | |
| CreateExportJobResult | |
| CreateImportJobRequest | |
| CreateImportJobResult | |
| CreateSegmentRequest | |
| CreateSegmentResult | |
| DefaultMessage |
Specifies the default message to use for all channels.
|
| DefaultPushNotificationMessage |
Specifies the default settings and content for a push notification that's sent directly to an endpoint.
|
| DeleteAdmChannelRequest | |
| DeleteAdmChannelResult | |
| DeleteApnsChannelRequest | |
| DeleteApnsChannelResult | |
| DeleteApnsSandboxChannelRequest | |
| DeleteApnsSandboxChannelResult | |
| DeleteApnsVoipChannelRequest | |
| DeleteApnsVoipChannelResult | |
| DeleteApnsVoipSandboxChannelRequest | |
| DeleteApnsVoipSandboxChannelResult | |
| DeleteAppRequest | |
| DeleteAppResult | |
| DeleteBaiduChannelRequest | |
| DeleteBaiduChannelResult | |
| DeleteCampaignRequest | |
| DeleteCampaignResult | |
| DeleteEmailChannelRequest | |
| DeleteEmailChannelResult | |
| DeleteEndpointRequest | |
| DeleteEndpointResult | |
| DeleteEventStreamRequest | |
| DeleteEventStreamResult | |
| DeleteGcmChannelRequest | |
| DeleteGcmChannelResult | |
| DeleteSegmentRequest | |
| DeleteSegmentResult | |
| DeleteSmsChannelRequest | |
| DeleteSmsChannelResult | |
| DeleteUserEndpointsRequest | |
| DeleteUserEndpointsResult | |
| DeleteVoiceChannelRequest | |
| DeleteVoiceChannelResult | |
| 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.
|
| 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.
|
| EventDimensions |
Specifies the dimensions for an event filter that determines when a campaign is sent.
|
| 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.
|
| 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.
|
| ExportJobResponse |
Provides information about the status and settings of a job that exports endpoint definitions to a file.
|
| ExportJobsResponse |
Provides information about all the export jobs that are associated with an application or segment.
|
| GCMChannelRequest |
Specifies the status and settings of the GCM channel for an application.
|
| GCMChannelResponse |
Provides information about the status and settings of the GCM channel for an application.
|
| GCMMessage |
Specifies the settings for a one-time message that's sent directly to an endpoint through the GCM channel.
|
| GetAdmChannelRequest | |
| GetAdmChannelResult | |
| GetApnsChannelRequest | |
| GetApnsChannelResult | |
| GetApnsSandboxChannelRequest | |
| GetApnsSandboxChannelResult | |
| GetApnsVoipChannelRequest | |
| GetApnsVoipChannelResult | |
| GetApnsVoipSandboxChannelRequest | |
| GetApnsVoipSandboxChannelResult | |
| GetApplicationSettingsRequest | |
| GetApplicationSettingsResult | |
| GetAppRequest | |
| GetAppResult | |
| GetAppsRequest | |
| GetAppsResult | |
| GetBaiduChannelRequest | |
| GetBaiduChannelResult | |
| GetCampaignActivitiesRequest | |
| GetCampaignActivitiesResult | |
| GetCampaignRequest | |
| GetCampaignResult | |
| GetCampaignsRequest | |
| GetCampaignsResult | |
| GetCampaignVersionRequest | |
| GetCampaignVersionResult | |
| GetCampaignVersionsRequest | |
| GetCampaignVersionsResult | |
| GetChannelsRequest | |
| GetChannelsResult | |
| GetEmailChannelRequest | |
| GetEmailChannelResult | |
| GetEndpointRequest | |
| GetEndpointResult | |
| GetEventStreamRequest | |
| GetEventStreamResult | |
| GetExportJobRequest | |
| GetExportJobResult | |
| GetExportJobsRequest | |
| GetExportJobsResult | |
| GetGcmChannelRequest | |
| GetGcmChannelResult | |
| GetImportJobRequest | |
| GetImportJobResult | |
| GetImportJobsRequest | |
| GetImportJobsResult | |
| GetSegmentExportJobsRequest | |
| GetSegmentExportJobsResult | |
| GetSegmentImportJobsRequest | |
| GetSegmentImportJobsResult | |
| GetSegmentRequest | |
| GetSegmentResult | |
| GetSegmentsRequest | |
| GetSegmentsResult | |
| GetSegmentVersionRequest | |
| GetSegmentVersionResult | |
| GetSegmentVersionsRequest | |
| GetSegmentVersionsResult | |
| GetSmsChannelRequest | |
| GetSmsChannelResult | |
| GetUserEndpointsRequest | |
| GetUserEndpointsResult | |
| GetVoiceChannelRequest | |
| GetVoiceChannelResult | |
| GPSCoordinates |
Specifies the GPS coordinates of a location.
|
| GPSPointDimension |
Specifies GPS-based criteria for including or excluding endpoints from a segment.
|
| 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.
|
| ImportJobResponse |
Provides information about the status and settings of a job that imports endpoint definitions from one or more files.
|
| ImportJobsResponse |
Provides information about the status and settings of all the import jobs that are associated with an application or
segment.
|
| ItemResponse |
Provides information about the results of a request to create or update an endpoint that's associated with an event.
|
| ListTagsForResourceRequest | |
| ListTagsForResourceResult | |
| 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 objects that define 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.
|
| NumberValidateRequest |
Specifies a phone number to validate and retrieve information about.
|
| NumberValidateResponse |
Provides information about a phone number.
|
| PhoneNumberValidateRequest | |
| PhoneNumberValidateResult | |
| PublicEndpoint |
Specifies the properties and attributes of an endpoint that's associated with an event.
|
| PutEventsRequest | |
| PutEventsResult | |
| PutEventStreamRequest | |
| PutEventStreamResult | |
| QuietTime |
Specifies the start and end times that define a time range when messages aren't sent to endpoints.
|
| 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.
|
| RemoveAttributesRequest | |
| RemoveAttributesResult | |
| 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.
|
| SegmentDemographics |
Specifies demographic-based dimension settings for including or excluding endpoints from a segment.
|
| 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.
|
| 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.
|
| SendMessagesRequest | |
| SendMessagesResult | |
| 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.
|
| SendUsersMessagesRequest | |
| SendUsersMessagesResult | |
| Session |
Provides information about a session.
|
| SetDimension |
Specifies the dimension type and values for a segment dimension.
|
| SimpleEmail |
Specifies the content 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.
|
| TagResourceRequest | |
| TagResourceResult | |
| TagsModel |
Specifies the tags (keys and values) for an application, campaign, or segment.
|
| TreatmentResource |
Specifies the settings for a campaign treatment.
|
| UntagResourceRequest | |
| UntagResourceResult | |
| UpdateAdmChannelRequest | |
| UpdateAdmChannelResult | |
| UpdateApnsChannelRequest | |
| UpdateApnsChannelResult | |
| UpdateApnsSandboxChannelRequest | |
| UpdateApnsSandboxChannelResult | |
| UpdateApnsVoipChannelRequest | |
| UpdateApnsVoipChannelResult | |
| UpdateApnsVoipSandboxChannelRequest | |
| UpdateApnsVoipSandboxChannelResult | |
| UpdateApplicationSettingsRequest | |
| UpdateApplicationSettingsResult | |
| UpdateAttributesRequest |
Specifies one or more attributes to remove from all the endpoints that are associated with an application.
|
| UpdateBaiduChannelRequest | |
| UpdateBaiduChannelResult | |
| UpdateCampaignRequest | |
| UpdateCampaignResult | |
| UpdateEmailChannelRequest | |
| UpdateEmailChannelResult | |
| UpdateEndpointRequest | |
| UpdateEndpointResult | |
| UpdateEndpointsBatchRequest | |
| UpdateEndpointsBatchResult | |
| UpdateGcmChannelRequest | |
| UpdateGcmChannelResult | |
| UpdateSegmentRequest | |
| UpdateSegmentResult | |
| UpdateSmsChannelRequest | |
| UpdateSmsChannelResult | |
| UpdateVoiceChannelRequest | |
| UpdateVoiceChannelResult | |
| 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.
|
| 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.
|
| WriteSegmentRequest |
Specifies the configuration, dimension, and other settings for a segment.
|
| WriteTreatmentResource |
Specifies the settings for a campaign treatment.
|
| Enum | Description |
|---|---|
| Action | |
| AttributeType | |
| CampaignStatus | |
| ChannelType | |
| DeliveryStatus | |
| DimensionType | |
| Duration | |
| FilterType | |
| Format | |
| Frequency | |
| Include | |
| JobStatus | |
| MessageType | |
| Mode | |
| RecencyType | |
| SegmentType | |
| SourceType | |
| Type |
| Exception | Description |
|---|---|
| AmazonPinpointException |
Base exception for all service exceptions thrown by Amazon Pinpoint
|
| BadRequestException |
Provides information about an API request or response.
|
| ForbiddenException |
Provides information about an API request or response.
|
| InternalServerErrorException |
Provides information about an API request or response.
|
| MethodNotAllowedException |
Provides information about an API request or response.
|
| NotFoundException |
Provides information about an API request or response.
|
| TooManyRequestsException |
Provides information about an API request or response.
|
Copyright © 2019. All rights reserved.