Amazon Personalize Personalize Operations API

openapi: 3.2.0
info:
  title: Amazon Personalize Operations API
  version: '2018-05-22'
  description: Generated from AWS's published Smithy model for Amazon Personalize. 10 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: Operations
paths:
  /#DescribeAlgorithm:
    post:
      operationId: DescribeAlgorithm
      summary: Describe Algorithm
      description: Describes the given algorithm.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeAlgorithmResponse'
        '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.DescribeAlgorithm
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeAlgorithmRequest'
      tags:
      - Operations
  /#DescribeFeatureTransformation:
    post:
      operationId: DescribeFeatureTransformation
      summary: Describe Feature Transformation
      description: Describes the given feature transformation.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeFeatureTransformationResponse'
        '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.DescribeFeatureTransformation
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeFeatureTransformationRequest'
      tags:
      - Operations
  /#DescribeRecipe:
    post:
      operationId: DescribeRecipe
      summary: Describe Recipe
      description: 'Describes a recipe. A recipe contains three items: An algorithm that trains a model. Hyperparameters that govern the training. Feature transformation information for modifying the input data before training. Amazon Personalize provides a set of predefined recipes. You specify a recipe when you create a solution with the CreateSolution API. CreateSolution trains a model by using the algorithm in the specified recipe and a training dataset. The solution, when deployed as a campaign, can provide recommendations using the GetRecommendations API.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeRecipeResponse'
        '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.DescribeRecipe
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeRecipeRequest'
      tags:
      - Operations
  /#ListRecipes:
    post:
      operationId: ListRecipes
      summary: List Recipes
      description: Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListRecipesResponse'
        '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.ListRecipes
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListRecipesRequest'
      tags:
      - Operations
  /#GetSolutionMetrics:
    post:
      operationId: GetSolutionMetrics
      summary: Get Solution Metrics
      description: Gets the metrics for the specified solution version.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetSolutionMetricsResponse'
        '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.GetSolutionMetrics
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetSolutionMetricsRequest'
      tags:
      - Operations
  /#ListMetricAttributionMetrics:
    post:
      operationId: ListMetricAttributionMetrics
      summary: List Metric Attribution Metrics
      description: Lists the metrics for the metric attribution.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListMetricAttributionMetricsResponse'
        '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.ListMetricAttributionMetrics
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListMetricAttributionMetricsRequest'
      tags:
      - Operations
  /#ListTagsForResource:
    post:
      operationId: ListTagsForResource
      summary: List Tags For Resource
      description: Get a list of tags attached to a resource.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListTagsForResourceResponse'
        '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.ListTagsForResource
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListTagsForResourceRequest'
      tags:
      - Operations
  /#StopSolutionVersionCreation:
    post:
      operationId: StopSolutionVersionCreation
      summary: Stop Solution Version Creation
      description: 'Stops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS. Depending on the current state of the solution version, the solution version state changes as follows: CREATE_PENDING > CREATE_STOPPED or CREATE_IN_PROGRESS > CREATE_STOPPING > CREATE_STOPPED You are billed for all of the training completed up until you stop the solution version creation. You cannot resume creating a solution version once it has been stopped.'
      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.StopSolutionVersionCreation
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StopSolutionVersionCreationRequest'
      tags:
      - Operations
  /#TagResource:
    post:
      operationId: TagResource
      summary: Tag Resource
      description: Add a list of tags to a resource.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/TagResourceResponse'
        '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'
        '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.TagResource
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/TagResourceRequest'
      tags:
      - Operations
  /#UntagResource:
    post:
      operationId: UntagResource
      summary: Untag Resource
      description: Removes the specified tags that are attached to a resource. For more information, see Removing tags from Amazon Personalize resources.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UntagResourceResponse'
        '400':
          description: InvalidInputException; TooManyTagKeysException
          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.UntagResource
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UntagResourceRequest'
      tags:
      - Operations
