Amazon Pinpoint

Amazon Pinpoint Apps API

The Apps API from Amazon Pinpoint — 48 operation(s) for apps.

GitHub OpenAPI

Operations 87

POST /v1/apps Amazon Pinpoint Create App #
GET /v1/apps Amazon Pinpoint Get Apps #
POST /v1/apps/{application-id}/campaigns Amazon Pinpoint Create Campaign #
GET /v1/apps/{application-id}/campaigns Amazon Pinpoint Get Campaigns #
POST /v1/apps/{application-id}/jobs/export Amazon Pinpoint Create Export Job #
GET /v1/apps/{application-id}/jobs/export Amazon Pinpoint Get Export Jobs #
POST /v1/apps/{application-id}/jobs/import Amazon Pinpoint Create Import Job #
GET /v1/apps/{application-id}/jobs/import Amazon Pinpoint Get Import Jobs #
POST /v1/apps/{application-id}/journeys Amazon Pinpoint Create Journey #
GET /v1/apps/{application-id}/journeys Amazon Pinpoint List Journeys #
POST /v1/apps/{application-id}/segments Amazon Pinpoint Create Segment #
GET /v1/apps/{application-id}/segments Amazon Pinpoint Get Segments #
DELETE /v1/apps/{application-id}/channels/adm Amazon Pinpoint Delete Adm Channel #
GET /v1/apps/{application-id}/channels/adm Amazon Pinpoint Get Adm Channel #
PUT /v1/apps/{application-id}/channels/adm Amazon Pinpoint Update Adm Channel #
DELETE /v1/apps/{application-id}/channels/apns Amazon Pinpoint Delete Apns Channel #
GET /v1/apps/{application-id}/channels/apns Amazon Pinpoint Get Apns Channel #
PUT /v1/apps/{application-id}/channels/apns Amazon Pinpoint Update Apns Channel #
DELETE /v1/apps/{application-id}/channels/apns_sandbox Amazon Pinpoint Delete Apns Sandbox Channel #
GET /v1/apps/{application-id}/channels/apns_sandbox Amazon Pinpoint Get Apns Sandbox Channel #
PUT /v1/apps/{application-id}/channels/apns_sandbox Amazon Pinpoint Update Apns Sandbox Channel #
DELETE /v1/apps/{application-id}/channels/apns_voip Amazon Pinpoint Delete Apns Voip Channel #
GET /v1/apps/{application-id}/channels/apns_voip Amazon Pinpoint Get Apns Voip Channel #
PUT /v1/apps/{application-id}/channels/apns_voip Amazon Pinpoint Update Apns Voip Channel #
DELETE /v1/apps/{application-id}/channels/apns_voip_sandbox Amazon Pinpoint Delete Apns Voip Sandbox Channel #
GET /v1/apps/{application-id}/channels/apns_voip_sandbox Amazon Pinpoint Get Apns Voip Sandbox Channel #
PUT /v1/apps/{application-id}/channels/apns_voip_sandbox Amazon Pinpoint Update Apns Voip Sandbox Channel #
DELETE /v1/apps/{application-id} Amazon Pinpoint Delete App #
GET /v1/apps/{application-id} Amazon Pinpoint Get App #
DELETE /v1/apps/{application-id}/channels/baidu Amazon Pinpoint Delete Baidu Channel #
GET /v1/apps/{application-id}/channels/baidu Amazon Pinpoint Get Baidu Channel #
PUT /v1/apps/{application-id}/channels/baidu Amazon Pinpoint Update Baidu Channel #
DELETE /v1/apps/{application-id}/campaigns/{campaign-id} Amazon Pinpoint Delete Campaign #
GET /v1/apps/{application-id}/campaigns/{campaign-id} Amazon Pinpoint Get Campaign #
PUT /v1/apps/{application-id}/campaigns/{campaign-id} Amazon Pinpoint Update Campaign #
DELETE /v1/apps/{application-id}/channels/email Amazon Pinpoint Delete Email Channel #
GET /v1/apps/{application-id}/channels/email Amazon Pinpoint Get Email Channel #
PUT /v1/apps/{application-id}/channels/email Amazon Pinpoint Update Email Channel #
DELETE /v1/apps/{application-id}/endpoints/{endpoint-id} Amazon Pinpoint Delete Endpoint #
GET /v1/apps/{application-id}/endpoints/{endpoint-id} Amazon Pinpoint Get Endpoint #
PUT /v1/apps/{application-id}/endpoints/{endpoint-id} Amazon Pinpoint Update Endpoint #
DELETE /v1/apps/{application-id}/eventstream Amazon Pinpoint Delete Event Stream #
GET /v1/apps/{application-id}/eventstream Amazon Pinpoint Get Event Stream #
POST /v1/apps/{application-id}/eventstream Amazon Pinpoint Put Event Stream #
DELETE /v1/apps/{application-id}/channels/gcm Amazon Pinpoint Delete Gcm Channel #
GET /v1/apps/{application-id}/channels/gcm Amazon Pinpoint Get Gcm Channel #
PUT /v1/apps/{application-id}/channels/gcm Amazon Pinpoint Update Gcm Channel #
DELETE /v1/apps/{application-id}/journeys/{journey-id} Amazon Pinpoint Delete Journey #
GET /v1/apps/{application-id}/journeys/{journey-id} Amazon Pinpoint Get Journey #
PUT /v1/apps/{application-id}/journeys/{journey-id} Amazon Pinpoint Update Journey #
DELETE /v1/apps/{application-id}/segments/{segment-id} Amazon Pinpoint Delete Segment #
GET /v1/apps/{application-id}/segments/{segment-id} Amazon Pinpoint Get Segment #
PUT /v1/apps/{application-id}/segments/{segment-id} Amazon Pinpoint Update Segment #
DELETE /v1/apps/{application-id}/channels/sms Amazon Pinpoint Delete Sms Channel #
GET /v1/apps/{application-id}/channels/sms Amazon Pinpoint Get Sms Channel #
PUT /v1/apps/{application-id}/channels/sms Amazon Pinpoint Update Sms Channel #
DELETE /v1/apps/{application-id}/users/{user-id} Amazon Pinpoint Delete User Endpoints #
GET /v1/apps/{application-id}/users/{user-id} Amazon Pinpoint Get User Endpoints #
DELETE /v1/apps/{application-id}/channels/voice Amazon Pinpoint Delete Voice Channel #
GET /v1/apps/{application-id}/channels/voice Amazon Pinpoint Get Voice Channel #
PUT /v1/apps/{application-id}/channels/voice Amazon Pinpoint Update Voice Channel #
GET /v1/apps/{application-id}/kpis/daterange/{kpi-name} Amazon Pinpoint Get Application Date Range Kpi #
GET /v1/apps/{application-id}/settings Amazon Pinpoint Get Application Settings #
PUT /v1/apps/{application-id}/settings Amazon Pinpoint Update Application Settings #
GET /v1/apps/{application-id}/campaigns/{campaign-id}/activities Amazon Pinpoint Get Campaign Activities #
GET /v1/apps/{application-id}/campaigns/{campaign-id}/kpis/daterange/{kpi-name} Amazon Pinpoint Get Campaign Date Range Kpi #
GET /v1/apps/{application-id}/campaigns/{campaign-id}/versions/{version} Amazon Pinpoint Get Campaign Version #
GET /v1/apps/{application-id}/campaigns/{campaign-id}/versions Amazon Pinpoint Get Campaign Versions #
GET /v1/apps/{application-id}/channels Amazon Pinpoint Get Channels #
GET /v1/apps/{application-id}/jobs/export/{job-id} Amazon Pinpoint Get Export Job #
GET /v1/apps/{application-id}/jobs/import/{job-id} Amazon Pinpoint Get Import Job #
GET /v1/apps/{application-id}/endpoints/{endpoint-id}/inappmessages Amazon Pinpoint Get in App Messages #
GET /v1/apps/{application-id}/journeys/{journey-id}/kpis/daterange/{kpi-name} Amazon Pinpoint Get Journey Date Range Kpi #
GET /v1/apps/{application-id}/journeys/{journey-id}/activities/{journey-activity-id}/execution-metrics Amazon Pinpoint Get Journey Execution Activity Metrics #
GET /v1/apps/{application-id}/journeys/{journey-id}/execution-metrics Amazon Pinpoint Get Journey Execution Metrics #
GET /v1/apps/{application-id}/segments/{segment-id}/jobs/export Amazon Pinpoint Get Segment Export Jobs #
GET /v1/apps/{application-id}/segments/{segment-id}/jobs/import Amazon Pinpoint Get Segment Import Jobs #
GET /v1/apps/{application-id}/segments/{segment-id}/versions/{version} Amazon Pinpoint Get Segment Version #
GET /v1/apps/{application-id}/segments/{segment-id}/versions Amazon Pinpoint Get Segment Versions #
POST /v1/apps/{application-id}/events Amazon Pinpoint Put Events #
PUT /v1/apps/{application-id}/attributes/{attribute-type} Amazon Pinpoint Remove Attributes #
POST /v1/apps/{application-id}/messages Amazon Pinpoint Send Messages #
POST /v1/apps/{application-id}/otp Amazon Pinpoint Send O T P Message #
POST /v1/apps/{application-id}/users-messages Amazon Pinpoint Send Users Messages #
PUT /v1/apps/{application-id}/endpoints Amazon Pinpoint Update Endpoints Batch #
PUT /v1/apps/{application-id}/journeys/{journey-id}/state Amazon Pinpoint Update Journey State #
POST /v1/apps/{application-id}/verify-otp Amazon Pinpoint Verify O T P Message #

