Amazon Connect Connect Recommenders API

The Connect Recommenders API from Amazon Connect — 2 operation(s) for connect recommenders.

GitHub OpenAPI

Operations 5

POST /domains/{DomainName}/recommenders/{RecommenderName} Create Recommender #
DELETE /domains/{DomainName}/recommenders/{RecommenderName} Delete Recommender #
GET /domains/{DomainName}/recommenders/{RecommenderName} Get Recommender #
PATCH /domains/{DomainName}/recommenders/{RecommenderName} Update Recommender #
GET /domains/{DomainName}/recommenders List Recommenders #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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-connect:amazon-connect-recommenders-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.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-connect-recommenders-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Connect Service Recommenders API
  version: '2017-08-08'
  description: Generated from AWS's published Smithy model for Amazon Connect Service. 5 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://profile.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /domains/{DomainName}/recommenders/{RecommenderName}:
    post:
      operationId: CreateRecommender
      summary: Create Recommender
      description: Creates a recommender
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateRecommenderResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateRecommenderRequest'
      tags:
      - Recommenders
    delete:
      operationId: DeleteRecommender
      summary: Delete Recommender
      description: Deletes a recommender.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteRecommenderResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteRecommenderRequest'
      tags:
      - Recommenders
    get:
      operationId: GetRecommender
      summary: Get Recommender
      description: Retrieves a recommender.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRecommenderResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetRecommenderRequest'
      tags:
      - Recommenders
    patch:
      operationId: UpdateRecommender
      summary: Update Recommender
      description: Updates the properties of an existing recommender, allowing you to modify its configuration and description.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateRecommenderResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRecommenderRequest'
      tags:
      - Recommenders
  /domains/{DomainName}/recommenders:
    get:
      operationId: ListRecommenders
      summary: List Recommenders
      description: Returns a list of recommenders in the specified domain.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListRecommendersResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListRecommendersRequest'
      tags:
      - Recommenders
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: profile
  schemas:
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
    BadRequestException:
      type: object
      properties:
        Message:
          type: string
    CreateRecommenderRequest:
      type: object
      properties:
        DomainName:
          type: string
          description: The unique name of the domain.
        RecommenderName:
          type: string
          description: The name of the recommender.
        RecommenderRecipeName:
          type: string
          enum:
          - recommended-for-you
          - similar-items
          - frequently-paired-items
          - popular-items
          - trending-now
          - personalized-ranking
          description: The name of the recommeder recipe.
        RecommenderConfig:
          $ref: '#/components/schemas/ProfileRecommenderConfig'
        Description:
          type: string
          description: The description of the domain object type.
        RecommenderSchemaName:
          type: string
          description: The name of the recommender schema to use for this recommender. If not specified, the default schema
            is used.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: The tags used to organize, track, or control access for this resource.
      required:
      - DomainName
      - RecommenderName
      - RecommenderRecipeName
    CreateRecommenderResponse:
      type: object
      properties:
        RecommenderArn:
          type: string
          description: The ARN of the recommender
        Tags:
          type: object
          additionalProperties:
            type: string
          description: The tags used to organize, track, or control access for this resource.
      required:
      - RecommenderArn
    DeleteRecommenderRequest:
      type: object
      properties:
        DomainName:
          type: string
          description: The unique name of the domain.
        RecommenderName:
          type: string
          description: The recommender name.
      required:
      - DomainName
      - RecommenderName
    DeleteRecommenderResponse:
      type: object
      properties: {}
    DiversityColumn:
      type: object
      properties:
        Name:
          type: string
          description: The name of the item catalog column on which to apply the diversity cap. The column must be defined
            in the recommender schema.
        CapType:
          type: string
          enum:
          - PERCENTAGE
          - VALUE
          description: The type of diversity cap to apply. Valid values are PERCENTAGE (interpret Target as a percentage of
            returned items) and VALUE (interpret Target as an absolute count).
        Target:
          type: string
          description: The diversity cap target. Either an integer literal (for example, "25") or a placeholder expression
            of the form $name whose value is supplied at inference time through GetProfileRecommendations.
      required:
      - Name
      - CapType
      - Target
    DiversityConfig:
      type: object
      properties:
        DiversityColumns:
          type: array
          items:
            $ref: '#/components/schemas/DiversityColumn'
          description: A list of up to two diversity columns. Each column defines a cap on the number or percentage of recommended
            items that share the same value for that column.
    EventParameters:
      type: object
      properties:
        EventType:
          type: string
          description: The type of event being tracked (e.g., 'click', 'purchase', 'view').
        EventValueThreshold:
          type: number
          description: The minimum value threshold that an event must meet to be considered valid.
        EventWeight:
          type: number
          description: The weight of the event type. A higher weight means higher importance of the event type for the created
            solution.
      required:
      - EventType
    EventsConfig:
      type: object
      properties:
        EventParametersList:
          type: array
          items:
            $ref: '#/components/schemas/EventParameters'
          description: A list of event parameters configurations that specify how different event types should be handled.
      required:
      - EventParametersList
    GetRecommenderRequest:
      type: object
      properties:
        DomainName:
          type: string
          description: The unique name of the domain.
        RecommenderName:
          type: string
          description: The name of the recommender.
        TrainingMetricsCount:
          type: integer
          description: The number of training metrics to retrieve for the recommender.
      required:
      - DomainName
      - RecommenderName
    GetRecommenderResponse:
      type: object
      properties:
        RecommenderName:
          type: string
          description: The name of the recommender.
        RecommenderRecipeName:
          type: string
          enum:
          - recommended-for-you
          - similar-items
          - frequently-paired-items
          - popular-items
          - trending-now
          - personalized-ranking
          description: The name of the recipe used by the recommender to generate recommendations.
        RecommenderSchemaName:
          type: string
          description: The name of the recommender schema associated with this recommender.
        RecommenderConfig:
          $ref: '#/components/schemas/ProfileRecommenderConfig'
        Description:
          type: string
          description: A detailed description of the recommender providing information about its purpose and functionality.
        Status:
          type: string
          enum:
          - PENDING
          - IN_PROGRESS
          - ACTIVE
          - FAILED
          - STOPPING
          - INACTIVE
          - STARTING
          - DELETING
          description: The current status of the recommender, indicating whether it is active, creating, updating, or in another
            state.
        LastUpdatedAt:
          type: string
          format: date-time
          description: The timestamp of when the recommender was edited.
        CreatedAt:
          type: string
          format: date-time
          description: The timestamp of when the recommender was created.
        FailureReason:
          type: string
          description: If the recommender fails, provides the reason for the failure.
        LatestRecommenderUpdate:
          $ref: '#/components/schemas/RecommenderUpdate'
        ActiveRecommenderVersionName:
          type: string
          description: The name of the recommender version currently serving recommendations. Omitted when no active recommender
            version is set.
        TrainingMetrics:
          type: array
          items:
            $ref: '#/components/schemas/TrainingMetrics'
          description: A set of metrics that provide information about the recommender's training performance and accuracy.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: The tags used to organize, track, or control access for this resource.
      required:
      - RecommenderName
      - RecommenderRecipeName
    InferenceConfig:
      type: object
      properties:
        MinProvisionedTPS:
          type: integer
          description: The minimum provisioned transactions per second (TPS) that the recommender supports. The default value
            is 1. A high MinProvisionedTPS will increase your cost.
    ListRecommendersRequest:
      type: object
      properties:
        DomainName:
          type: string
          description: The unique name of the domain.
        MaxResults:
          type: integer
          description: The maximum number of recommenders to return in the response. The default value is 100.
        NextToken:
          type: string
          description: A token received from a previous ListRecommenders call to retrieve the next page of results.
      required:
      - DomainName
    ListRecommendersResponse:
      type: object
      properties:
        NextToken:
          type: string
          description: A token to retrieve the next page of results. Null if there are no more results to retrieve.
        Recommenders:
          type: array
          items:
            $ref: '#/components/schemas/RecommenderSummary'
          description: A list of recommenders and their properties in the specified domain.
    ProfileInternalServerException:
      type: object
      properties:
        Message:
          type: string
    ProfileRecommenderConfig:
      type: object
      properties:
        EventsConfig:
          $ref: '#/components/schemas/EventsConfig'
        TrainingFrequency:
          type: integer
          description: How often the recommender should retrain its model with new data. If set to 0, automatic retraining
            will not be enabled.
        InferenceConfig:
          $ref: '#/components/schemas/InferenceConfig'
        IncludedColumns:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: 'A map of dataset type to a list of column names to train on. The _webAnalytics and _catalogItem keys
            are supported. The column names must be a subset of the columns defined in the recommender schema. If not specified,
            all columns in the schema are used for training. The following columns are always included in training and do
            not need to be specified: Item.Id, EventTimestamp, and EventType for _webAnalytics; Id for _catalogItem. Mutually
            exclusive with ExcludedColumns — both cannot be specified in the same request.'
        ExcludedColumns:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: 'A map of dataset type to a list of column names to exclude from training. The _webAnalytics and _catalogItem
            keys are supported. The column names must be valid columns defined in the recommender schema. All columns in the
            schema except the listed columns will be used for training. The following columns are mandatory and cannot be
            excluded: Item.Id, EventTimestamp, and EventType for _webAnalytics; Id for _catalogItem. Mutually exclusive with
            IncludedColumns — both cannot be specified in the same request.'
        DiversityConfig:
          $ref: '#/components/schemas/DiversityConfig'
    ProfileResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
    RecommenderSummary:
      type: object
      properties:
        RecommenderName:
          type: string
          description: The name of the recommender.
        RecipeName:
          type: string
          enum:
          - recommended-for-you
          - similar-items
          - frequently-paired-items
          - popular-items
          - trending-now
          - personalized-ranking
          description: The name of the recipe used by this recommender.
        RecommenderSchemaName:
          type: string
          description: The name of the recommender schema associated with this recommender.
        RecommenderConfig:
          $ref: '#/components/schemas/ProfileRecommenderConfig'
        CreatedAt:
          type: string
          format: date-time
          description: The timestamp when the recommender was created.
        Description:
          type: string
          description: A description of the recommender's purpose and characteristics.
        Status:
          type: string
          enum:
          - PENDING
          - IN_PROGRESS
          - ACTIVE
          - FAILED
          - STOPPING
          - INACTIVE
          - STARTING
          - DELETING
          description: The current operational status of the recommender.
        LastUpdatedAt:
          type: string
          format: date-time
          description: The timestamp of when the recommender was edited.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: The tags used to organize, track, or control access for this resource.
        FailureReason:
          type: string
          description: If the recommender is in a failed state, provides the reason for the failure.
        LatestRecommenderUpdate:
          $ref: '#/components/schemas/RecommenderUpdate'
    RecommenderUpdate:
      type: object
      properties:
        RecommenderConfig:
          $ref: '#/components/schemas/ProfileRecommenderConfig'
        Status:
          type: string
          enum:
          - PENDING
          - IN_PROGRESS
          - ACTIVE
          - FAILED
          - STOPPING
          - INACTIVE
          - STARTING
          - DELETING
          description: The current status of the recommender update operation.
        CreatedAt:
          type: string
          format: date-time
          description: The timestamp when this recommender update was initiated.
        LastUpdatedAt:
          type: string
          format: date-time
          description: The timestamp of when the recommender was edited.
        FailureReason:
          type: string
          description: If the update operation failed, provides the reason for the failure.
        RecommenderVersionName:
          type: string
          description: The name of the recommender version associated with this update operation.
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
    TrainingMetrics:
      type: object
      properties:
        Time:
          type: string
          format: date-time
          description: The timestamp when these training metrics were recorded.
        Metrics:
          type: object
          additionalProperties:
            type: number
          description: A collection of performance metrics and statistics from the training process.
        RecommenderVersionName:
          type: string
          description: The name of the recommender version that produced these training metrics.
    UpdateRecommenderRequest:
      type: object
      properties:
        DomainName:
          type: string
          description: The unique name of the domain.
        RecommenderName:
          type: string
          description: The name of the recommender to update.
        Description:
          type: string
          description: The new description to assign to the recommender.
        RecommenderConfig:
          $ref: '#/components/schemas/ProfileRecommenderConfig'
        RecommenderVersionName:
          type: string
          description: The name of a specific recommender version to activate as part of this update (for example, to roll
            back to a previously trained version).
      required:
      - DomainName
      - RecommenderName
    UpdateRecommenderResponse:
      type: object
      properties:
        RecommenderName:
          type: string
          description: The name of the recommender that was updated.
      required:
      - RecommenderName
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/customer-profiles/service/2020-08-15/customer-profiles-2020-08-15.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)