aws pinpoint122 CLI commands available for Amazon Pinpoint.
| Command | API Operation | Sample |
|---|---|---|
create-appCreates an application. | CreateApp | |
create-campaignCreates a new campaign for an application or updates the settings of an existing campaign for an application. | CreateCampaign | |
create-email-templateCreates a message template for messages that are sent through the email channel. | CreateEmailTemplate | |
create-export-jobCreates an export job for an application. | CreateExportJob | |
create-import-jobCreates an import job for an application. | CreateImportJob | |
create-in-app-templateCreates a new message template for messages using the in-app message channel. | CreateInAppTemplate | |
create-journeyCreates a journey for an application. | CreateJourney | |
create-push-templateCreates a message template for messages that are sent through a push notification channel. | CreatePushTemplate | |
create-recommender-configurationCreates an Amazon Pinpoint configuration for a recommender model. | CreateRecommenderConfiguration | |
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. | CreateSegment | |
create-sms-templateCreates a message template for messages that are sent through the SMS channel. | CreateSmsTemplate | |
create-voice-templateCreates a message template for messages that are sent through the voice channel. | CreateVoiceTemplate | |
delete-adm-channelDisables the ADM channel for an application and deletes any existing settings for the channel. | DeleteAdmChannel | |
delete-apns-channelDisables the APNs channel for an application and deletes any existing settings for the channel. | DeleteApnsChannel | |
delete-apns-sandbox-channelDisables the APNs sandbox channel for an application and deletes any existing settings for the channel. | DeleteApnsSandboxChannel | |
delete-apns-voip-channelDisables the APNs VoIP channel for an application and deletes any existing settings for the channel. | DeleteApnsVoipChannel | |
delete-apns-voip-sandbox-channelDisables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel. | DeleteApnsVoipSandboxChannel | |
delete-appDeletes an application. | DeleteApp | |
delete-baidu-channelDisables the Baidu channel for an application and deletes any existing settings for the channel. | DeleteBaiduChannel | |
delete-campaignDeletes a campaign from an application. | DeleteCampaign | |
delete-email-channelDisables the email channel for an application and deletes any existing settings for the channel. | DeleteEmailChannel | |
delete-email-templateDeletes a message template for messages that were sent through the email channel. | DeleteEmailTemplate | |
delete-endpointDeletes an endpoint from an application. | DeleteEndpoint | |
delete-event-streamDeletes the event stream for an application. | DeleteEventStream | |
delete-gcm-channelDisables the GCM channel for an application and deletes any existing settings for the channel. | DeleteGcmChannel | |
delete-in-app-templateDeletes a message template for messages sent using the in-app message channel. | DeleteInAppTemplate | |
delete-journeyDeletes a journey from an application. | DeleteJourney | |
delete-push-templateDeletes a message template for messages that were sent through a push notification channel. | DeletePushTemplate | |
delete-recommender-configurationDeletes an Amazon Pinpoint configuration for a recommender model. | DeleteRecommenderConfiguration | |
delete-segmentDeletes a segment from an application. | DeleteSegment | |
delete-sms-channelDisables the SMS channel for an application and deletes any existing settings for the channel. | DeleteSmsChannel | |
delete-sms-templateDeletes a message template for messages that were sent through the SMS channel. | DeleteSmsTemplate | |
delete-user-endpointsDeletes all the endpoints that are associated with a specific user ID. | DeleteUserEndpoints | |
delete-voice-channelDisables the voice channel for an application and deletes any existing settings for the channel. | DeleteVoiceChannel | |
delete-voice-templateDeletes a message template for messages that were sent through the voice channel. | DeleteVoiceTemplate | |
get-adm-channelRetrieves information about the status and settings of the ADM channel for an application. | GetAdmChannel | |
get-apns-channelRetrieves information about the status and settings of the APNs channel for an application. | GetApnsChannel | |
get-apns-sandbox-channelRetrieves information about the status and settings of the APNs sandbox channel for an application. | GetApnsSandboxChannel | |
get-apns-voip-channelRetrieves information about the status and settings of the APNs VoIP channel for an application. | GetApnsVoipChannel | |
get-apns-voip-sandbox-channelRetrieves information about the status and settings of the APNs VoIP sandbox channel for an application. | GetApnsVoipSandboxChannel | |
get-appRetrieves information about an application. | GetApp | |
get-application-date-range-kpiRetrieves (queries) pre-aggregated data for a standard metric that applies to an application. | GetApplicationDateRangeKpi | |
get-application-settingsRetrieves information about the settings for an application. | GetApplicationSettings | |
get-appsRetrieves information about all the applications that are associated with your Amazon Pinpoint account. | GetApps | |
get-baidu-channelRetrieves information about the status and settings of the Baidu channel for an application. | GetBaiduChannel | |
get-campaignRetrieves information about the status, configuration, and other settings for a campaign. | GetCampaign | |
get-campaign-activitiesRetrieves information about all the activities for a campaign. | GetCampaignActivities | |
get-campaign-date-range-kpiRetrieves (queries) pre-aggregated data for a standard metric that applies to a campaign. | GetCampaignDateRangeKpi | |
get-campaign-versionRetrieves information about the status, configuration, and other settings for a specific version of a campaign. | GetCampaignVersion | |
get-campaign-versionsRetrieves information about the status, configuration, and other settings for all versions of a campaign. | GetCampaignVersions | |
get-campaignsRetrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application. | GetCampaigns | |
get-channelsRetrieves information about the history and status of each channel for an application. | GetChannels | |
get-email-channelRetrieves information about the status and settings of the email channel for an application. | GetEmailChannel | |
get-email-templateRetrieves the content and settings of a message template for messages that are sent through the email channel. | GetEmailTemplate | |
get-endpointRetrieves information about the settings and attributes of a specific endpoint for an application. | GetEndpoint | |
get-event-streamRetrieves information about the event stream settings for an application. | GetEventStream | |
get-export-jobRetrieves information about the status and settings of a specific export job for an application. | GetExportJob | |
get-export-jobsRetrieves information about the status and settings of all the export jobs for an application. | GetExportJobs | |
get-gcm-channelRetrieves information about the status and settings of the GCM channel for an application. | GetGcmChannel | |
get-import-jobRetrieves information about the status and settings of a specific import job for an application. | GetImportJob | |
get-import-jobsRetrieves information about the status and settings of all the import jobs for an application. | GetImportJobs | |
get-in-app-messagesRetrieves the in-app messages targeted for the provided endpoint ID. | GetInAppMessages | |
get-in-app-templateRetrieves the content and settings of a message template for messages sent through the in-app channel. | GetInAppTemplate | |
get-journeyRetrieves information about the status, configuration, and other settings for a journey. | GetJourney | |
get-journey-date-range-kpiRetrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey. | GetJourneyDateRangeKpi | |
get-journey-execution-activity-metricsRetrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity. | GetJourneyExecutionActivityMetrics | |
get-journey-execution-metricsRetrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey. | GetJourneyExecutionMetrics | |
get-journey-run-execution-activity-metricsRetrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey activity. | GetJourneyRunExecutionActivityMetrics | |
get-journey-run-execution-metricsRetrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey. | GetJourneyRunExecutionMetrics | |
get-journey-runsProvides information about the runs of a journey. | GetJourneyRuns | |
get-push-templateRetrieves the content and settings of a message template for messages that are sent through a push notification channel. | GetPushTemplate | |
get-recommender-configurationRetrieves information about an Amazon Pinpoint configuration for a recommender model. | GetRecommenderConfiguration | |
get-recommender-configurationsRetrieves information about all the recommender model configurations that are associated with your Amazon Pinpoint account. | GetRecommenderConfigurations | |
get-segmentRetrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application. | GetSegment | |
get-segment-export-jobsRetrieves information about the status and settings of the export jobs for a segment. | GetSegmentExportJobs | |
get-segment-import-jobsRetrieves information about the status and settings of the import jobs for a segment. | GetSegmentImportJobs | |
get-segment-versionRetrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application. | GetSegmentVersion | |
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. | GetSegmentVersions | |
get-segmentsRetrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application. | GetSegments | |
get-sms-channelRetrieves information about the status and settings of the SMS channel for an application. | GetSmsChannel | |
get-sms-templateRetrieves the content and settings of a message template for messages that are sent through the SMS channel. | GetSmsTemplate | |
get-user-endpointsRetrieves information about all the endpoints that are associated with a specific user ID. | GetUserEndpoints | |
get-voice-channelRetrieves information about the status and settings of the voice channel for an application. | GetVoiceChannel | |
get-voice-templateRetrieves the content and settings of a message template for messages that are sent through the voice channel. | GetVoiceTemplate | |
list-journeysRetrieves information about the status, configuration, and other settings for all the journeys that are associated with an application. | ListJourneys | |
list-tags-for-resourceRetrieves all the tags (keys and values) that are associated with an application, campaign, message template, or segment. | ListTagsForResource | |
list-template-versionsRetrieves information about all the versions of a specific message template. | ListTemplateVersions | |
list-templatesRetrieves information about all the message templates that are associated with your Amazon Pinpoint account. | ListTemplates | |
phone-number-validateRetrieves information about a phone number. | PhoneNumberValidate | |
put-event-streamCreates a new event stream for an application or updates the settings of an existing event stream for an application. | PutEventStream | |
put-eventsCreates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with. | PutEvents | |
remove-attributesRemoves one or more custom attributes, of the same attribute type, from the application. Existing endpoints still have the attributes but Amazon Pinpoint will stop capturing new or changed values for these attributes. | RemoveAttributes | |
send-messagesCreates and sends a direct message. | SendMessages | |
send-otp-messageSend an OTP message | SendOTPMessage | |
send-users-messagesCreates and sends a message to a list of users. | SendUsersMessages | |
tag-resourceAdds one or more tags (keys and values) to an application, campaign, message template, or segment. | TagResource | |
untag-resourceRemoves one or more tags (keys and values) from an application, campaign, message template, or segment. | UntagResource | |
update-adm-channelEnables the ADM channel for an application or updates the status and settings of the ADM channel for an application. | UpdateAdmChannel | |
update-apns-channelEnables the APNs channel for an application or updates the status and settings of the APNs channel for an application. | UpdateApnsChannel | |
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. | UpdateApnsSandboxChannel | |
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. | UpdateApnsVoipChannel | |
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. | UpdateApnsVoipSandboxChannel | |
update-application-settingsUpdates the settings for an application. | UpdateApplicationSettings | |
update-baidu-channelEnables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application. | UpdateBaiduChannel | |
update-campaignUpdates the configuration and other settings for a campaign. | UpdateCampaign | |
update-email-channelEnables the email channel for an application or updates the status and settings of the email channel for an application. | UpdateEmailChannel | |
update-email-templateUpdates an existing message template for messages that are sent through the email channel. | UpdateEmailTemplate | |
update-endpointCreates 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 (overwri | UpdateEndpoint | |
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. 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, Amazo | UpdateEndpointsBatch | |
update-gcm-channelEnables the GCM channel for an application or updates the status and settings of the GCM channel for an application. | UpdateGcmChannel | |
update-in-app-templateUpdates an existing message template for messages sent through the in-app message channel. | UpdateInAppTemplate | |
update-journeyUpdates the configuration and other settings for a journey. | UpdateJourney | |
update-journey-stateCancels (stops) an active journey. | UpdateJourneyState | |
update-push-templateUpdates an existing message template for messages that are sent through a push notification channel. | UpdatePushTemplate | |
update-recommender-configurationUpdates an Amazon Pinpoint configuration for a recommender model. | UpdateRecommenderConfiguration | |
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. | UpdateSegment | |
update-sms-channelEnables the SMS channel for an application or updates the status and settings of the SMS channel for an application. | UpdateSmsChannel | |
update-sms-templateUpdates an existing message template for messages that are sent through the SMS channel. | UpdateSmsTemplate | |
update-template-active-versionChanges the status of a specific version of a message template to active. | UpdateTemplateActiveVersion | |
update-voice-channelEnables the voice channel for an application or updates the status and settings of the voice channel for an application. | UpdateVoiceChannel | |
update-voice-templateUpdates an existing message template for messages that are sent through the voice channel. | UpdateVoiceTemplate | |
verify-otp-messageVerify an OTP | VerifyOTPMessage |
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterOur bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterPinpoint