Amazon Pinpoint

Amazon Pinpoint Pinpoint Eventstream API

The Pinpoint Eventstream API from Amazon Pinpoint — 1 operation(s) for pinpoint eventstream.

GitHub OpenAPI

Operations 3

DELETE /v1/apps/{ApplicationId}/eventstream Delete Event Stream #
GET /v1/apps/{ApplicationId}/eventstream Get Event Stream #
POST /v1/apps/{ApplicationId}/eventstream Put Event Stream #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-pinpoint/openapi/amazon-pinpoint-eventstream-api-openapi.yml

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:amazon-pinpoint-eventstream-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

amazon-pinpoint-eventstream-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Amazon Pinpoint Eventstream API
  version: '2016-12-01'
  description: Generated from AWS's published Smithy model for Amazon Pinpoint. 3 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://pinpoint.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Eventstream
paths:
  /v1/apps/{ApplicationId}/eventstream:
    delete:
      operationId: DeleteEventStream
      summary: Delete Event Stream
      description: Deletes the event stream for an application.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteEventStreamResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '405':
          description: MethodNotAllowedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MethodNotAllowedException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '413':
          description: PayloadTooLargeException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayloadTooLargeException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteEventStreamRequest'
      tags:
      - Eventstream
    get:
      operationId: GetEventStream
      summary: Get Event Stream
      description: Retrieves information about the event stream settings for an application.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetEventStreamResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '405':
          description: MethodNotAllowedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MethodNotAllowedException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '413':
          description: PayloadTooLargeException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayloadTooLargeException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetEventStreamRequest'
      tags:
      - Eventstream
    post:
      operationId: PutEventStream
      summary: Put Event Stream
      description: Creates a new event stream for an application or updates the settings of an existing event stream for an application.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutEventStreamResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '405':
          description: MethodNotAllowedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MethodNotAllowedException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '413':
          description: PayloadTooLargeException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayloadTooLargeException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutEventStreamRequest'
      tags:
      - Eventstream
components:
  schemas:
    DeleteEventStreamResponse:
      type: object
      properties:
        EventStream:
          $ref: '#/components/schemas/EventStream'
      required:
      - EventStream
    DeleteEventStreamRequest:
      type: object
      properties:
        ApplicationId:
          type: string
          description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
      required:
      - ApplicationId
    PutEventStreamResponse:
      type: object
      properties:
        EventStream:
          $ref: '#/components/schemas/EventStream'
      required:
      - EventStream
    NotFoundException:
      type: object
      properties:
        Message:
          type: string
          description: The message that's returned from the API.
        RequestID:
          type: string
          description: The unique identifier for the request or response.
    BadRequestException:
      type: object
      properties:
        Message:
          type: string
          description: The message that's returned from the API.
        RequestID:
          type: string
          description: The unique identifier for the request or response.
    ForbiddenException:
      type: object
      properties:
        Message:
          type: string
          description: The message that's returned from the API.
        RequestID:
          type: string
          description: The unique identifier for the request or response.
    MethodNotAllowedException:
      type: object
      properties:
        Message:
          type: string
          description: The message that's returned from the API.
        RequestID:
          type: string
          description: The unique identifier for the request or response.
    InternalServerErrorException:
      type: object
      properties:
        Message:
          type: string
          description: The message that's returned from the API.
        RequestID:
          type: string
          description: The unique identifier for the request or response.
    PutEventStreamRequest:
      type: object
      properties:
        ApplicationId:
          type: string
          description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
        WriteEventStream:
          $ref: '#/components/schemas/WriteEventStream'
      required:
      - ApplicationId
      - WriteEventStream
    EventStream:
      type: object
      properties:
        ApplicationId:
          type: string
          description: The unique identifier for the application to publish event data for.
        DestinationStreamArn:
          type: string
          description: 'The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream to publish event data to. For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name'
        ExternalId:
          type: 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 publishing event data, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
        LastModifiedDate:
          type: string
          description: The date, in ISO 8601 format, when the event stream was last modified.
        LastUpdatedBy:
          type: string
          description: The IAM user who last modified the event stream.
        RoleArn:
          type: string
          description: The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.
      required:
      - ApplicationId
      - DestinationStreamArn
      - RoleArn
    WriteEventStream:
      type: object
      properties:
        DestinationStreamArn:
          type: string
          description: 'The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream that you want to publish event data to. For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name'
        RoleArn:
          type: string
          description: The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.
      required:
      - DestinationStreamArn
      - RoleArn
    TooManyRequestsException:
      type: object
      properties:
        Message:
          type: string
          description: The message that's returned from the API.
        RequestID:
          type: string
          description: The unique identifier for the request or response.
    PayloadTooLargeException:
      type: object
      properties:
        Message:
          type: string
          description: The message that's returned from the API.
        RequestID:
          type: string
          description: The unique identifier for the request or response.
    GetEventStreamResponse:
      type: object
      properties:
        EventStream:
          $ref: '#/components/schemas/EventStream'
      required:
      - EventStream
    GetEventStreamRequest:
      type: object
      properties:
        ApplicationId:
          type: string
          description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
      required:
      - ApplicationId
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: mobiletargeting
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/pinpoint/service/2016-12-01/pinpoint-2016-12-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)