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-schema-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 Schema 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: Schema
paths:
  /#CreateSchema:
    post:
      operationId: CreateSchema
      summary: Create Schema
      description: Creates an Amazon Personalize schema from the specified schema string. The schema you create must be in Avro JSON format. Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset type and has a set of required field and keywords. If you are creating a schema for a dataset in a Domain dataset group, you provide the domain of the Domain dataset group. You specify a schema when you call CreateDataset. Related APIs ListSchemas DescribeSchema DeleteSchema
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateSchemaResponse'
        '400':
          description: InvalidInputException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
        '409':
          description: LimitExceededException
          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'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonPersonalize.CreateSchema
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateSchemaRequest'
      tags:
      - Schema
  /#DeleteSchema:
    post:
      operationId: DeleteSchema
      summary: Delete Schema
      description: Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see CreateSchema.
      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.DeleteSchema
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteSchemaRequest'
      tags:
      - Schema
  /#DescribeSchema:
    post:
      operationId: DescribeSchema
      summary: Describe Schema
      description: Describes a schema. For more information on schemas, see CreateSchema.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeSchemaResponse'
        '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.DescribeSchema
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeSchemaRequest'
      tags:
      - Schema
  /#ListSchemas:
    post:
      operationId: ListSchemas
      summary: List Schemas
      description: Returns the list of schemas associated with the account. The response provides the properties for each schema, including the Amazon Resource Name (ARN). For more information on schemas, see CreateSchema.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListSchemasResponse'
        '400':
          description: InvalidNextTokenException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidNextTokenException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonPersonalize.ListSchemas
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListSchemasRequest'
      tags:
      - Schema
components:
  schemas:
    LimitExceededException:
      type: object
      properties:
        message:
          type: string
    DatasetSchemaSummary:
      type: object
      properties:
        name:
          type: string
          description: The name of the schema.
        schemaArn:
          type: string
          description: The Amazon Resource Name (ARN) of the schema.
        creationDateTime:
          type: string
          format: date-time
          description: The date and time (in Unix time) that the schema was created.
        lastUpdatedDateTime:
          type: string
          format: date-time
          description: The date and time (in Unix time) that the schema was last updated.
        domain:
          type: string
          enum:
          - ECOMMERCE
          - VIDEO_ON_DEMAND
          description: The domain of a schema that you created for a dataset in a Domain dataset group.
    ResourceAlreadyExistsException:
      type: object
      properties:
        message:
          type: string
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    ResourceInUseException:
      type: object
      properties:
        message:
          type: string
    DeleteSchemaRequest:
      type: object
      properties:
        schemaArn:
          type: string
          description: The Amazon Resource Name (ARN) of the schema to delete.
      required:
      - schemaArn
    CreateSchemaResponse:
      type: object
      properties:
        schemaArn:
          type: string
          description: The Amazon Resource Name (ARN) of the created schema.
    CreateSchemaRequest:
      type: object
      properties:
        name:
          type: string
          description: The name for the schema.
        schema:
          type: string
          description: A schema in Avro JSON format.
        domain:
          type: string
          enum:
          - ECOMMERCE
          - VIDEO_ON_DEMAND
          description: The domain for the schema. If you are creating a schema for a dataset in a Domain dataset group, specify the domain you chose when you created the Domain dataset group.
      required:
      - name
      - schema
    DescribeSchemaRequest:
      type: object
      properties:
        schemaArn:
          type: string
          description: The Amazon Resource Name (ARN) of the schema to retrieve.
      required:
      - schemaArn
    DatasetSchema:
      type: object
      properties:
        name:
          type: string
          description: The name of the schema.
        schemaArn:
          type: string
          description: The Amazon Resource Name (ARN) of the schema.
        schema:
          type: string
          description: The schema.
        creationDateTime:
          type: string
          format: date-time
          description: The date and time (in Unix time) that the schema was created.
        lastUpdatedDateTime:
          type: string
          format: date-time
          description: The date and time (in Unix time) that the schema was last updated.
        domain:
          type: string
          enum:
          - ECOMMERCE
          - VIDEO_ON_DEMAND
          description: The domain of a schema that you created for a dataset in a Domain dataset group.
    InvalidNextTokenException:
      type: object
      properties:
        message:
          type: string
    ListSchemasResponse:
      type: object
      properties:
        schemas:
          type: array
          items:
            $ref: '#/components/schemas/DatasetSchemaSummary'
          description: A list of schemas.
        nextToken:
          type: string
          description: A token used to get the next set of schemas (if they exist).
    DescribeSchemaResponse:
      type: object
      properties:
        schema:
          $ref: '#/components/schemas/DatasetSchema'
    InvalidInputException:
      type: object
      properties:
        message:
          type: string
    ListSchemasRequest:
      type: object
      properties:
        nextToken:
          type: string
          description: A token returned from the previous call to ListSchemas for getting the next set of schemas (if they exist).
        maxResults:
          type: integer
          description: The maximum number of schemas to return.
  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)