aws pinpoint

Doc Engage API - Amazon Pinpoint API

Subcommands

Name	Description
`create-app`	Creates an application
`create-campaign`	Creates a new campaign for an application or updates the settings of an existing campaign for an application
`create-email-template`	Creates a message template for messages that are sent through the email channel
`create-export-job`	Creates an export job for an application
`create-import-job`	Creates an import job for an application
`create-journey`	Creates a journey for an application
`create-push-template`	Creates a message template for messages that are sent through a push notification channel
`create-recommender-configuration`	Creates an Amazon Pinpoint configuration for a recommender model
`create-segment`	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
`create-sms-template`	Creates a message template for messages that are sent through the SMS channel
`create-voice-template`	Creates a message template for messages that are sent through the voice channel
`delete-adm-channel`	Disables the ADM channel for an application and deletes any existing settings for the channel
`delete-apns-channel`	Disables the APNs channel for an application and deletes any existing settings for the channel
`delete-apns-sandbox-channel`	Disables the APNs sandbox channel for an application and deletes any existing settings for the channel
`delete-apns-voip-channel`	Disables the APNs VoIP channel for an application and deletes any existing settings for the channel
`delete-apns-voip-sandbox-channel`	Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel
`delete-app`	Deletes an application
`delete-baidu-channel`	Disables the Baidu channel for an application and deletes any existing settings for the channel
`delete-campaign`	Deletes a campaign from an application
`delete-email-channel`	Disables the email channel for an application and deletes any existing settings for the channel
`delete-email-template`	Deletes a message template for messages that were sent through the email channel
`delete-endpoint`	Deletes an endpoint from an application
`delete-event-stream`	Deletes the event stream for an application
`delete-gcm-channel`	Disables the GCM channel for an application and deletes any existing settings for the channel
`delete-journey`	Deletes a journey from an application
`delete-push-template`	Deletes a message template for messages that were sent through a push notification channel
`delete-recommender-configuration`	Deletes an Amazon Pinpoint configuration for a recommender model
`delete-segment`	Deletes a segment from an application
`delete-sms-channel`	Disables the SMS channel for an application and deletes any existing settings for the channel
`delete-sms-template`	Deletes a message template for messages that were sent through the SMS channel
`delete-user-endpoints`	Deletes all the endpoints that are associated with a specific user ID
`delete-voice-channel`	Disables the voice channel for an application and deletes any existing settings for the channel
`delete-voice-template`	Deletes a message template for messages that were sent through the voice channel
`get-adm-channel`	Retrieves information about the status and settings of the ADM channel for an application
`get-apns-channel`	Retrieves information about the status and settings of the APNs channel for an application
`get-apns-sandbox-channel`	Retrieves information about the status and settings of the APNs sandbox channel for an application
`get-apns-voip-channel`	Retrieves information about the status and settings of the APNs VoIP channel for an application
`get-apns-voip-sandbox-channel`	Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application
`get-app`	Retrieves information about an application
`get-application-date-range-kpi`	Retrieves (queries) pre-aggregated data for a standard metric that applies to an application
`get-application-settings`	Retrieves information about the settings for an application
`get-apps`	Retrieves information about all the applications that are associated with your Amazon Pinpoint account
`get-baidu-channel`	Retrieves information about the status and settings of the Baidu channel for an application
`get-campaign`	Retrieves information about the status, configuration, and other settings for a campaign
`get-campaign-activities`	Retrieves information about all the activities for a campaign
`get-campaign-date-range-kpi`	Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign
`get-campaign-version`	Retrieves information about the status, configuration, and other settings for a specific version of a campaign
`get-campaign-versions`	Retrieves information about the status, configuration, and other settings for all versions of a campaign
`get-campaigns`	Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application
`get-channels`	Retrieves information about the history and status of each channel for an application
`get-email-channel`	Retrieves information about the status and settings of the email channel for an application
`get-email-template`	Retrieves the content and settings of a message template for messages that are sent through the email channel
`get-endpoint`	Retrieves information about the settings and attributes of a specific endpoint for an application
`get-event-stream`	Retrieves information about the event stream settings for an application
`get-export-job`	Retrieves information about the status and settings of a specific export job for an application
`get-export-jobs`	Retrieves information about the status and settings of all the export jobs for an application
`get-gcm-channel`	Retrieves information about the status and settings of the GCM channel for an application
`get-import-job`	Retrieves information about the status and settings of a specific import job for an application
`get-import-jobs`	Retrieves information about the status and settings of all the import jobs for an application
`get-journey`	Retrieves information about the status, configuration, and other settings for a journey
`get-journey-date-range-kpi`	Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey
`get-journey-execution-activity-metrics`	Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity
`get-journey-execution-metrics`	Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey
`get-push-template`	Retrieves the content and settings of a message template for messages that are sent through a push notification channel
`get-recommender-configuration`	Retrieves information about an Amazon Pinpoint configuration for a recommender model
`get-recommender-configurations`	Retrieves information about all the recommender model configurations that are associated with your Amazon Pinpoint account
`get-segment`	Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application
`get-segment-export-jobs`	Retrieves information about the status and settings of the export jobs for a segment
`get-segment-import-jobs`	Retrieves information about the status and settings of the import jobs for a segment
`get-segment-version`	Retrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application
`get-segment-versions`	Retrieves information about the configuration, dimension, and other settings for all the versions of a specific segment that's associated with an application
`get-segments`	Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application
`get-sms-channel`	Retrieves information about the status and settings of the SMS channel for an application
`get-sms-template`	Retrieves the content and settings of a message template for messages that are sent through the SMS channel
`get-user-endpoints`	Retrieves information about all the endpoints that are associated with a specific user ID
`get-voice-channel`	Retrieves information about the status and settings of the voice channel for an application
`get-voice-template`	Retrieves the content and settings of a message template for messages that are sent through the voice channel
`list-journeys`	Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application
`list-tags-for-resource`	Retrieves all the tags (keys and values) that are associated with an application, campaign, message template, or segment
`list-template-versions`	Retrieves information about all the versions of a specific message template
`list-templates`	Retrieves information about all the message templates that are associated with your Amazon Pinpoint account
`phone-number-validate`	Retrieves information about a phone number
`put-event-stream`	Creates a new event stream for an application or updates the settings of an existing event stream for an application
`put-events`	Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with
`remove-attributes`	Removes one or more attributes, of the same attribute type, from all the endpoints that are associated with an application
`send-messages`	Creates and sends a direct message
`send-users-messages`	Creates and sends a message to a list of users
`tag-resource`	Adds one or more tags (keys and values) to an application, campaign, message template, or segment
`untag-resource`	Removes one or more tags (keys and values) from an application, campaign, message template, or segment
`update-adm-channel`	Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application
`update-apns-channel`	Enables the APNs channel for an application or updates the status and settings of the APNs channel for an application
`update-apns-sandbox-channel`	Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application
`update-apns-voip-channel`	Enables 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-channel`	Enables 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-settings`	Updates the settings for an application
`update-baidu-channel`	Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application
`update-campaign`	Updates the configuration and other settings for a campaign
`update-email-channel`	Enables the email channel for an application or updates the status and settings of the email channel for an application
`update-email-template`	Updates an existing message template for messages that are sent through the email channel
`update-endpoint`	Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application. You can also use this operation to define custom attributes for an endpoint. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values
`update-endpoints-batch`	Creates a new batch of endpoints for an application or updates the settings and attributes of a batch of existing endpoints for an application. You can also use this operation to define custom attributes for a batch of endpoints. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values
`update-gcm-channel`	Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application
`update-journey`	Updates the configuration and other settings for a journey
`update-journey-state`	Cancels (stops) an active journey
`update-push-template`	Updates an existing message template for messages that are sent through a push notification channel
`update-recommender-configuration`	Updates an Amazon Pinpoint configuration for a recommender model
`update-segment`	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
`update-sms-channel`	Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application
`update-sms-template`	Updates an existing message template for messages that are sent through the SMS channel
`update-template-active-version`	Changes the status of a specific version of a message template to active
`update-voice-channel`	Enables the voice channel for an application or updates the status and settings of the voice channel for an application
`update-voice-template`	Updates an existing message template for messages that are sent through the voice channel