View a markdown version of this page

UpdateCampaign - Amazon Personalize
Syntaxe de la requêteParamètres de demandeSyntaxe de la réponseEléments de réponseErreursVoir aussi

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.

UpdateCampaign

Met à jour une campagne pour déployer une version de solution adaptée à une campagne existante, modifier celle de minProvisionedTPS votre campagne ou modifier la configuration de votre campagne. Par exemple, vous pouvez enableMetadataWithRecommendations définir la valeur true pour une campagne existante.

Pour mettre à jour une campagne afin qu'elle démarre automatiquement à l'aide de la dernière version de la solution, spécifiez les éléments suivants :

  • Pour le SolutionVersionArn paramètre, spécifiez le nom de ressource Amazon (ARN) de votre solution au SolutionArn/$LATEST format.

  • Dans lecampaignConfig, réglez syncWithLatestSolutionVersion surtrue.

Pour mettre à jour une campagne, son statut doit être ACTIF ou CREATE FAILED. Vérifiez l'état de la campagne à l'aide de l'DescribeCampaignopération.

Note

Vous pouvez toujours obtenir les recommandations d'une campagne pendant qu'une mise à jour est en cours. La campagne utilisera la version précédente de la solution et la configuration de la campagne pour générer des recommandations jusqu'à ce que le statut de la dernière mise à jour de la campagne soit atteintActive.

Pour plus d'informations sur la mise à jour d'une campagne, y compris des exemples de code, voir Mettre à jour une campagne. Pour plus d'informations sur les campagnes, consultez la section Création d'une campagne.

Syntaxe de la requête

{
   "campaignArn": "string",
   "campaignConfig": { 
      "enableMetadataWithRecommendations": boolean,
      "itemExplorationConfig": { 
         "string" : "string" 
      },
      "rankingInfluence": { 
         "string" : number 
      },
      "syncWithLatestSolutionVersion": boolean
   },
   "minProvisionedTPS": number,
   "solutionVersionArn": "string"
}

Paramètres de demande

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

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:.*:.*:.+

Obligatoire : oui

campaignConfig

Les détails de configuration d'une campagne.

Type : objet CampaignConfig

Obligatoire : non

minProvisionedTPS

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

Type : entier

Plage valide : Valeur minimum de 1.

Obligatoire : non

solutionVersionArn

L'Amazon Resource Name (ARN) d'un nouveau modèle à déployer. 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 True dans le CampaignConfig.

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 : 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

Le même ARN de campagne que celui indiqué dans la demande.

Type : Chaîne

Contraintes de longueur : longueur maximale de 256.

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

Erreurs

InvalidInputException

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

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

Voir aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des AWS kits SDK spécifiques à une langue, consultez les rubriques suivantes :