CreateCampaign - Amazon Personalize

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

CreateCampaign

Important

Vous encourez des frais de campagne lorsqu'elle est active. Pour éviter des coûts inutiles, veillez à supprimer la campagne lorsque vous aurez terminé. Pour plus d'informations sur les coûts des campagnes, consultez la section Tarification d'Amazon Personalize.

Crée une campagne qui déploie une version de la solution. Lorsqu'un client appelle les GetPersonalizedRankingAPI GetRecommendationsand, une campagne est spécifiée dans la demande.

TPS minimum provisionné et mise à l'échelle automatique

Important

Un montant élevé minProvisionedTPS augmentera vos coûts. Nous vous recommandons de commencer par 1 pour minProvisionedTPS (valeur par défaut). Suivez votre consommation à l'aide CloudWatch des statistiques Amazon et augmentez-les minProvisionedTPS si nécessaire.

Lorsque vous créez une campagne Amazon Personalize, vous pouvez spécifier le nombre minimum de transactions provisionnées par seconde (minProvisionedTPS) pour la campagne. Il s'agit du débit de transaction de référence pour la campagne mise en place par Amazon Personalize. Il définit les frais de facturation minimaux pour la campagne lorsqu'elle est active. Une transaction est une transaction unique GetRecommendations ou une GetPersonalizedRanking demande. La valeur par défaut minProvisionedTPS est 1.

Si votre TPS augmente au-delà deminProvisionedTPS, Amazon Personalize redimensionne automatiquement la capacité allouée à la hausse ou à la baisse, mais jamais en dessous. minProvisionedTPS Il y a un court délai pendant lequel la capacité augmente, ce qui peut entraîner une perte de transactions. Lorsque votre trafic diminue, la capacité revient auminProvisionedTPS.

Le TPS minimum fourni ou, si vos demandes dépassent leminProvisionedTPS, le TPS réel vous est facturé. Le TPS réel est le nombre total de demandes de recommandation que vous faites. Nous vous recommandons de commencer par un faibleminProvisionedTPS, de suivre votre consommation à l'aide CloudWatch des statistiques Amazon, puis de l'minProvisionedTPSaugmenter si nécessaire.

Pour plus d'informations sur les coûts des campagnes, consultez la section Tarification d'Amazon Personalize.

Statut

Une campagne peut se trouver dans l'un des états suivants :

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -ou- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

Pour connaître le statut de la campagne, appelez DescribeCampaign.

Note

Attendez que status la campagne soit terminée ACTIVE avant de lui demander des recommandations.

Syntaxe de la requête

{ "campaignConfig": { "enableMetadataWithRecommendations": boolean, "itemExplorationConfig": { "string" : "string" }, "syncWithLatestSolutionVersion": boolean }, "minProvisionedTPS": number, "name": "string", "solutionVersionArn": "string", "tags": [ { "tagKey": "string", "tagValue": "string" } ] }

Paramètres de demande

Cette demande accepte les données suivantes au format JSON.

campaignConfig

Les détails de configuration d'une campagne.

Type : objet CampaignConfig

Obligatoire : non

minProvisionedTPS

Spécifie le nombre minimum de transactions provisionnées demandées (recommandations) par seconde qu'Amazon Personalize prendra en charge. Un montant élevé minProvisionedTPS fera augmenter votre facture. Nous vous recommandons de commencer par 1 pour minProvisionedTPS (valeur par défaut). Suivez votre consommation à l'aide CloudWatch des statistiques Amazon et augmentez-les minProvisionedTPS si nécessaire.

Type : entier

Plage valide : Valeur minimum de 1.

Obligatoire : non

name

Un nom pour la nouvelle campagne. Le nom de la campagne doit être unique dans votre compte.

Type : chaîne

Contraintes de longueur : longueur minimum de 1. Longueur maximum de 63.

Modèle : ^[a-zA-Z0-9][a-zA-Z0-9\-_]*

Obligatoire : oui

solutionVersionArn

Le nom de ressource Amazon (ARN) du modèle entraîné à déployer avec la campagne. Pour spécifier la dernière version de votre solution, spécifiez l'ARN de votre solution au SolutionArn/$LATEST format. Vous devez utiliser ce format si vous avez défini syncWithLatestSolutionVersion sur CampaignConfig. True

Pour déployer un modèle qui n'est pas la dernière version de votre solution, spécifiez l'ARN de la version de la solution.

Pour plus d'informations sur les mises à jour automatiques des campagnes, consultez la section Activation des mises à jour automatiques des campagnes.

Type : chaîne

Contraintes de longueur : longueur maximale de 256.

Modèle : arn:([a-z\d-]+):personalize:.*:.*:.+

Obligatoire : oui

tags

Liste des tags à appliquer à la campagne.

Type : tableau d’objets Tag

Membres du tableau : nombre minimum de 0 élément. Nombre maximum de 200 éléments.

Obligatoire : non

Syntaxe de la réponse

{ "campaignArn": "string" }

Eléments de réponse

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

campaignArn

Amazon Resource Name (ARN) de la campagne.

Type : chaîne

Contraintes de longueur : longueur maximale de 256.

Modèle : arn:([a-z\d-]+):personalize:.*:.*:.+

Erreurs

InvalidInputException

Entrez une valeur valide pour le champ ou le paramètre.

Code d’état HTTP : 400

LimitExceededException

La limite du nombre de demandes par seconde a été dépassée.

Code d’état HTTP : 400

ResourceAlreadyExistsException

La ressource spécifiée existe déjà.

Code d’état HTTP : 400

ResourceInUseException

La ressource spécifiée est en cours d'utilisation.

Code d’état HTTP : 400

ResourceNotFoundException

Impossible de trouver la ressource spécifiée.

Code d’état HTTP : 400

TooManyTagsException

Vous avez dépassé le nombre maximum de balises que vous pouvez appliquer à cette ressource.

Code d’état HTTP : 400

consultez aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des AWS SDK spécifiques au langage, consultez les pages suivantes :