Amazon Personalize Datasets API

openapi: 3.1.0
info:
  title: Amazon Personalize Datasets API
  version: '2018-05-22'
  description: Generated from AWS's published Smithy model for Amazon Personalize. 6 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: []
paths:
  /#CreateDataset:
    post:
      operationId: CreateDataset
      summary: Create Dataset
      description: 'Creates an empty dataset and adds it to the specified dataset group. Use CreateDatasetImportJob to import
        your training data to a dataset. There are 5 types of datasets: Item interactions Items Users Action interactions
        Actions Each dataset type has an associated schema with required field types. Only the Item interactions dataset is
        required in order to train a model (also referred to as creating a solution). A dataset 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 dataset, call DescribeDataset. Related APIs CreateDatasetGroup ListDatasets DescribeDataset DeleteDataset'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateDatasetResponse'
        '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.CreateDataset
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateDatasetRequest'
      tags:
      - Datasets
  /#DeleteDataset:
    post:
      operationId: DeleteDataset
      summary: Delete Dataset
      description: Deletes a dataset. You can't delete a dataset if an associated DatasetImportJob or SolutionVersion is in
        the CREATE PENDING or IN PROGRESS state. For more information about deleting datasets, see Deleting a dataset.
      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.DeleteDataset
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteDatasetRequest'
      tags:
      - Datasets
  /#DescribeDataset:
    post:
      operationId: DescribeDataset
      summary: Describe Dataset
      description: Describes the given dataset. For more information on datasets, see CreateDataset.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeDatasetResponse'
        '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.DescribeDataset
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeDatasetRequest'
      tags:
      - Datasets
  /#ListDatasets:
    post:
      operationId: ListDatasets
      summary: List Datasets
      description: Returns the list of datasets contained in the given dataset group. The response provides the properties
        for each dataset, including the Amazon Resource Name (ARN). For more information on datasets, see CreateDataset.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListDatasetsResponse'
        '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.ListDatasets
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListDatasetsRequest'
      tags:
      - Datasets
  /#UpdateDataset:
    post:
      operationId: UpdateDataset
      summary: Update Dataset
      description: Update a dataset to replace its schema with a new or existing one. For more information, see Replacing
        a dataset's schema.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateDatasetResponse'
        '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.UpdateDataset
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateDatasetRequest'
      tags:
      - Datasets
  /#CreateDatasetGroup:
    post:
      operationId: CreateDatasetGroup
      summary: Create Dataset Group
      description: 'Creates an empty dataset group. A dataset group is a container for Amazon Personalize resources. A dataset
        group can contain at most three datasets, one for each type of dataset: Item interactions Items Users Actions Action
        interactions A dataset group can be a Domain dataset group, where you specify a domain and use pre-configured resources
        like recommenders, or a Custom dataset group, where you use custom resources, such as a solution with a solution version,
        that you deploy with a campaign. If you start with a Domain dataset group, you can still add custom resources such
        as solutions and solution versions trained with recipes for custom use cases and deployed with campaigns. A dataset
        group can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE
        PENDING To get the status of the dataset group, call DescribeDatasetGroup. If the status shows as CREATE FAILED, the
        response includes a failureReason key, which describes why the creation failed. You must wait until the status of
        the dataset group is ACTIVE before adding a dataset to the group. You can specify an Key Management Service (KMS)
        key to encrypt the datasets in the group. '
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateDatasetGroupResponse'
        '400':
          description: InvalidInputException; TooManyTagsException
          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.CreateDatasetGroup
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateDatasetGroupRequest'
      tags:
      - Datasets
