Amazon Personalize

Amazon Personalize Personalize Campaign API

The Personalize Campaign API from Amazon Personalize — 5 operation(s) for personalize campaign.

GitHub OpenAPI
Business capability
Model Inference AE-110.10

Operations 5

POST /#CreateCampaign Create Campaign #
POST /#DeleteCampaign Delete Campaign #
POST /#DescribeCampaign Describe Campaign #
POST /#ListCampaigns List Campaigns #
POST /#UpdateCampaign Update Campaign #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-personalize/openapi/amazon-personalize-campaign-api-openapi.yml

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-personalize:amazon-personalize-campaign-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

amazon-personalize-campaign-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Amazon Personalize Campaign API
  version: '2018-05-22'
  description: Generated from AWS's published Smithy model for Amazon Personalize. 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://personalize.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Campaign
paths:
  /#CreateCampaign:
    post:
      operationId: CreateCampaign
      summary: Create Campaign
      description: You incur campaign costs while it is active. To avoid unnecessary costs, make sure to delete the campaign when you are finished. For information about campaign costs, see Amazon Personalize pricing. Creates a campaign that deploys a solution version. When a client calls the GetRecommendations and GetPersonalizedRanking APIs, a campaign is specified in the request. Minimum Provisioned TPS and Auto-Scaling A high minProvisionedTPS will increase your cost. We recommend starting with 1 for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as necessary. When you create an Amazon Personalize campaign, you can specify the minimum provisioned transactions per second (minProvisionedTPS) for the campaign. This is the baseline transaction throughput for the campaign provisioned by Amazon Personalize. It sets the minimum billing charge for the campaign while it is active. A transaction is a single GetRecommendations or GetPersonalizedRanking request. The default minProvisionedTPS is 1. If your TPS increases beyond the minProvisionedTPS, Amazon Personalize auto-scales the provisioned capacity up and down, but never below minPro
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateCampaignResponse'
        '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.CreateCampaign
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateCampaignRequest'
      tags:
      - Campaign
  /#DeleteCampaign:
    post:
      operationId: DeleteCampaign
      summary: Delete Campaign
      description: Removes a campaign by deleting the solution deployment. The solution that the campaign is based on is not deleted and can be redeployed when needed. A deleted campaign can no longer be specified in a GetRecommendations request. For information on creating campaigns, see CreateCampaign.
      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.DeleteCampaign
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteCampaignRequest'
      tags:
      - Campaign
  /#DescribeCampaign:
    post:
      operationId: DescribeCampaign
      summary: Describe Campaign
      description: 'Describes the given campaign, including its status. A campaign can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE IN_PROGRESS When the status is CREATE FAILED, the response includes the failureReason key, which describes why. For more information on campaigns, see CreateCampaign.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeCampaignResponse'
        '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.DescribeCampaign
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeCampaignRequest'
      tags:
      - Campaign
  /#ListCampaigns:
    post:
      operationId: ListCampaigns
      summary: List Campaigns
      description: Returns a list of campaigns that use the given solution. When a solution is not specified, all the campaigns associated with the account are listed. The response provides the properties for each campaign, including the Amazon Resource Name (ARN). For more information on campaigns, see CreateCampaign.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListCampaignsResponse'
        '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.ListCampaigns
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListCampaignsRequest'
      tags:
      - Campaign
  /#UpdateCampaign:
    post:
      operationId: UpdateCampaign
      summary: Update Campaign
      description: 'Updates a campaign to deploy a retrained solution version with an existing campaign, change your campaign''s minProvisionedTPS, or modify your campaign''s configuration. For example, you can set enableMetadataWithRecommendations to true for an existing campaign. To update a campaign to start automatically using the latest solution version, specify the following: For the SolutionVersionArn parameter, specify the Amazon Resource Name (ARN) of your solution in SolutionArn/$LATEST format. In the campaignConfig, set syncWithLatestSolutionVersion to true. To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign operation. You can still get recommendations from a campaign while an update is in progress. The campaign will use the previous solution version and campaign configuration to generate recommendations until the latest campaign update status is Active. For more information about updating a campaign, including code samples, see Updating a campaign. For more information about campaigns, see Creating a campaign.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateCampaignResponse'
        '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.UpdateCampaign
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateCampaignRequest'
      tags:
      - Campaign
