openapi: 3.0.0
info:
  version: 2016-12-01
  x-release: v4
  title: Amazon Pinpoint Applications 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
      version: 1.0.0
    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: Applications
  description: Operations for managing Pinpoint applications (projects)
paths:
  /v1/apps:
    post:
      operationId: CreateApp
      summary: Amazon Pinpoint Create an Application
      description: Creates a new Pinpoint application (project).
      tags:
      - Applications
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateApplicationRequest'
      responses:
        '201':
          description: Application created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationResponse'
    get:
      operationId: GetApps
      summary: Amazon Pinpoint List Applications
      description: Retrieves information about all applications associated with your account.
      tags:
      - Applications
      responses:
        '200':
          description: Applications retrieved successfully
  /v1/apps/{application-id}:
    get:
      operationId: GetApp
      summary: Amazon Pinpoint Get Application Details
      description: Retrieves information about an application.
      tags:
      - Applications
      parameters:
      - name: application-id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Application details retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationResponse'
components:
  schemas:
    CreateApplicationRequest:
      type: object
      required:
      - Name
      properties:
        Name:
          type: string
          description: The display name of the application
        tags:
          type: object
          additionalProperties:
            type: string
    ApplicationResponse:
      type: object
      properties:
        Id:
          type: string
        Arn:
          type: string
        Name:
          type: string
        tags:
          type: object
          additionalProperties:
            type: string
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/pinpoint/
x-hasEquivalentPaths: true