amazon-pinpoint — quality + safety report

---
name: amazon-pinpoint
description: "Amazon Pinpoint API skill. Use when working with Amazon Pinpoint for apps, templates, recommenders. Covers 122 endpoints."
version: 1.0.0
generator: lapsh
---

# Amazon Pinpoint
API version: 2016-12-01

## Auth
AWS SigV4

## Base URL
Not specified.

## Setup
1. Configure auth: AWS SigV4
2. GET /v1/apps -- verify access
3. POST /v1/apps -- create first apps

## Endpoints

122 endpoints across 5 groups. See references/api-spec.lap for full details.

### apps
| Method | Path | Description |
|--------|------|-------------|
| POST | /v1/apps | Creates an application. |
| POST | /v1/apps/{application-id}/campaigns | Creates a new campaign for an application or updates the settings of an existing campaign for an application. |
| POST | /v1/apps/{application-id}/jobs/export | Creates an export job for an application. |
| POST | /v1/apps/{application-id}/jobs/import | Creates an import job for an application. |
| POST | /v1/apps/{application-id}/journeys | Creates a journey for an application. |
| POST | /v1/apps/{application-id}/segments | 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. |
| DELETE | /v1/apps/{application-id}/channels/adm | Disables the ADM channel for an application and deletes any existing settings for the channel. |
| DELETE | /v1/apps/{application-id}/channels/apns | Disables the APNs channel for an application and deletes any existing settings for the channel. |
| DELETE | /v1/apps/{application-id}/channels/apns_sandbox | Disables the APNs sandbox channel for an application and deletes any existing settings for the channel. |
| DELETE | /v1/apps/{application-id}/channels/apns_voip | Disables the APNs VoIP channel for an application and deletes any existing settings for the channel. |
| DELETE | /v1/apps/{application-id}/channels/apns_voip_sandbox | Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel. |
| DELETE | /v1/apps/{application-id} | Deletes an application. |
| DELETE | /v1/apps/{application-id}/channels/baidu | Disables the Baidu channel for an application and deletes any existing settings for the channel. |
| DELETE | /v1/apps/{application-id}/campaigns/{campaign-id} | Deletes a campaign from an application. |
| DELETE | /v1/apps/{application-id}/channels/email | Disables the email channel for an application and deletes any existing settings for the channel. |
| DELETE | /v1/apps/{application-id}/endpoints/{endpoint-id} | Deletes an endpoint from an application. |
| DELETE | /v1/apps/{application-id}/eventstream | Deletes the event stream for an application. |
| DELETE | /v1/apps/{application-id}/channels/gcm | Disables the GCM channel for an application and deletes any existing settings for the channel. |
| DELETE | /v1/apps/{application-id}/journeys/{journey-id} | Deletes a journey from an application. |
| DELETE | /v1/apps/{application-id}/segments/{segment-id} | Deletes a segment from an application. |
| DELETE | /v1/apps/{application-id}/channels/sms | Disables the SMS channel for an application and deletes any existing settings for the channel. |
| DELETE | /v1/apps/{application-id}/users/{user-id} | Deletes all the endpoints that are associated with a specific user ID. |
| DELETE | /v1/apps/{application-id}/channels/voice | Disables the voice channel for an application and deletes any existing settings for the channel. |
| GET | /v1/apps/{application-id}/channels/adm | Retrieves information about the status and settings of the ADM channel for an application. |
| GET | /v1/apps/{application-id}/channels/apns | Retrieves information about the status and settings of the APNs channel for an application. |
| GET | /v1/apps/{application-id}/channels/apns_sandbox | Retrieves information about the status and settings of the APNs sandbox channel for an application. |
| GET | /v1/apps/{application-id}/channels/apns_voip | Retrieves information about the status and settings of the APNs VoIP channel for an application. |
| GET | /v1/apps/{application-id}/channels/apns_voip_sandbox | Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application. |
| GET | /v1/apps/{application-id} | Retrieves information about an application. |
| GET | /v1/apps/{application-id}/kpis/daterange/{kpi-name} | Retrieves (queries) pre-aggregated data for a standard metric that applies to an application. |
| GET | /v1/apps/{application-id}/settings | Retrieves information about the settings for an application. |
| GET | /v1/apps | Retrieves information about all the applications that are associated with your Amazon Pinpoint account. |
| GET | /v1/apps/{application-id}/channels/baidu | Retrieves information about the status and settings of the Baidu channel for an application. |
| GET | /v1/apps/{application-id}/campaigns/{campaign-id} | Retrieves information about the status, configuration, and other settings for a campaign. |
| GET | /v1/apps/{application-id}/campaigns/{campaign-id}/activities | Retrieves information about all the activities for a campaign. |
| GET | /v1/apps/{application-id}/campaigns/{campaign-id}/kpis/daterange/{kpi-name} | Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign. |
| GET | /v1/apps/{application-id}/campaigns/{campaign-id}/versions/{version} | Retrieves information about the status, configuration, and other settings for a specific version of a campaign. |
| GET | /v1/apps/{application-id}/campaigns/{campaign-id}/versions | Retrieves information about the status, configuration, and other settings for all versions of a campaign. |
| GET | /v1/apps/{application-id}/campaigns | Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application. |
| GET | /v1/apps/{application-id}/channels | Retrieves information about the history and status of each channel for an application. |
| GET | /v1/apps/{application-id}/channels/email | Retrieves information about the status and settings of the email channel for an application. |
| GET | /v1/apps/{application-id}/endpoints/{endpoint-id} | Retrieves information about the settings and attributes of a specific endpoint for an application. |
| GET | /v1/apps/{application-id}/eventstream | Retrieves information about the event stream settings for an application. |
| GET | /v1/apps/{application-id}/jobs/export/{job-id} | Retrieves information about the status and settings of a specific export job for an application. |
| GET | /v1/apps/{application-id}/jobs/export | Retrieves information about the status and settings of all the export jobs for an application. |
| GET | /v1/apps/{application-id}/channels/gcm | Retrieves information about the status and settings of the GCM channel for an application. |
| GET | /v1/apps/{application-id}/jobs/import/{job-id} | Retrieves information about the status and settings of a specific import job for an application. |
| GET | /v1/apps/{application-id}/jobs/import | Retrieves information about the status and settings of all the import jobs for an application. |
| GET | /v1/apps/{application-id}/endpoints/{endpoint-id}/inappmessages | Retrieves the in-app messages targeted for the provided endpoint ID. |
| GET | /v1/apps/{application-id}/journeys/{journey-id} | Retrieves information about the status, configuration, and other settings for a journey. |
| GET | /v1/apps/{application-id}/journeys/{journey-id}/kpis/daterange/{kpi-name} | Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey. |
| GET | /v1/apps/{application-id}/journeys/{journey-id}/activities/{journey-activity-id}/execution-metrics | Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity. |
| GET | /v1/apps/{application-id}/journeys/{journey-id}/execution-metrics | Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey. |
| GET | /v1/apps/{application-id}/journeys/{journey-id}/runs/{run-id}/activities/{journey-activity-id}/execution-metrics | Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey activity. |
| GET | /v1/apps/{application-id}/journeys/{journey-id}/runs/{run-id}/execution-metrics | Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey. |
| GET | /v1/apps/{application-id}/journeys/{journey-id}/runs | Provides information about the runs of a journey. |
| GET | /v1/apps/{application-id}/segments/{segment-id} | Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application. |
| GET | /v1/apps/{application-id}/segments/{segment-id}/jobs/export | Retrieves information about the status and settings of the export jobs for a segment. |
| GET | /v1/apps/{application-id}/segments/{segment-id}/jobs/import | Retrieves information about the status and settings of the import jobs for a segment. |
| GET | /v1/apps/{application-id}/segments/{segment-id}/versions/{version} | Retrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application. |
| GET | /v1/apps/{application-id}/segments/{segment-id}/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 | /v1/apps/{application-id}/segments | Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application. |
| GET | /v1/apps/{application-id}/channels/sms | Retrieves information about the status and settings of the SMS channel for an application. |
| GET | /v1/apps/{application-id}/users/{user-id} | Retrieves information about all the endpoints that are associated with a specific user ID. |
| GET | /v1/apps/{application-id}/channels/voice | Retrieves information about the status and settings of the voice channel for an application. |
| GET | /v1/apps/{application-id}/journeys | Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application. |
| POST | /v1/apps/{application-id}/eventstream | Creates a new event stream for an application or updates the settings of an existing event stream for an application. |
| POST | /v1/apps/{application-id}/events | Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with. |
| PUT | /v1/apps/{application-id}/attributes/{attribute-type} | Removes 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. |
| POST | /v1/apps/{application-id}/messages | Creates and sends a direct message. |
| POST | /v1/apps/{application-id}/otp | Send an OTP message |
| POST | /v1/apps/{application-id}/users-messages | Creates and sends a message to a list of users. |
| PUT | /v1/apps/{application-id}/channels/adm | Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application. |
| PUT | /v1/apps/{application-id}/channels/apns | Enables the APNs channel for an application or updates the status and settings of the APNs channel for an application. |
| PUT | /v1/apps/{application-id}/channels/apns_sandbox | Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application. |
| PUT | /v1/apps/{application-id}/channels/apns_voip | Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP

… (truncated)