DescribeCampaign - 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.

DescribeCampaign

Décrit la campagne en question, y compris son 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

Lorsque status c'est le casCREATE FAILED, la réponse inclut la failureReason clé, qui explique pourquoi.

Pour plus d'informations sur les campagnes, consultez CreateCampaign.

Syntaxe de la requête

{ "campaignArn": "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

Syntaxe de la réponse

{ "campaign": { "campaignArn": "string", "campaignConfig": { "enableMetadataWithRecommendations": boolean, "itemExplorationConfig": { "string" : "string" }, "syncWithLatestSolutionVersion": boolean }, "creationDateTime": number, "failureReason": "string", "lastUpdatedDateTime": number, "latestCampaignUpdate": { "campaignConfig": { "enableMetadataWithRecommendations": boolean, "itemExplorationConfig": { "string" : "string" }, "syncWithLatestSolutionVersion": boolean }, "creationDateTime": number, "failureReason": "string", "lastUpdatedDateTime": number, "minProvisionedTPS": number, "solutionVersionArn": "string", "status": "string" }, "minProvisionedTPS": number, "name": "string", "solutionVersionArn": "string", "status": "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.

campaign

Les propriétés de la campagne.

Type : objet Campaign

Erreurs

InvalidInputException

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

Code d’état HTTP : 400

ResourceNotFoundException

Impossible de trouver la ressource spécifiée.

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 :