components:
  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
  schemas:
    CreateDatasetGroupRequest:
      type: object
      properties:
        name:
          type: string
          description: The name for the new dataset group.
        roleArn:
          type: string
          description: The ARN of the Identity and Access Management (IAM) role that has permissions to access the Key Management
            Service (KMS) key. Supplying an IAM role is only valid when also specifying a KMS key.
        kmsKeyArn:
          type: string
          description: The Amazon Resource Name (ARN) of a Key Management Service (KMS) key used to encrypt the datasets.
        domain:
          type: string
          enum:
          - ECOMMERCE
          - VIDEO_ON_DEMAND
          description: The domain of the dataset group. Specify a domain to create a Domain dataset group. The domain you
            specify determines the default schemas for datasets and the use cases available for recommenders. If you don't
            specify a domain, you create a Custom dataset group with solution versions that you deploy with a campaign.
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of tags to apply to the dataset group.
      required:
      - name
    CreateDatasetGroupResponse:
      type: object
      properties:
        datasetGroupArn:
          type: string
          description: The Amazon Resource Name (ARN) of the new dataset group.
        domain:
          type: string
          enum:
          - ECOMMERCE
          - VIDEO_ON_DEMAND
          description: The domain for the new Domain dataset group.
    CreateDatasetRequest:
      type: object
      properties:
        name:
          type: string
          description: The name for the dataset.
        schemaArn:
          type: string
          description: The ARN of the schema to associate with the dataset. The schema defines the dataset fields.
        datasetGroupArn:
          type: string
          description: The Amazon Resource Name (ARN) of the dataset group to add the dataset to.
        datasetType:
          type: string
          description: 'The type of dataset. One of the following (case insensitive) values: Interactions Items Users Actions
            Action_Interactions'
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of tags to apply to the dataset.
      required:
      - name
      - schemaArn
      - datasetGroupArn
      - datasetType
    CreateDatasetResponse:
      type: object
      properties:
        datasetArn:
          type: string
          description: The ARN of the dataset.
    Dataset:
      type: object
      properties:
        name:
          type: string
          description: The name of the dataset.
        datasetArn:
          type: string
          description: The Amazon Resource Name (ARN) of the dataset that you want metadata for.
        datasetGroupArn:
          type: string
          description: The Amazon Resource Name (ARN) of the dataset group.
        datasetType:
          type: string
          description: 'One of the following values: Interactions Items Users Actions Action_Interactions'
        schemaArn:
          type: string
          description: The ARN of the associated schema.
        status:
          type: string
          description: 'The status of the dataset. A dataset 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 creation date and time (in Unix time) of the dataset.
        lastUpdatedDateTime:
          type: string
          format: date-time
          description: A time stamp that shows when the dataset was updated.
        latestDatasetUpdate:
          $ref: '#/components/schemas/DatasetUpdateSummary'
        trackingId:
          type: string
          description: The ID of the event tracker for an Action interactions dataset. You specify the tracker's ID in the
            PutActionInteractions API operation. Amazon Personalize uses it to direct new data to the Action interactions
            dataset in your dataset group.
    DatasetSummary:
      type: object
      properties:
        name:
          type: string
          description: The name of the dataset.
        datasetArn:
          type: string
          description: The Amazon Resource Name (ARN) of the dataset.
        datasetType:
          type: string
          description: 'The dataset type. One of the following values: Interactions Items Users Event-Interactions'
        status:
          type: string
          description: 'The status of the dataset. A dataset 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 dataset was created.
        lastUpdatedDateTime:
          type: string
          format: date-time
          description: The date and time (in Unix time) that the dataset was last updated.
    DatasetUpdateSummary:
      type: object
      properties:
        schemaArn:
          type: string
          description: The Amazon Resource Name (ARN) of the schema that replaced the previous schema of the dataset.
        status:
          type: string
          description: The status of the dataset update.
        failureReason:
          type: string
          description: If updating a dataset fails, provides the reason why.
        creationDateTime:
          type: string
          format: date-time
          description: The creation date and time (in Unix time) of the dataset update.
        lastUpdatedDateTime:
          type: string
          format: date-time
          description: The last update date and time (in Unix time) of the dataset.
    DeleteDatasetRequest:
      type: object
      properties:
        datasetArn:
          type: string
          description: The Amazon Resource Name (ARN) of the dataset to delete.
      required:
      - datasetArn
    DescribeDatasetRequest:
      type: object
      properties:
        datasetArn:
          type: string
          description: The Amazon Resource Name (ARN) of the dataset to describe.
      required:
      - datasetArn
    DescribeDatasetResponse:
      type: object
      properties:
        dataset:
          $ref: '#/components/schemas/Dataset'
    InvalidInputException:
      type: object
      properties:
        message:
          type: string
    LimitExceededException:
      type: object
      properties:
        message:
          type: string
    ListDatasetsRequest:
      type: object
      properties:
        datasetGroupArn:
          type: string
          description: The Amazon Resource Name (ARN) of the dataset group that contains the datasets to list.
        nextToken:
          type: string
          description: A token returned from the previous call to ListDatasets for getting the next set of dataset import
            jobs (if they exist).
        maxResults:
          type: integer
          description: The maximum number of datasets to return.
    ListDatasetsResponse:
      type: object
      properties:
        datasets:
          type: array
          items:
            $ref: '#/components/schemas/DatasetSummary'
          description: An array of Dataset objects. Each object provides metadata information.
        nextToken:
          type: string
          description: A token for getting the next set of datasets (if they exist).
    ResourceAlreadyExistsException:
      type: object
      properties:
        message:
          type: string
    ResourceInUseException:
      type: object
      properties:
        message:
          type: string
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    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
    UpdateDatasetRequest:
      type: object
      properties:
        datasetArn:
          type: string
          description: The Amazon Resource Name (ARN) of the dataset that you want to update.
        schemaArn:
          type: string
          description: The Amazon Resource Name (ARN) of the new schema you want use.
      required:
      - datasetArn
      - schemaArn
    UpdateDatasetResponse:
      type: object
      properties:
        datasetArn:
          type: string
          description: The Amazon Resource Name (ARN) of the dataset you updated.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/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)