aws pinpoint
Doc Engage API - Amazon Pinpoint API AWS CLI reference
122 commands Its page in the AWS CLI reference
Commands
create-appCreates an application.create-campaignCreates a new campaign for an application or updates the settings of an existing campaign for an application.create-email-templateCreates a message template for messages that are sent through the email channel.create-export-jobCreates an export job for an application.create-import-jobCreates an import job for an application.create-in-app-templateCreates a new message template for messages using the in-app message channel.create-journeyCreates a journey for an application.create-push-templateCreates a message template for messages that are sent through a push notification channel.create-recommender-configurationCreates an Amazon Pinpoint configuration for a recommender model.create-segmentCreates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.create-sms-templateCreates a message template for messages that are sent through the SMS channel.create-voice-templateCreates a message template for messages that are sent through the voice channel.delete-adm-channelDisables the ADM channel for an application and deletes any existing settings for the channel.delete-apns-channelDisables the APNs channel for an application and deletes any existing settings for the channel.delete-apns-sandbox-channelDisables the APNs sandbox channel for an application and deletes any existing settings for the channel.delete-apns-voip-channelDisables the APNs VoIP channel for an application and deletes any existing settings for the channel.delete-apns-voip-sandbox-channelDisables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.delete-appDeletes an application.delete-baidu-channelDisables the Baidu channel for an application and deletes any existing settings for the channel.delete-campaignDeletes a campaign from an application.delete-email-channelDisables the email channel for an application and deletes any existing settings for the channel.delete-email-templateDeletes a message template for messages that were sent through the email channel.delete-endpointDeletes an endpoint from an application.delete-event-streamDeletes the event stream for an application.delete-gcm-channelDisables the GCM channel for an application and deletes any existing settings for the channel.delete-in-app-templateDeletes a message template for messages sent using the in-app message channel.delete-journeyDeletes a journey from an application.delete-push-templateDeletes a message template for messages that were sent through a push notification channel.delete-recommender-configurationDeletes an Amazon Pinpoint configuration for a recommender model.delete-segmentDeletes a segment from an application.delete-sms-channelDisables the SMS channel for an application and deletes any existing settings for the channel.delete-sms-templateDeletes a message template for messages that were sent through the SMS channel.delete-user-endpointsDeletes all the endpoints that are associated with a specific user ID.delete-voice-channelDisables the voice channel for an application and deletes any existing settings for the channel.delete-voice-templateDeletes a message template for messages that were sent through the voice channel.get-adm-channelRetrieves information about the status and settings of the ADM channel for an application.get-apns-channelRetrieves information about the status and settings of the APNs channel for an application.get-apns-sandbox-channelRetrieves information about the status and settings of the APNs sandbox channel for an application.get-apns-voip-channelRetrieves information about the status and settings of the APNs VoIP channel for an application.get-apns-voip-sandbox-channelRetrieves information about the status and settings of the APNs VoIP sandbox channel for an application.get-appRetrieves information about an application.get-application-date-range-kpiRetrieves (queries) pre-aggregated data for a standard metric that applies to an application.get-application-settingsRetrieves information about the settings for an application.get-appsRetrieves information about all the applications that are associated with your Amazon Pinpoint account.get-baidu-channelRetrieves information about the status and settings of the Baidu channel for an application.get-campaignRetrieves information about the status, configuration, and other settings for a campaign.get-campaign-activitiesRetrieves information about all the activities for a campaign.get-campaign-date-range-kpiRetrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.get-campaign-versionRetrieves information about the status, configuration, and other settings for a specific version of a campaign.get-campaign-versionsRetrieves information about the status, configuration, and other settings for all versions of a campaign.get-campaignsRetrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.get-channelsRetrieves information about the history and status of each channel for an application.get-email-channelRetrieves information about the status and settings of the email channel for an application.get-email-templateRetrieves the content and settings of a message template for messages that are sent through the email channel.get-endpointRetrieves information about the settings and attributes of a specific endpoint for an application.get-event-streamRetrieves information about the event stream settings for an application.get-export-jobRetrieves information about the status and settings of a specific export job for an application.get-export-jobsRetrieves information about the status and settings of all the export jobs for an application.get-gcm-channelRetrieves information about the status and settings of the GCM channel for an application.get-import-jobRetrieves information about the status and settings of a specific import job for an application.get-import-jobsRetrieves information about the status and settings of all the import jobs for an application.get-in-app-messagesRetrieves the in-app messages targeted for the provided endpoint ID.get-in-app-templateRetrieves the content and settings of a message template for messages sent through the in-app channel.get-journeyRetrieves information about the status, configuration, and other settings for a journey.get-journey-date-range-kpiRetrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey.get-journey-execution-activity-metricsRetrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity.get-journey-execution-metricsRetrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey.get-journey-run-execution-activity-metricsRetrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey activity.get-journey-run-execution-metricsRetrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey.get-journey-runsProvides information about the runs of a journey.get-push-templateRetrieves the content and settings of a message template for messages that are sent through a push notification channel.get-recommender-configurationRetrieves information about an Amazon Pinpoint configuration for a recommender model.get-recommender-configurationsRetrieves information about all the recommender model configurations that are associated with your Amazon Pinpoint account.get-segmentRetrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application.get-segment-export-jobsRetrieves information about the status and settings of the export jobs for a segment.get-segment-import-jobsRetrieves information about the status and settings of the import jobs for a segment.get-segment-versionRetrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application.get-segment-versionsRetrieves information about the configuration, dimension, and other settings for all the versions of a specific segment that's associated with an application.get-segmentsRetrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application.get-sms-channelRetrieves information about the status and settings of the SMS channel for an application.get-sms-templateRetrieves the content and settings of a message template for messages that are sent through the SMS channel.get-user-endpointsRetrieves information about all the endpoints that are associated with a specific user ID.get-voice-channelRetrieves information about the status and settings of the voice channel for an application.get-voice-templateRetrieves the content and settings of a message template for messages that are sent through the voice channel.list-journeysRetrieves information about the status, configuration, and other settings for all the journeys that are associated with an application.list-tags-for-resourceRetrieves all the tags (keys and values) that are associated with an application, campaign, message template, or segment.list-template-versionsRetrieves information about all the versions of a specific message template.list-templatesRetrieves information about all the message templates that are associated with your Amazon Pinpoint account.phone-number-validateRetrieves information about a phone number.put-event-streamCreates a new event stream for an application or updates the settings of an existing event stream for an application.put-eventsCreates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with.remove-attributesRemoves one or more custom attributes, of the same attribute type, from the application.send-messagesCreates and sends a direct message.send-otp-messageSend an OTP messagesend-users-messagesCreates and sends a message to a list of users.tag-resourceAdds one or more tags (keys and values) to an application, campaign, message template, or segment.untag-resourceRemoves one or more tags (keys and values) from an application, campaign, message template, or segment.update-adm-channelEnables the ADM channel for an application or updates the status and settings of the ADM channel for an application.update-apns-channelEnables the APNs channel for an application or updates the status and settings of the APNs channel for an application.update-apns-sandbox-channelEnables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application.update-apns-voip-channelEnables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application.update-apns-voip-sandbox-channelEnables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP sandbox channel for an application.update-application-settingsUpdates the settings for an application.update-baidu-channelEnables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application.update-campaignUpdates the configuration and other settings for a campaign.update-email-channelEnables the email channel for an application or updates the status and settings of the email channel for an application.update-email-templateUpdates an existing message template for messages that are sent through the email channel.update-endpointCreates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application.update-endpoints-batchCreates a new batch of endpoints for an application or updates the settings and attributes of a batch of existing endpoints for an application.update-gcm-channelEnables the GCM channel for an application or updates the status and settings of the GCM channel for an application.update-in-app-templateUpdates an existing message template for messages sent through the in-app message channel.update-journeyUpdates the configuration and other settings for a journey.update-journey-stateCancels (stops) an active journey.update-push-templateUpdates an existing message template for messages that are sent through a push notification channel.update-recommender-configurationUpdates an Amazon Pinpoint configuration for a recommender model.update-segmentCreates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.update-sms-channelEnables the SMS channel for an application or updates the status and settings of the SMS channel for an application.update-sms-templateUpdates an existing message template for messages that are sent through the SMS channel.update-template-active-versionChanges the status of a specific version of a message template to active.update-voice-channelEnables the voice channel for an application or updates the status and settings of the voice channel for an application.update-voice-templateUpdates an existing message template for messages that are sent through the voice channel.verify-otp-messageVerify an OTP