Amazon Personalize Datasets API

Operations for managing datasets and dataset groups

OpenAPI Specification

amazon-personalize-datasets-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Personalize Datasets API
  description: The Amazon Personalize API enables you to create, manage, and deploy personalization models. You can import interaction data, train recommendation models, create campaigns, and get real-time recommendations through this interface.
  version: '2018-05-22'
  contact:
    name: AWS Support
    url: https://aws.amazon.com/premiumsupport/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  x-logo:
    url: https://a0.awsstatic.com/libra-css/images/logos/aws_logo_smile_1200x630.png
servers:
- url: https://personalize.{region}.amazonaws.com
  description: Amazon Personalize regional endpoint
  variables:
    region:
      default: us-east-1
      description: AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-2
      - eu-west-1
      - eu-central-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-southeast-1
      - ap-southeast-2
security:
- sigv4: []
tags:
- name: Datasets
  description: Operations for managing datasets and dataset groups
paths:
  /:
    post:
      operationId: CreateDatasetGroup
      summary: Amazon Personalize Create a Dataset Group
      description: Creates an empty dataset group for organizing datasets used for training.
      tags:
      - Datasets
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateDatasetGroupRequest'
      responses:
        '200':
          description: Dataset group created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  datasetGroupArn:
                    type: string
              examples:
                CreateDatasetGroup200Example:
                  summary: Default CreateDatasetGroup 200 response
                  x-microcks-default: true
                  value:
                    datasetGroupArn: arn:aws:service:us-east-1:123456789012:resource/example
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    CreateDatasetGroupRequest:
      type: object
      required:
      - name
      properties:
        name:
          type: string
          description: The name of the dataset group
        domain:
          type: string
          enum:
          - ECOMMERCE
          - VIDEO_ON_DEMAND
          description: The domain of the dataset group
  securitySchemes:
    sigv4:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4