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-personalize:amazon-personalize-event-tracker-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

openapi: 3.2.0
info:
  title: Amazon Personalize Event Tracker API
  version: '2018-05-22'
  description: Generated from AWS's published Smithy model for Amazon Personalize. 4 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://personalize.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Event Tracker
paths:
  /#CreateEventTracker:
    post:
      operationId: CreateEventTracker
      summary: Create Event Tracker
      description: 'Creates an event tracker that you use when adding event data to a specified dataset group using the PutEvents API. Only one event tracker can be associated with a dataset group. You will get an error if you call CreateEventTracker using the same dataset group as an existing event tracker. When you create an event tracker, the response includes a tracking ID, which you pass as a parameter when you use the PutEvents operation. Amazon Personalize then appends the event data to the Item interactions dataset of the dataset group you specify in your event tracker. The event tracker can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE IN_PROGRESS To get the status of the event tracker, call DescribeEventTracker. The event tracker must be in the ACTIVE state before using the tracking ID. Related APIs ListEventTrackers DescribeEventTracker DeleteEventTracker'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateEventTrackerResponse'
        '400':
          description: InvalidInputException; TooManyTagsException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
        '409':
          description: LimitExceededException; ResourceInUseException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '403':
          description: ResourceAlreadyExistsException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceAlreadyExistsException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonPersonalize.CreateEventTracker
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateEventTrackerRequest'
      tags:
      - Event Tracker
  /#DeleteEventTracker:
    post:
      operationId: DeleteEventTracker
      summary: Delete Event Tracker
      description: Deletes the event tracker. Does not delete the dataset from the dataset group. For more information on event trackers, see CreateEventTracker.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
        '400':
          description: InvalidInputException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
        '409':
          description: ResourceInUseException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceInUseException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonPersonalize.DeleteEventTracker
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteEventTrackerRequest'
      tags:
      - Event Tracker
  /#DescribeEventTracker:
    post:
      operationId: DescribeEventTracker
      summary: Describe Event Tracker
      description: Describes an event tracker. The response includes the trackingId and status of the event tracker. For more information on event trackers, see CreateEventTracker.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeEventTrackerResponse'
        '400':
          description: InvalidInputException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonPersonalize.DescribeEventTracker
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeEventTrackerRequest'
      tags:
      - Event Tracker
  /#ListEventTrackers:
    post:
      operationId: ListEventTrackers
      summary: List Event Trackers
      description: Returns the list of event trackers associated with the account. The response provides the properties for each event tracker, including the Amazon Resource Name (ARN) and tracking ID. For more information on event trackers, see CreateEventTracker.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListEventTrackersResponse'
        '400':
          description: InvalidInputException; InvalidNextTokenException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonPersonalize.ListEventTrackers
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListEventTrackersRequest'
      tags:
      - Event Tracker
components:
  schemas:
    LimitExceededException:
      type: object
      properties:
        message:
          type: string
    ResourceAlreadyExistsException:
      type: object
      properties:
        message:
          type: string
    ListEventTrackersRequest:
      type: object
      properties:
        datasetGroupArn:
          type: string
          description: The ARN of a dataset group used to filter the response.
        nextToken:
          type: string
          description: A token returned from the previous call to ListEventTrackers for getting the next set of event trackers (if they exist).
        maxResults:
          type: integer
          description: The maximum number of event trackers to return.
    ResourceInUseException:
      type: object
      properties:
        message:
          type: string
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    CreateEventTrackerRequest:
      type: object
      properties:
        name:
          type: string
          description: The name for the event tracker.
        datasetGroupArn:
          type: string
          description: The Amazon Resource Name (ARN) of the dataset group that receives the event data.
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of tags to apply to the event tracker.
      required:
      - name
      - datasetGroupArn
    Tag:
      type: object
      properties:
        tagKey:
          type: string
          description: One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.
        tagValue:
          type: string
          description: The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).
      required:
      - tagKey
      - tagValue
    DescribeEventTrackerResponse:
      type: object
      properties:
        eventTracker:
          $ref: '#/components/schemas/EventTracker'
    ListEventTrackersResponse:
      type: object
      properties:
        eventTrackers:
          type: array
          items:
            $ref: '#/components/schemas/EventTrackerSummary'
          description: A list of event trackers.
        nextToken:
          type: string
          description: A token for getting the next set of event trackers (if they exist).
    CreateEventTrackerResponse:
      type: object
      properties:
        eventTrackerArn:
          type: string
          description: The ARN of the event tracker.
        trackingId:
          type: string
          description: The ID of the event tracker. Include this ID in requests to the PutEvents API.
    DescribeEventTrackerRequest:
      type: object
      properties:
        eventTrackerArn:
          type: string
          description: The Amazon Resource Name (ARN) of the event tracker to describe.
      required:
      - eventTrackerArn
    DeleteEventTrackerRequest:
      type: object
      properties:
        eventTrackerArn:
          type: string
          description: The Amazon Resource Name (ARN) of the event tracker to delete.
      required:
      - eventTrackerArn
    InvalidInputException:
      type: object
      properties:
        message:
          type: string
    EventTracker:
      type: object
      properties:
        name:
          type: string
          description: The name of the event tracker.
        eventTrackerArn:
          type: string
          description: The ARN of the event tracker.
        accountId:
          type: string
          description: The Amazon Web Services account that owns the event tracker.
        trackingId:
          type: string
          description: The ID of the event tracker. Include this ID in requests to the PutEvents API.
        datasetGroupArn:
          type: string
          description: The Amazon Resource Name (ARN) of the dataset group that receives the event data.
        status:
          type: string
          description: 'The status of the event tracker. An event tracker can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE IN_PROGRESS'
        creationDateTime:
          type: string
          format: date-time
          description: The date and time (in Unix format) that the event tracker was created.
        lastUpdatedDateTime:
          type: string
          format: date-time
          description: The date and time (in Unix time) that the event tracker was last updated.
    EventTrackerSummary:
      type: object
      properties:
        name:
          type: string
          description: The name of the event tracker.
        eventTrackerArn:
          type: string
          description: The Amazon Resource Name (ARN) of the event tracker.
        status:
          type: string
          description: 'The status of the event tracker. An event tracker can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE IN_PROGRESS'
        creationDateTime:
          type: string
          format: date-time
          description: The date and time (in Unix time) that the event tracker was created.
        lastUpdatedDateTime:
          type: string
          format: date-time
          description: The date and time (in Unix time) that the event tracker was last updated.
  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: personalize
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/personalize/service/2018-05-22/personalize-2018-05-22.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)