components:
  schemas:
    DescribeFeatureTransformationRequest:
      type: object
      properties:
        featureTransformationArn:
          type: string
          description: The Amazon Resource Name (ARN) of the feature transformation to describe.
      required:
      - featureTransformationArn
    DefaultHyperParameterRanges:
      type: object
      properties:
        integerHyperParameterRanges:
          type: array
          items:
            $ref: '#/components/schemas/DefaultIntegerHyperParameterRange'
          description: The integer-valued hyperparameters and their default ranges.
        continuousHyperParameterRanges:
          type: array
          items:
            $ref: '#/components/schemas/DefaultContinuousHyperParameterRange'
          description: The continuous hyperparameters and their default ranges.
        categoricalHyperParameterRanges:
          type: array
          items:
            $ref: '#/components/schemas/DefaultCategoricalHyperParameterRange'
          description: The categorical hyperparameters and their default ranges.
    GetSolutionMetricsResponse:
      type: object
      properties:
        solutionVersionArn:
          type: string
          description: The same solution version ARN as specified in the request.
        metrics:
          type: object
          additionalProperties:
            type: number
          description: The metrics for the solution version. For more information, see Evaluating a solution version with metrics .
    UntagResourceRequest:
      type: object
      properties:
        resourceArn:
          type: string
          description: The resource's Amazon Resource Name (ARN).
        tagKeys:
          type: array
          items:
            type: string
          description: The keys of the tags to be removed.
      required:
      - resourceArn
      - tagKeys
    RecipeSummary:
      type: object
      properties:
        name:
          type: string
          description: The name of the recipe.
        recipeArn:
          type: string
          description: The Amazon Resource Name (ARN) of the recipe.
        status:
          type: string
          description: The status of the recipe.
        creationDateTime:
          type: string
          format: date-time
          description: The date and time (in Unix time) that the recipe was created.
        lastUpdatedDateTime:
          type: string
          format: date-time
          description: The date and time (in Unix time) that the recipe was last updated.
        domain:
          type: string
          enum:
          - ECOMMERCE
          - VIDEO_ON_DEMAND
          description: The domain of the recipe (if the recipe is a Domain dataset group use case).
    Recipe:
      type: object
      properties:
        name:
          type: string
          description: The name of the recipe.
        recipeArn:
          type: string
          description: The Amazon Resource Name (ARN) of the recipe.
        algorithmArn:
          type: string
          description: The Amazon Resource Name (ARN) of the algorithm that Amazon Personalize uses to train the model.
        featureTransformationArn:
          type: string
          description: The ARN of the FeatureTransformation object.
        status:
          type: string
          description: The status of the recipe.
        description:
          type: string
          description: The description of the recipe.
        creationDateTime:
          type: string
          format: date-time
          description: The date and time (in Unix format) that the recipe was created.
        recipeType:
          type: string
          description: 'One of the following values: PERSONALIZED_RANKING RELATED_ITEMS USER_PERSONALIZATION'
        lastUpdatedDateTime:
          type: string
          format: date-time
          description: The date and time (in Unix format) that the recipe was last updated.
    ListMetricAttributionMetricsResponse:
      type: object
      properties:
        metrics:
          type: array
          items:
            $ref: '#/components/schemas/MetricAttribute'
          description: The metrics for the specified metric attribution.
        nextToken:
          type: string
          description: Specify the pagination token from a previous ListMetricAttributionMetricsResponse request to retrieve the next page of results.
    ListRecipesResponse:
      type: object
      properties:
        recipes:
          type: array
          items:
            $ref: '#/components/schemas/RecipeSummary'
          description: The list of available recipes.
        nextToken:
          type: string
          description: A token for getting the next set of recipes.
    TagResourceResponse:
      type: object
      properties: {}
    MetricAttribute:
      type: object
      properties:
        eventType:
          type: string
          description: The metric's event type.
        metricName:
          type: string
          description: The metric's name. The name helps you identify the metric in Amazon CloudWatch or Amazon S3.
        expression:
          type: string
          description: The attribute's expression. Available functions are SUM() or SAMPLECOUNT(). For SUM() functions, provide the dataset type (either Interactions or Items) and column to sum as a parameter. For example SUM(Items.PRICE).
      required:
      - eventType
      - metricName
      - expression
    DefaultCategoricalHyperParameterRange:
      type: object
      properties:
        name:
          type: string
          description: The name of the hyperparameter.
        values:
          type: array
          items:
            type: string
          description: A list of the categories for the hyperparameter.
        isTunable:
          type: boolean
          description: Whether the hyperparameter is tunable.
    GetSolutionMetricsRequest:
      type: object
      properties:
        solutionVersionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the solution version for which to get metrics.
      required:
      - solutionVersionArn
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    FeatureTransformation:
      type: object
      properties:
        name:
          type: string
          description: The name of the feature transformation.
        featureTransformationArn:
          type: string
          description: The Amazon Resource Name (ARN) of the FeatureTransformation object.
        defaultParameters:
          type: object
          additionalProperties:
            type: string
          description: Provides the default parameters for feature transformation.
        creationDateTime:
          type: string
          format: date-time
          description: The creation date and time (in Unix time) of the feature transformation.
        lastUpdatedDateTime:
          type: string
          format: date-time
          description: The last update date and time (in Unix time) of the feature transformation.
        status:
          type: string
          description: 'The status of the feature transformation. A feature transformation can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED'
    ListTagsForResourceResponse:
      type: object
      properties:
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The resource's tags.
    DescribeAlgorithmRequest:
      type: object
      properties:
        algorithmArn:
          type: string
          description: The Amazon Resource Name (ARN) of the algorithm to describe.
      required:
      - algorithmArn
    LimitExceededException:
      type: object
      properties:
        message:
          type: string
    DefaultIntegerHyperParameterRange:
      type: object
      properties:
        name:
          type: string
          description: The name of the hyperparameter.
        minValue:
          type: integer
          description: The minimum allowable value for the hyperparameter.
        maxValue:
          type: integer
          description: The maximum allowable value for the hyperparameter.
        isTunable:
          type: boolean
          description: Indicates whether the hyperparameter is tunable.
    ListTagsForResourceRequest:
      type: object
      properties:
        resourceArn:
          type: string
          description: The resource's Amazon Resource Name (ARN).
      required:
      - resourceArn
    DescribeFeatureTransformationResponse:
      type: object
      properties:
        featureTransformation:
          $ref: '#/components/schemas/FeatureTransformation'
    AlgorithmImage:
      type: object
      properties:
        name:
          type: string
          description: The name of the algorithm image.
        dockerURI:
          type: string
          description: The URI of the Docker container for the algorithm image.
      required:
      - dockerURI
    DescribeRecipeRequest:
      type: object
      properties:
        recipeArn:
          type: string
          description: The Amazon Resource Name (ARN) of the recipe to describe.
      required:
      - recipeArn
    DescribeRecipeResponse:
      type: object
      properties:
        recipe:
          $ref: '#/components/schemas/Recipe'
    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
    InvalidInputException:
      type: object
      properties:
        message:
          type: string
    UntagResourceResponse:
      type: object
      properties: {}
    StopSolutionVersionCreationRequest:
      type: object
      properties:
        solutionVersionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the solution version you want to stop creating.
      required:
      - solutionVersionArn
    Algorithm:
      type: object
      properties:
        name:
          type: string
          description: The name of the algorithm.
        algorithmArn:
          type: string
          description: The Amazon Resource Name (ARN) of the algorithm.
        algorithmImage:
          $ref: '#/components/schemas/AlgorithmImage'
        defaultHyperParameters:
          type: object
          additionalProperties:
            type: string
          description: Specifies the default hyperparameters.
        defaultHyperParameterRanges:
          $ref: '#/components/schemas/DefaultHyperParameterRanges'
        defaultResourceConfig:
          type: object
          additionalProperties:
            type: string
          description: Specifies the default maximum number of training jobs and parallel training jobs.
        trainingInputMode:
          type: string
          description: The training input mode.
        roleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the role.
        creationDateTime:
          type: string
          format: date-time
          description: The date and time (in Unix time) that the algorithm was created.
        lastUpdatedDateTime:
          type: string
          format: date-time
          description: The date and time (in Unix time) that the algorithm was last updated.
    ListRecipesRequest:
      type: object
      properties:
        recipeProvider:
          type: string
          enum:
          - SERVICE
          description: The default is SERVICE.
        nextToken:
          type: string
          description: A token returned from the previous call to ListRecipes for getting the next set of recipes (if they exist).
        maxResults:
          type: integer
          description: The maximum number of recipes to return.
        domain:
          type: string
          enum:
          - ECOMMERCE
          - VIDEO_ON_DEMAND
          description: Filters returned recipes by domain for a Domain dataset group. Only recipes (Domain dataset group use cases) for this domain are included in the response. If you don't specify a domain, all recipes are returned.
    ResourceInUseException:
      type: object
      properties:
        message:
          type: string
    DefaultContinuousHyperParameterRange:
      type: object
      properties:
        name:
          type: string
          description: The name of the hyperparameter.
        minValue:
          type: number
          description: The minimum allowable value for the hyperparameter.
        maxValue:
          type: number
          description: The maximum allowable value for the hyperparameter.
        isTunable:
          type: boolean
          description: Whether the hyperparameter is tunable.
    ListMetricAttributionMetricsRequest:
      type: object
      properties:
        metricAttributionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the metric attribution to retrieve attributes for.
        nextToken:
          type: string
          description: Specify the pagination token from a previous request to retrieve the next page of results.
        maxResults:
          type: integer
          description: The maximum number of metrics to return in one page of results.
    TagResourceRequest:
      type: object
      properties:
        resourceArn:
          type: string
          description: The resource's Amazon Resource Name (ARN).
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Tags to apply to the resource. For more information see Tagging Amazon Personalize resources.
      required:
      - resourceArn
      - tags
    DescribeAlgorithmResponse:
      type: object
      properties:
        algorithm:
          $ref: '#/components/schemas/Algorithm'
  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)