Class: AWS.Pinpoint
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.Pinpoint
- Identifier:
- pinpoint
- API Version:
- 2016-12-01
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service Description
Doc Engage API - Amazon Pinpoint API
Sending a Request Using Pinpoint
var pinpoint = new AWS.Pinpoint();
pinpoint.createApp(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the Pinpoint object uses this specific API, you can
construct the object by passing the apiVersion option to the constructor:
var pinpoint = new AWS.Pinpoint({apiVersion: '2016-12-01'});
You can also set the API version globally in AWS.config.apiVersions using
the pinpoint service identifier:
AWS.config.apiVersions = {
pinpoint: '2016-12-01',
// other service API versions
};
var pinpoint = new AWS.Pinpoint();
Constructor Summary collapse
-
new AWS.Pinpoint(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
createApp(params = {}, callback) ⇒ AWS.Request
Creates an application.
.
-
createCampaign(params = {}, callback) ⇒ AWS.Request
Creates a new campaign for an application or updates the settings of an existing campaign for an application.
.
-
createEmailTemplate(params = {}, callback) ⇒ AWS.Request
Creates a message template for messages that are sent through the email channel.
.
-
createExportJob(params = {}, callback) ⇒ AWS.Request
Creates an export job for an application.
.
-
createImportJob(params = {}, callback) ⇒ AWS.Request
Creates an import job for an application.
.
-
createInAppTemplate(params = {}, callback) ⇒ AWS.Request
Creates a new message template for messages using the in-app message channel.
.
-
createJourney(params = {}, callback) ⇒ AWS.Request
Creates a journey for an application.
.
-
createPushTemplate(params = {}, callback) ⇒ AWS.Request
Creates a message template for messages that are sent through a push notification channel.
.
-
createRecommenderConfiguration(params = {}, callback) ⇒ AWS.Request
Creates an Amazon Pinpoint configuration for a recommender model.
.
-
createSegment(params = {}, callback) ⇒ AWS.Request
Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.
.
-
createSmsTemplate(params = {}, callback) ⇒ AWS.Request
Creates a message template for messages that are sent through the SMS channel.
.
-
createVoiceTemplate(params = {}, callback) ⇒ AWS.Request
Creates a message template for messages that are sent through the voice channel.
.
-
deleteAdmChannel(params = {}, callback) ⇒ AWS.Request
Disables the ADM channel for an application and deletes any existing settings for the channel.
.
-
deleteApnsChannel(params = {}, callback) ⇒ AWS.Request
Disables the APNs channel for an application and deletes any existing settings for the channel.
.
-
deleteApnsSandboxChannel(params = {}, callback) ⇒ AWS.Request
Disables the APNs sandbox channel for an application and deletes any existing settings for the channel.
.
-
deleteApnsVoipChannel(params = {}, callback) ⇒ AWS.Request
Disables the APNs VoIP channel for an application and deletes any existing settings for the channel.
.
-
deleteApnsVoipSandboxChannel(params = {}, callback) ⇒ AWS.Request
Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.
.
-
deleteApp(params = {}, callback) ⇒ AWS.Request
Deletes an application.
.
-
deleteBaiduChannel(params = {}, callback) ⇒ AWS.Request
Disables the Baidu channel for an application and deletes any existing settings for the channel.
.
-
deleteCampaign(params = {}, callback) ⇒ AWS.Request
Deletes a campaign from an application.
.
-
deleteEmailChannel(params = {}, callback) ⇒ AWS.Request
Disables the email channel for an application and deletes any existing settings for the channel.
.
-
deleteEmailTemplate(params = {}, callback) ⇒ AWS.Request
Deletes a message template for messages that were sent through the email channel.
.
-
deleteEndpoint(params = {}, callback) ⇒ AWS.Request
Deletes an endpoint from an application.
.
-
deleteEventStream(params = {}, callback) ⇒ AWS.Request
Deletes the event stream for an application.
.
-
deleteGcmChannel(params = {}, callback) ⇒ AWS.Request
Disables the GCM channel for an application and deletes any existing settings for the channel.
.
-
deleteInAppTemplate(params = {}, callback) ⇒ AWS.Request
Deletes a message template for messages sent using the in-app message channel.
.
-
deleteJourney(params = {}, callback) ⇒ AWS.Request
Deletes a journey from an application.
.
-
deletePushTemplate(params = {}, callback) ⇒ AWS.Request
Deletes a message template for messages that were sent through a push notification channel.
.
-
deleteRecommenderConfiguration(params = {}, callback) ⇒ AWS.Request
Deletes an Amazon Pinpoint configuration for a recommender model.
.
-
deleteSegment(params = {}, callback) ⇒ AWS.Request
Deletes a segment from an application.
.
-
deleteSmsChannel(params = {}, callback) ⇒ AWS.Request
Disables the SMS channel for an application and deletes any existing settings for the channel.
.
-
deleteSmsTemplate(params = {}, callback) ⇒ AWS.Request
Deletes a message template for messages that were sent through the SMS channel.
.
-
deleteUserEndpoints(params = {}, callback) ⇒ AWS.Request
Deletes all the endpoints that are associated with a specific user ID.
.
-
deleteVoiceChannel(params = {}, callback) ⇒ AWS.Request
Disables the voice channel for an application and deletes any existing settings for the channel.
.
-
deleteVoiceTemplate(params = {}, callback) ⇒ AWS.Request
Deletes a message template for messages that were sent through the voice channel.
.
-
getAdmChannel(params = {}, callback) ⇒ AWS.Request
Retrieves information about the status and settings of the ADM channel for an application.
.
-
getApnsChannel(params = {}, callback) ⇒ AWS.Request
Retrieves information about the status and settings of the APNs channel for an application.
.
-
getApnsSandboxChannel(params = {}, callback) ⇒ AWS.Request
Retrieves information about the status and settings of the APNs sandbox channel for an application.
.
-
getApnsVoipChannel(params = {}, callback) ⇒ AWS.Request
Retrieves information about the status and settings of the APNs VoIP channel for an application.
.
-
getApnsVoipSandboxChannel(params = {}, callback) ⇒ AWS.Request
Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application.
.
-
getApp(params = {}, callback) ⇒ AWS.Request
Retrieves information about an application.
.
-
getApplicationDateRangeKpi(params = {}, callback) ⇒ AWS.Request
Retrieves (queries) pre-aggregated data for a standard metric that applies to an application.
.
-
getApplicationSettings(params = {}, callback) ⇒ AWS.Request
Retrieves information about the settings for an application.
.
-
getApps(params = {}, callback) ⇒ AWS.Request
Retrieves information about all the applications that are associated with your Amazon Pinpoint account.
.
-
getBaiduChannel(params = {}, callback) ⇒ AWS.Request
Retrieves information about the status and settings of the Baidu channel for an application.
.
-
getCampaign(params = {}, callback) ⇒ AWS.Request
Retrieves information about the status, configuration, and other settings for a campaign.
.
-
getCampaignActivities(params = {}, callback) ⇒ AWS.Request
Retrieves information about all the activities for a campaign.
.
-
getCampaignDateRangeKpi(params = {}, callback) ⇒ AWS.Request
Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.
.
-
getCampaigns(params = {}, callback) ⇒ AWS.Request
Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.
.
-
getCampaignVersion(params = {}, callback) ⇒ AWS.Request
Retrieves information about the status, configuration, and other settings for a specific version of a campaign.
.
-
getCampaignVersions(params = {}, callback) ⇒ AWS.Request
Retrieves information about the status, configuration, and other settings for all versions of a campaign.
.
-
getChannels(params = {}, callback) ⇒ AWS.Request
Retrieves information about the history and status of each channel for an application.
.
-
getEmailChannel(params = {}, callback) ⇒ AWS.Request
Retrieves information about the status and settings of the email channel for an application.
.
-
getEmailTemplate(params = {}, callback) ⇒ AWS.Request
Retrieves the content and settings of a message template for messages that are sent through the email channel.
.
-
getEndpoint(params = {}, callback) ⇒ AWS.Request
Retrieves information about the settings and attributes of a specific endpoint for an application.
.
-
getEventStream(params = {}, callback) ⇒ AWS.Request
Retrieves information about the event stream settings for an application.
.
-
getExportJob(params = {}, callback) ⇒ AWS.Request
Retrieves information about the status and settings of a specific export job for an application.
.
-
getExportJobs(params = {}, callback) ⇒ AWS.Request
Retrieves information about the status and settings of all the export jobs for an application.
.
-
getGcmChannel(params = {}, callback) ⇒ AWS.Request
Retrieves information about the status and settings of the GCM channel for an application.
.
-
getImportJob(params = {}, callback) ⇒ AWS.Request
Retrieves information about the status and settings of a specific import job for an application.
.
-
getImportJobs(params = {}, callback) ⇒ AWS.Request
Retrieves information about the status and settings of all the import jobs for an application.
.
-
getInAppMessages(params = {}, callback) ⇒ AWS.Request
Retrieves the in-app messages targeted for the provided endpoint ID.
.
-
getInAppTemplate(params = {}, callback) ⇒ AWS.Request
Retrieves the content and settings of a message template for messages sent through the in-app channel.
.
-
getJourney(params = {}, callback) ⇒ AWS.Request
Retrieves information about the status, configuration, and other settings for a journey.
.
-
getJourneyDateRangeKpi(params = {}, callback) ⇒ AWS.Request
Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey.
.
-
getJourneyExecutionActivityMetrics(params = {}, callback) ⇒ AWS.Request
Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity.
.
- getJourneyExecutionMetrics(params = {}, callback) ⇒ AWS.Request