components:
  schemas:
    UpdateCampaignRequest:
      type: object
      properties:
        campaignArn:
          type: string
          description: The Amazon Resource Name (ARN) of the campaign.
        solutionVersionArn:
          type: string
          description: The Amazon Resource Name (ARN) of a new model to deploy. To specify the latest solution version of your solution, specify the ARN of your solution in SolutionArn/$LATEST format. You must use this format if you set syncWithLatestSolutionVersion to True in the CampaignConfig. To deploy a model that isn't the latest solution version of your solution, specify the ARN of the solution version. For more information about automatic campaign updates, see Enabling automatic campaign updates.
        minProvisionedTPS:
          type: integer
          description: Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support. A high minProvisionedTPS will increase your bill. We recommend starting with 1 for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as necessary.
        campaignConfig:
          $ref: '#/components/schemas/CampaignConfig'
      required:
      - campaignArn
    DescribeCampaignResponse:
      type: object
      properties:
        campaign:
          $ref: '#/components/schemas/Campaign'
    CampaignSummary:
      type: object
      properties:
        name:
          type: string
          description: The name of the campaign.
        campaignArn:
          type: string
          description: The Amazon Resource Name (ARN) of the campaign.
        status:
          type: string
          description: 'The status of the campaign. A campaign 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 campaign was created.
        lastUpdatedDateTime:
          type: string
          format: date-time
          description: The date and time (in Unix time) that the campaign was last updated.
        failureReason:
          type: string
          description: If a campaign fails, the reason behind the failure.
    DescribeCampaignRequest:
      type: object
      properties:
        campaignArn:
          type: string
          description: The Amazon Resource Name (ARN) of the campaign.
      required:
      - campaignArn
    CampaignUpdateSummary:
      type: object
      properties:
        solutionVersionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the deployed solution version.
        minProvisionedTPS:
          type: integer
          description: Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.
        campaignConfig:
          $ref: '#/components/schemas/CampaignConfig'
        status:
          type: string
          description: 'The status of the campaign update. A campaign update can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE IN_PROGRESS'
        failureReason:
          type: string
          description: If a campaign update fails, the reason behind the failure.
        creationDateTime:
          type: string
          format: date-time
          description: The date and time (in Unix time) that the campaign update was created.
        lastUpdatedDateTime:
          type: string
          format: date-time
          description: The date and time (in Unix time) that the campaign update was last updated.
    ResourceAlreadyExistsException:
      type: object
      properties:
        message:
          type: string
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    CreateCampaignResponse:
      type: object
      properties:
        campaignArn:
          type: string
          description: The Amazon Resource Name (ARN) of the campaign.
    LimitExceededException:
      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
    DeleteCampaignRequest:
      type: object
      properties:
        campaignArn:
          type: string
          description: The Amazon Resource Name (ARN) of the campaign to delete.
      required:
      - campaignArn
    CampaignConfig:
      type: object
      properties:
        itemExplorationConfig:
          type: object
          additionalProperties:
            type: string
          description: Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your solution uses the User-Personalization recipe.
        enableMetadataWithRecommendations:
          type: boolean
          description: Whether metadata with recommendations is enabled for the campaign. If enabled, you can specify the columns from your Items dataset in your request for recommendations. Amazon Personalize returns this data for each item in the recommendation response. For information about enabling metadata for a campaign, see Enabling metadata in recommendations for a campaign. If you enable metadata in recommendations, you will incur additional costs. For more information, see Amazon Personalize pricing.
        syncWithLatestSolutionVersion:
          type: boolean
          description: Whether the campaign automatically updates to use the latest solution version (trained model) of a solution. If you specify True, you must specify the ARN of your solution for the SolutionVersionArn parameter. It must be in SolutionArn/$LATEST format. The default is False and you must manually update the campaign to deploy the latest solution version. For more information about automatic campaign updates, see Enabling automatic campaign updates.
        rankingInfluence:
          type: object
          additionalProperties:
            type: number
          description: A map of ranking influence values for POPULARITY and FRESHNESS. For each key, specify a numerical value between 0.0 and 1.0 that determines how much influence that ranking factor has on the final recommendations. A value closer to 1.0 gives more weight to the factor, while a value closer to 0.0 reduces its influence.
    InvalidInputException:
      type: object
      properties:
        message:
          type: string
    UpdateCampaignResponse:
      type: object
      properties:
        campaignArn:
          type: string
          description: The same campaign ARN as given in the request.
    ResourceInUseException:
      type: object
      properties:
        message:
          type: string
    Campaign:
      type: object
      properties:
        name:
          type: string
          description: The name of the campaign.
        campaignArn:
          type: string
          description: The Amazon Resource Name (ARN) of the campaign.
        solutionVersionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the solution version the campaign uses.
        minProvisionedTPS:
          type: integer
          description: Specifies the requested minimum provisioned transactions (recommendations) per second. A high minProvisionedTPS will increase your bill. We recommend starting with 1 for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as necessary.
        campaignConfig:
          $ref: '#/components/schemas/CampaignConfig'
        status:
          type: string
          description: 'The status of the campaign. A campaign can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE IN_PROGRESS'
        failureReason:
          type: string
          description: If a campaign fails, the reason behind the failure.
        creationDateTime:
          type: string
          format: date-time
          description: The date and time (in Unix format) that the campaign was created.
        lastUpdatedDateTime:
          type: string
          format: date-time
          description: The date and time (in Unix format) that the campaign was last updated.
        latestCampaignUpdate:
          $ref: '#/components/schemas/CampaignUpdateSummary'
    CreateCampaignRequest:
      type: object
      properties:
        name:
          type: string
          description: A name for the new campaign. The campaign name must be unique within your account.
        solutionVersionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the trained model to deploy with the campaign. To specify the latest solution version of your solution, specify the ARN of your solution in SolutionArn/$LATEST format. You must use this format if you set syncWithLatestSolutionVersion to True in the CampaignConfig. To deploy a model that isn't the latest solution version of your solution, specify the ARN of the solution version. For more information about automatic campaign updates, see Enabling automatic campaign updates.
        minProvisionedTPS:
          type: integer
          description: Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support. A high minProvisionedTPS will increase your bill. We recommend starting with 1 for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as necessary.
        campaignConfig:
          $ref: '#/components/schemas/CampaignConfig'
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of tags to apply to the campaign.
      required:
      - name
      - solutionVersionArn
    ListCampaignsRequest:
      type: object
      properties:
        solutionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the solution to list the campaigns for. When a solution is not specified, all the campaigns associated with the account are listed.
        nextToken:
          type: string
          description: A token returned from the previous call to ListCampaigns for getting the next set of campaigns (if they exist).
        maxResults:
          type: integer
          description: The maximum number of campaigns to return.
    ListCampaignsResponse:
      type: object
      properties:
        campaigns:
          type: array
          items:
            $ref: '#/components/schemas/CampaignSummary'
          description: A list of the campaigns.
        nextToken:
          type: string
          description: A token for getting the next set of campaigns (if they exist).
  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)