Amazon Pinpoint · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Amazon Pinpoint Apps API
88 actions
88 updates
phrasing
extends
openapi/amazon-pinpoint-apps-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Amazon Pinpoint's API. It is a proposal applied on top of the contract, not a document Amazon Pinpoint publishes.
What the actions change
x-apievangelist-phrasing
Targets 88 · first 16 shown; the file carries all of them
$.info
$.paths['/v1/apps'].get
$.paths['/v1/apps'].post
$.paths['/v1/apps/{application-id}/campaigns'].get
$.paths['/v1/apps/{application-id}/campaigns'].post
$.paths['/v1/apps/{application-id}/jobs/export'].get
$.paths['/v1/apps/{application-id}/jobs/export'].post
$.paths['/v1/apps/{application-id}/jobs/import'].get
$.paths['/v1/apps/{application-id}/jobs/import'].post
$.paths['/v1/apps/{application-id}/journeys'].get
$.paths['/v1/apps/{application-id}/journeys'].post
$.paths['/v1/apps/{application-id}/segments'].get
$.paths['/v1/apps/{application-id}/segments'].post
$.paths['/v1/apps/{application-id}/channels/adm'].get
$.paths['/v1/apps/{application-id}/channels/adm'].put
$.paths['/v1/apps/{application-id}/channels/adm'].delete
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Amazon Pinpoint Apps API
version: 1.0.0
extends: openapi/amazon-pinpoint-apps-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 87
- target: $.paths['/v1/apps'].get
update:
x-apievangelist-phrasing:
intent: List all Pinpoint projects in the account
effect: read
questions:
- Which Amazon Pinpoint projects exist in my AWS account?
- Can I page through every application I've created, a set number at a time?
instructions:
- text: List all of my Pinpoint applications.
- text: Show the next {page_size} Pinpoint projects starting from page token {token}.
slots:
page_size: query.page-size
token: query.token
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps'].post
update:
x-apievangelist-phrasing:
intent: Create a new Pinpoint project
effect: write
questions:
- How do I set up a brand-new messaging project to hold campaigns and endpoints?
- Can I tag an application at the moment I create it?
instructions:
- text: Create a new Pinpoint application with display name and tags {app_settings}.
slots:
app_settings: requestBody.CreateApplicationRequest
- text: Spin up a fresh project for our marketing team using {app_settings}.
slots:
app_settings: requestBody.CreateApplicationRequest
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}/campaigns'].get
update:
x-apievangelist-phrasing:
intent: List all campaigns in a project
effect: read
questions:
- What campaigns are set up in my project, and what state is each one in?
- Is there a way to see every campaign in an application page by page?
instructions:
- text: List every campaign in application {app}.
slots:
app: path.application-id
- text: Show {page_size} campaigns at a time for project {app}.
slots:
page_size: query.page-size
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}/campaigns'].post
update:
x-apievangelist-phrasing:
intent: Create a new campaign in a project
effect: write
questions:
- How do I launch a new scheduled messaging campaign for my app?
- Can I create a campaign that targets a segment in my project?
instructions:
- text: Create a new campaign in application {app} with settings {campaign}.
slots:
app: path.application-id
campaign: requestBody.WriteCampaignRequest
- text: Set up a fresh campaign for project {app}.
slots:
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}/jobs/export'].get
update:
x-apievangelist-phrasing:
intent: List endpoint export jobs for a project
effect: read
questions:
- What export jobs have run for my application and did they finish?
- Can I see the history of all endpoint exports to S3 for a project?
instructions:
- text: List all export jobs for application {app}.
slots:
app: path.application-id
- text: Show the status of every S3 export job in project {app}.
slots:
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}/jobs/export'].post
update:
x-apievangelist-phrasing:
intent: Export a project's endpoints to S3
effect: write
questions:
- How do I export all my endpoint definitions to an S3 bucket?
- Can I dump a project's endpoints out to S3 for analysis?
instructions:
- text: Start an export of application {app}'s endpoints to S3 using {export_settings}.
slots:
app: path.application-id
export_settings: requestBody.ExportJobRequest
- text: Kick off a new endpoint export job for project {app}.
slots:
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}/jobs/import'].get
update:
x-apievangelist-phrasing:
intent: List endpoint import jobs for a project
effect: read
questions:
- Which import jobs have loaded endpoints into my application?
- Did any of my S3 endpoint imports fail for this project?
instructions:
- text: List all import jobs for application {app}.
slots:
app: path.application-id
- text: Show {page_size} import jobs at a time for project {app}.
slots:
page_size: query.page-size
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}/jobs/import'].post
update:
x-apievangelist-phrasing:
intent: Import endpoints into a project from S3
effect: write
questions:
- How do I bulk load endpoint definitions from an S3 bucket into my project?
- Can I import a file of contacts from S3 as endpoints?
instructions:
- text: Import endpoints from S3 into application {app} using {import_settings}.
slots:
app: path.application-id
import_settings: requestBody.ImportJobRequest
- text: Start a new endpoint import job for project {app}.
slots:
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}/journeys'].get
update:
x-apievangelist-phrasing:
intent: List all journeys in a project
effect: read
questions:
- What customer journeys are configured in my application?
- Can I see the status of each journey in a project?
instructions:
- text: List every journey in application {app}.
slots:
app: path.application-id
- text: Show {page_size} journeys per page for project {app}.
slots:
page_size: query.page-size
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}/journeys'].post
update:
x-apievangelist-phrasing:
intent: Create a new journey in a project
effect: write
questions:
- How do I build a multi-step customer journey for my app?
- Can I create an automated journey inside an existing project?
instructions:
- text: Create a journey in application {app} with configuration {journey}.
slots:
app: path.application-id
journey: requestBody.WriteJourneyRequest
- text: Set up a new customer journey for project {app}.
slots:
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}/segments'].get
update:
x-apievangelist-phrasing:
intent: List all audience segments in a project
effect: read
questions:
- What audience segments have I defined in my project?
- Can I list segments and their dimensions for an application?
instructions:
- text: List all segments in application {app}.
slots:
app: path.application-id
- text: Show {page_size} segments at a time for project {app}.
slots:
page_size: query.page-size
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}/segments'].post
update:
x-apievangelist-phrasing:
intent: Create a new audience segment in a project
effect: write
questions:
- How do I define a new audience segment based on dimensions or segment groups?
- Can I create a segment to target only certain users in my app?
instructions:
- text: Create a new segment in application {app} defined by {segment}.
slots:
app: path.application-id
segment: requestBody.WriteSegmentRequest
- text: Add a fresh audience segment to project {app}.
slots:
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}/channels/adm'].get
update:
x-apievangelist-phrasing:
intent: View Amazon Device Messaging channel settings
effect: read
questions:
- Is the ADM channel for Kindle push notifications enabled in my project?
- What are the current Amazon Device Messaging settings for my app?
instructions:
- text: Show the ADM channel settings for application {app}.
slots:
app: path.application-id
- text: Check whether Amazon Device Messaging is turned on for project {app}.
slots:
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}/channels/adm'].put
update:
x-apievangelist-phrasing:
intent: Enable or update the ADM push channel
effect: write
questions:
- How do I turn on Amazon Device Messaging push for my Fire devices?
- Can I change the credentials used by the ADM channel?
instructions:
- text: Enable the ADM channel for application {app} with settings {adm}.
slots:
app: path.application-id
adm: requestBody.ADMChannelRequest
- text: Update the Amazon Device Messaging credentials on project {app}.
slots:
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}/channels/adm'].delete
update:
x-apievangelist-phrasing:
intent: Disable the ADM push channel
effect: destructive
questions:
- How do I stop sending Amazon Device Messaging pushes from my project?
- What happens to my ADM settings if I disable that channel?
instructions:
- text: Disable the ADM channel and delete its settings for application {app}.
slots:
app: path.application-id
- text: Turn off Amazon Device Messaging for project {app}.
slots:
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}/channels/apns'].get
update:
x-apievangelist-phrasing:
intent: View the production APNs channel settings
effect: read
questions:
- Is production Apple push (APNs) enabled for my iOS app's project?
- What certificate or token settings does my APNs channel currently use?
instructions:
- text: Show the production APNs channel for application {app}.
slots:
app: path.application-id
- text: Check the Apple Push Notification service status on project {app}.
slots:
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}/channels/apns'].put
update:
x-apievangelist-phrasing:
intent: Enable or update the production APNs channel
effect: write
questions:
- How do I enable production iOS push notifications through APNs?
- Can I rotate the credentials on my live Apple push channel?
instructions:
- text: Enable production APNs for application {app} with settings {apns}.
slots:
app: path.application-id
apns: requestBody.APNSChannelRequest
- text: Update the live Apple push channel credentials on project {app}.
slots:
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}/channels/apns'].delete
update:
x-apievangelist-phrasing:
intent: Disable the production APNs channel
effect: destructive
questions:
- How do I switch off production iOS push for a project?
- Will disabling the live APNs channel delete its credentials?
instructions:
- text: Disable the production APNs channel for application {app}.
slots:
app: path.application-id
- text: Remove the live Apple push settings from project {app}.
slots:
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}/channels/apns_sandbox'].get
update:
x-apievangelist-phrasing:
intent: View the APNs sandbox channel settings
effect: read
questions:
- Is the APNs sandbox set up for testing iOS pushes in development builds?
- What settings does my Apple push sandbox channel have?
instructions:
- text: Show the APNs sandbox channel for application {app}.
slots:
app: path.application-id
- text: Check whether development Apple push is enabled on project {app}.
slots:
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}/channels/apns_sandbox'].put
update:
x-apievangelist-phrasing:
intent: Enable or update the APNs sandbox channel
effect: write
questions:
- How do I enable Apple push for my development and TestFlight builds?
- Can I update the sandbox APNs credentials without touching production?
instructions:
- text: Enable the APNs sandbox channel for application {app} with {sandbox}.
slots:
app: path.application-id
sandbox: requestBody.APNSSandboxChannelRequest
- text: Update the development Apple push credentials on project {app}.
slots:
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}/channels/apns_sandbox'].delete
update:
x-apievangelist-phrasing:
intent: Disable the APNs sandbox channel
effect: destructive
questions:
- How do I turn off sandbox Apple push for dev builds?
- Can I remove the APNs sandbox credentials from my project?
instructions:
- text: Disable the APNs sandbox channel for application {app}.
slots:
app: path.application-id
- text: Delete the development Apple push settings from project {app}.
slots:
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}/channels/apns_voip'].get
update:
x-apievangelist-phrasing:
intent: View the production APNs VoIP channel
effect: read
questions:
- Is the APNs VoIP channel enabled for my calling app?
- What are the settings on my production VoIP push channel?
instructions:
- text: Show VoIP call push configuration (APNs VoIP, production) for application {app}.
slots:
app: path.application-id
- text: Check the live VoIP push status on project {app}.
slots:
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}/channels/apns_voip'].put
update:
x-apievangelist-phrasing:
intent: Enable or update the production APNs VoIP channel
effect: write
questions:
- How do I enable VoIP push notifications for incoming calls on iOS?
- Can I change the credentials on my live APNs VoIP channel?
instructions:
- text: Enable production APNs VoIP for application {app} with {voip}.
slots:
app: path.application-id
voip: requestBody.APNSVoipChannelRequest
- text: Update the live VoIP push credentials on project {app}.
slots:
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}/channels/apns_voip'].delete
update:
x-apievangelist-phrasing:
intent: Disable the production APNs VoIP channel
effect: destructive
questions:
- How do I stop sending live VoIP pushes from my project?
- Does disabling the APNs VoIP channel wipe its settings?
instructions:
- text: Turn off VoIP call pushes in production for application {app}.
slots:
app: path.application-id
- text: Remove live VoIP push settings from project {app}.
slots:
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}/channels/apns_voip_sandbox'].get
update:
x-apievangelist-phrasing:
intent: View the APNs VoIP sandbox channel
effect: read
questions:
- Is VoIP push enabled for my development iOS builds?
- What settings does the APNs VoIP sandbox channel have?
instructions:
- text: Show the development VoIP call push configuration for application {app}.
slots:
app: path.application-id
- text: Check the development VoIP push status on project {app}.
slots:
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}/channels/apns_voip_sandbox'].put
update:
x-apievangelist-phrasing:
intent: Enable or update the APNs VoIP sandbox channel
effect: write
questions:
- How do I test VoIP call pushes on development builds?
- Can I set sandbox credentials for VoIP push separately from production?
instructions:
- text: Enable the APNs VoIP sandbox for application {app} with {voip_sandbox}.
slots:
app: path.application-id
voip_sandbox: requestBody.APNSVoipSandboxChannelRequest
- text: Update the development VoIP push credentials on project {app}.
slots:
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}/channels/apns_voip_sandbox'].delete
update:
x-apievangelist-phrasing:
intent: Disable the APNs VoIP sandbox channel
effect: destructive
questions:
- How do I turn off sandbox VoIP push for my dev builds?
- Can I delete the VoIP sandbox credentials from a project?
instructions:
- text: Turn off development VoIP call pushes for application {app}.
slots:
app: path.application-id
- text: Remove development VoIP push settings from project {app}.
slots:
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}'].get
update:
x-apievangelist-phrasing:
intent: Get details of one Pinpoint project
effect: read
questions:
- What's the name and ARN of a specific Pinpoint project?
- Can I look up one application by its project ID?
instructions:
- text: Get the details of application {app}.
slots:
app: path.application-id
- text: Look up project {app} and show its name and tags.
slots:
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a Pinpoint project
effect: destructive
questions:
- How do I permanently delete a Pinpoint project I no longer use?
- Can I remove an entire application from my account?
instructions:
- text: Delete application {app}.
slots:
app: path.application-id
- text: Permanently remove the Pinpoint project {app}.
slots:
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}/channels/baidu'].get
update:
x-apievangelist-phrasing:
intent: View the Baidu Cloud Push channel settings
effect: read
questions:
- Is Baidu Cloud Push enabled for my Android users in China?
- What are the Baidu channel settings in my project?
instructions:
- text: Show the Baidu channel settings for application {app}.
slots:
app: path.application-id
- text: Check whether Baidu Cloud Push is on for project {app}.
slots:
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}/channels/baidu'].put
update:
x-apievangelist-phrasing:
intent: Enable or update the Baidu push channel
effect: write
questions:
- How do I send push notifications through Baidu Cloud Push?
- Can I update the API key used by my Baidu channel?
instructions:
- text: Enable the Baidu channel for application {app} with {baidu}.
slots:
app: path.application-id
baidu: requestBody.BaiduChannelRequest
- text: Update the Baidu Cloud Push credentials on project {app}.
slots:
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}/channels/baidu'].delete
update:
x-apievangelist-phrasing:
intent: Disable the Baidu push channel
effect: destructive
questions:
- How do I stop pushing through Baidu for a project?
- Will turning off the Baidu channel delete its credentials?
instructions:
- text: Disable the Baidu channel for application {app}.
slots:
app: path.application-id
- text: Remove Baidu Cloud Push settings from project {app}.
slots:
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}/campaigns/{campaign-id}'].get
update:
x-apievangelist-phrasing:
intent: Get the settings and status of one campaign
effect: read
questions:
- What is the current status and schedule of a particular campaign?
- Can I see the full configuration of one campaign by its ID?
instructions:
- text: Show campaign {campaign} in application {app}.
slots:
campaign: path.campaign-id
app: path.application-id
- text: Get the configuration of campaign {campaign} from project {app}.
slots:
campaign: path.campaign-id
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}/campaigns/{campaign-id}'].put
update:
x-apievangelist-phrasing:
intent: Change the settings of an existing campaign
effect: write
questions:
- How do I change the schedule or message of a campaign that already exists?
- Can I edit a live campaign's configuration?
instructions:
- text: Update campaign {campaign} in application {app} with {changes}.
slots:
campaign: path.campaign-id
app: path.application-id
changes: requestBody.WriteCampaignRequest
- text: Edit the existing campaign {campaign} in project {app}.
slots:
campaign: path.campaign-id
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}/campaigns/{campaign-id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a campaign
effect: destructive
questions:
- How do I remove a campaign I no longer need?
- Can I delete one campaign without affecting the rest of the project?
instructions:
- text: Delete campaign {campaign} from application {app}.
slots:
campaign: path.campaign-id
app: path.application-id
- text: Remove campaign {campaign} from project {app} permanently.
slots:
campaign: path.campaign-id
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}/channels/email'].get
update:
x-apievangelist-phrasing:
intent: View the email channel settings
effect: read
questions:
- Is email sending enabled for my project, and from which address?
- What are the current email channel settings for my app?
instructions:
- text: Show the email channel settings for application {app}.
slots:
app: path.application-id
- text: Check whether email is enabled on project {app}.
slots:
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}/channels/email'].put
update:
x-apievangelist-phrasing:
intent: Enable or update the email channel
effect: write
questions:
- How do I enable email sending for my project?
- Can I change the from address on my email channel?
instructions:
- text: Enable the email channel for application {app} with {email}.
slots:
app: path.application-id
email: requestBody.EmailChannelRequest
- text: Update the email sending settings on project {app}.
slots:
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}/channels/email'].delete
update:
x-apievangelist-phrasing:
intent: Disable the email channel
effect: destructive
questions:
- How do I turn off email sending for a project?
- Does disabling the email channel remove its configuration?
instructions:
- text: Disable the email channel for application {app}.
slots:
app: path.application-id
- text: Remove the email channel settings from project {app}.
slots:
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}/endpoints/{endpoint-id}'].get
update:
x-apievangelist-phrasing:
intent: Get the attributes of one endpoint
effect: read
questions:
- What address, channel and attributes are stored on a particular endpoint?
- Can I look up a single device or email endpoint by its ID?
instructions:
- text: Show endpoint {endpoint} in application {app}.
slots:
endpoint: path.endpoint-id
app: path.application-id
- text: Get the settings and attributes of endpoint {endpoint} in project {app}.
slots:
endpoint: path.endpoint-id
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}/endpoints/{endpoint-id}'].put
update:
x-apievangelist-phrasing:
intent: Create or update a single endpoint
effect: write
questions:
- How do I register one device token or email address as an endpoint?
- Can I set custom attributes on a single endpoint, and do they overwrite old values?
instructions:
- text: Create or update endpoint {endpoint} in application {app} with {endpoint_settings}.
slots:
endpoint: path.endpoint-id
app: path.application-id
endpoint_settings: requestBody.EndpointRequest
- text: Set custom attributes on the single endpoint {endpoint} in project {app}.
slots:
endpoint: path.endpoint-id
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}/endpoints/{endpoint-id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete one endpoint
effect: destructive
questions:
- How do I remove a single device or address from my project?
- Can I delete one endpoint without deleting the user's other endpoints?
instructions:
- text: Delete endpoint {endpoint} from application {app}.
slots:
endpoint: path.endpoint-id
app: path.application-id
- text: Remove the single endpoint {endpoint} from project {app}.
slots:
endpoint: path.endpoint-id
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}/eventstream'].get
update:
x-apievangelist-phrasing:
intent: View a project's event stream settings
effect: read
questions:
- Where are my project's engagement events being streamed to?
- What Kinesis stream and IAM role does my event stream use?
instructions:
- text: Show the event stream settings for application {app}.
slots:
app: path.application-id
- text: Check which stream project {app} publishes events to.
slots:
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}/eventstream'].post
update:
x-apievangelist-phrasing:
intent: Create or update a project's event stream
effect: write
questions:
- How do I stream my messaging events to Kinesis?
- Can I change the IAM role used to publish my event stream?
instructions:
- text: Configure the event stream for application {app} with {stream}.
slots:
app: path.application-id
stream: requestBody.WriteEventStream
- text: Point project {app}'s event stream at a new destination.
slots:
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}/eventstream'].delete
update:
x-apievangelist-phrasing:
intent: Delete a project's event stream
effect: destructive
questions:
- How do I stop exporting events from my project to a stream?
- Can I remove the event stream configuration entirely?
instructions:
- text: Delete the event stream for application {app}.
slots:
app: path.application-id
- text: Stop streaming events from project {app}.
slots:
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}/channels/gcm'].get
update:
x-apievangelist-phrasing:
intent: View the GCM / Firebase push channel settings
effect: read
questions:
- Is Firebase Cloud Messaging push enabled for my Android app?
- What are the GCM channel settings in my project?
instructions:
- text: Show the GCM channel settings for application {app}.
slots:
app: path.application-id
- text: Check whether Firebase push is on for project {app}.
slots:
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}/channels/gcm'].put
update:
x-apievangelist-phrasing:
intent: Enable or update the GCM / Firebase push channel
effect: write
questions:
- How do I enable Android push notifications through Firebase Cloud Messaging?
- Can I update the FCM credentials on my GCM channel?
instructions:
- text: Enable the GCM channel for application {app} with {gcm}.
slots:
app: path.application-id
gcm: requestBody.GCMChannelRequest
- text: Update the Firebase push credentials on project {app}.
slots:
app: path.application-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/{application-id}/channels/gcm'].delete
update:
x-apievangelist-phrasing:
intent: Disable the GCM / Firebase push channel
effect: destructive
questions:
- How do I stop Android pushes through Firebase for a project?
- Will disabling GCM delete its stored credentials?
instructions:
- text: Disable the GCM channel for application {app}.
slots:
app: path.application-id
- text: Remove the Firebase push settings from project {app}.
slots:
app: path.application-id
method: generated
generated: '2026-09-26'
# --- truncated at 32 KB (60 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/overlays/amazon-pinpoint-apps-api-phrasing-overlay.yaml