Documentation

📖
Documentation
https://docs.aws.amazon.com/pinpoint/latest/developerguide/welcome.html
📖
APIReference
https://docs.aws.amazon.com/pinpoint/latest/apireference/welcome.html
📖
GettingStarted
https://aws.amazon.com/pinpoint/getting-started/
📖
RateLimits
https://docs.aws.amazon.com/pinpoint/latest/developerguide/quotas.html
📖
Authentication
https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/openapi/amazon-pinpoint-apps-api-openapi.yml

Other Resources

🔗
Pricing
https://aws.amazon.com/pinpoint/pricing/
🔗
FAQ
https://aws.amazon.com/pinpoint/faqs/
🔗
Features
https://aws.amazon.com/pinpoint/features/

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/amazon-pinpoint-apps-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-pinpoint-apps-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 1.0.0
  x-release: v4
  title: Amazon Pinpoint Applications Apps API
  description: Doc Engage API - Amazon Pinpoint API
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: pinpoint
  x-aws-signingName: mobiletargeting
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/pinpoint-2016-12-01.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://pinpoint.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon Pinpoint multi-region endpoint
- url: https://pinpoint.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon Pinpoint multi-region endpoint
- url: http://pinpoint.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon Pinpoint endpoint for China (Beijing) and China (Ningxia)
- url: https://pinpoint.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon Pinpoint endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Apps
paths:
  /v1/apps:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: CreateApp
      description: ' <p>Creates an application.</p>'
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAppResponse'
        '480':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '481':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '482':
          description: PayloadTooLargeException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayloadTooLargeException'
        '483':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '484':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '485':
          description: MethodNotAllowedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MethodNotAllowedException'
        '486':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - CreateApplicationRequest
              properties:
                CreateApplicationRequest:
                  description: Specifies the display name of an application and the tags to associate with the application.
                  type: object
                  properties:
                    Name:
                      allOf:
                      - $ref: '#/components/schemas/__string'
                      - description: The display name of the application. This name is displayed as the <b>Project name</b> on the Amazon Pinpoint console.
                    tags:
                      allOf:
                      - $ref: '#/components/schemas/MapOf__string'
                      - description: A string-to-string map of key-value pairs that defines the tags to associate with the application. Each tag consists of a required tag key and an associated tag value.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Amazon Pinpoint Create App
      tags:
      - Apps
    get:
      operationId: GetApps
      description: Retrieves information about all the applications that are associated with your Amazon Pinpoint account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAppsResponse'
        '480':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '481':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '482':
          description: PayloadTooLargeException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayloadTooLargeException'
        '483':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '484':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '485':
          description: MethodNotAllowedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MethodNotAllowedException'
        '486':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      parameters:
      - name: page-size
        in: query
        required: false
        description: The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
        schema:
          type: string
      - name: token
        in: query
        required: false
        description: The NextToken string that specifies which page of results to return in a paginated response.
        schema:
          type: string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Amazon Pinpoint Get Apps
      tags:
      - Apps
  /v1/apps/{application-id}/campaigns:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: CreateCampaign
      description: Creates a new campaign for an application or updates the settings of an existing campaign for an application.
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCampaignResponse'
        '480':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '481':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '482':
          description: PayloadTooLargeException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayloadTooLargeException'
        '483':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '484':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '485':
          description: MethodNotAllowedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MethodNotAllowedException'
        '486':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      parameters:
      - name: application-id
        in: path
        required: true
        description: The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - WriteCampaignRequest
              properties:
                WriteCampaignRequest:
                  description: Specifies the configuration and other settings for a campaign.
                  type: object
                  properties:
                    AdditionalTreatments:
                      allOf:
                      - $ref: '#/components/schemas/ListOfWriteTreatmentResource'
                      - description: An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
                    CustomDeliveryConfiguration:
                      allOf:
                      - $ref: '#/components/schemas/CustomDeliveryConfiguration'
                      - description: The delivery configuration settings for sending the campaign through a custom channel. This object is required if the MessageConfiguration object for the campaign specifies a CustomMessage object.
                    Description:
                      allOf:
                      - $ref: '#/components/schemas/__string'
                      - description: A custom description of the campaign.
                    HoldoutPercent:
                      allOf:
                      - $ref: '#/components/schemas/__integer'
                      - description: The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
                    Hook:
                      allOf:
                      - $ref: '#/components/schemas/CampaignHook'
                      - description: The settings for the AWS Lambda function to invoke as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.
                    IsPaused:
                      allOf:
                      - $ref: '#/components/schemas/__boolean'
                      - description: Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false.
                    Limits:
                      allOf:
                      - $ref: '#/components/schemas/CampaignLimits'
                      - description: The messaging limits for the campaign.
                    MessageConfiguration:
                      allOf:
                      - $ref: '#/components/schemas/MessageConfiguration'
                      - description: The message configuration settings for the campaign.
                    Name:
                      allOf:
                      - $ref: '#/components/schemas/__string'
                      - description: A custom name for the campaign.
                    Schedule:
                      allOf:
                      - $ref: '#/components/schemas/Schedule'
                      - description: The schedule settings for the campaign.
                    SegmentId:
                      allOf:
                      - $ref: '#/components/schemas/__string'
                      - description: The unique identifier for the segment to associate with the campaign.
                    SegmentVersion:
                      allOf:
                      - $ref: '#/components/schemas/__integer'
                      - description: The version of the segment to associate with the campaign.
                    tags:
                      allOf:
                      - $ref: '#/components/schemas/MapOf__string'
                      - description: A string-to-string map of key-value pairs that defines the tags to associate with the campaign. Each tag consists of a required tag key and an associated tag value.
                    TemplateConfiguration:
                      allOf:
                      - $ref: '#/components/schemas/TemplateConfiguration'
                      - description: The message template to use for the campaign.
                    TreatmentDescription:
                      allOf:
                      - $ref: '#/components/schemas/__string'
                      - description: A custom description of the default treatment for the campaign.
                    TreatmentName:
                      allOf:
                      - $ref: '#/components/schemas/__string'
                      - description: A custom name of the default treatment for the campaign, if the campaign has multiple treatments. A <i>treatment</i> is a variation of a campaign that's used for A/B testing.
                    Priority:
                      allOf:
                      - $ref: '#/components/schemas/__integer'
                      - description: Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Amazon Pinpoint Create Campaign
      tags:
      - Apps
    get:
      operationId: GetCampaigns
      description: Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCampaignsResponse'
        '480':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '481':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '482':
          description: PayloadTooLargeException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayloadTooLargeException'
        '483':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '484':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '485':
          description: MethodNotAllowedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MethodNotAllowedException'
        '486':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      parameters:
      - name: application-id
        in: path
        required: true
        description: The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.
        schema:
          type: string
      - name: page-size
        in: query
        required: false
        description: The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
        schema:
          type: string
      - name: token
        in: query
        required: false
        description: The NextToken string that specifies which page of results to return in a paginated response.
        schema:
          type: string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Amazon Pinpoint Get Campaigns
      tags:
      - Apps
  /v1/apps/{application-id}/jobs/export:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: CreateExportJob
      description: Creates an export job for an application.
      responses:
        '202':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateExportJobResponse'
        '480':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '481':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '482':
          description: PayloadTooLargeException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayloadTooLargeException'
        '483':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '484':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '485':
          description: MethodNotAllowedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MethodNotAllowedException'
        '486':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      parameters:
      - name: application-id
        in: path
        required: true
        description: The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - ExportJobRequest
              properties:
                ExportJobRequest:
                  description: Specifies the settings for a job that exports endpoint definitions to an Amazon Simple Storage Service (Amazon S3) bucket.
                  type: object
                  properties:
                    RoleArn:
                      allOf:
                      - $ref: '#/components/schemas/__string'
                      - description: The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location where you want to export endpoint definitions to.
                    S3UrlPrefix:
                      allOf:
                      - $ref: '#/components/schemas/__string'
                      - description: 'The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where you want to export endpoint definitions to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://<replaceable>bucket-name</replaceable>/<replaceable>folder-name</replaceable>/.'
                    SegmentId:
                      allOf:
                      - $ref: '#/components/schemas/__string'
                      - description: The identifier for the segment to export endpoint definitions from. If you don't specify this value, Amazon Pinpoint exports definitions for all the endpoints that are associated with the application.
                    SegmentVersion:
                      allOf:
                      - $ref: '#/components/schemas/__integer'
                      - description: The version of the segment to export endpoint definitions from, if specified.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Amazon Pinpoint Create Export Job
      tags:
      - Apps
    get:
      operationId: GetExportJobs
      description: Retrieves information about the status and settings of all the export jobs for an application.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetExportJobsResponse'
        '480':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '481':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '482':
          description: PayloadTooLargeException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayloadTooLargeException'
        '483':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '484':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '485':
          description: MethodNotAllowedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MethodNotAllowedException'
        '486':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      parameters:
      - name: application-id
        in: path
        required: true
        description: The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.
        schema:
          type: string
      - name: page-size
        in: query
        required: false
        description: The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
        schema:
          type: string
      - name: token
        in: query
        required: false
        description: The NextToken string that specifies which page of results to return in a paginated response.
        schema:
          type: string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Amazon Pinpoint Get Export Jobs
      tags:
      - Apps
  /v1/apps/{application-id}/jobs/import:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: CreateImportJob
      description: Creates an import job for an application.
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateImportJobResponse'
        '480':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '481':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '482':
          description: PayloadTooLargeException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayloadTooLargeException'
        '483':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '484':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '485':
          description: MethodNotAllowedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MethodNotAllowedException'
        '486':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      parameters:
      - name: application-id
        in: path
        required: true
        description: The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - ImportJobRequest
              properties:
                ImportJobRequest:
                  description: Specifies the settings for a job that imports endpoint definitions from an Amazon Simple Storage Service (Amazon S3) bucket.
                  type: object
                  properties:
                    DefineSegment:
                      allOf:
                      - $ref: '#/components/schemas/__boolean'
                      - description: Specifies whether to create a segment that contains the endpoints, when the endpoint definitions are imported.
                    ExternalId:
                      allOf:
                      - $ref: '#/components/schemas/__string'
                      - description: (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
                    Format:
                      allOf:
                      - $ref: '#/components/schemas/Format'
                      - description: 'The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format. If the Amazon S3 location stores multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.'
                    RegisterEndpoints:
                      allOf:
                      - $ref: '#/components/schemas/__boolean'
                      - description: Specifies whether to register the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.
                    RoleArn:
                      allOf:
                      - $ref: '#/components/schemas/__string'
                      - description: The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
                    S3Url:
                      allOf:
                      - $ref: '#/components/schemas/__string'
                      - description: '<p>The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains.</p> <p>The URL should be in the following format: s3://<replaceable>bucket-name</replaceable>/<replaceable>folder-name</replaceable>/<replaceable>file-name</replaceable>. The location can end with the key for an individual object or a prefix that qualifies multiple objects.</p>'
                    SegmentId:
                      allOf:
                      - $ref: '#/components/schemas/__string'
                      - description: The identifier for the segment to update or add the imported endpoint definitions to, if the import job is meant to update an existing segment.
                    SegmentName:
                      allOf:
                      - $ref: '#/components/schemas/__string'
                      - description: A custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Amazon Pinpoint Create Import Job
      tags:
      - Apps
    get:
      operationId: GetImportJobs
      description: Retrieves information about the status and settings of all the import jobs for an application.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/G

# --- truncated at 32 KB (554 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/openapi/amazon-pinpoint-apps-api-openapi.yml