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 donnée, y compris son statut.
Une campagne peut se présenter dans l'un des états suivants :
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -ou- CREATE FAILED
-
DELETE PENDING > DELETE IN_PROGRESS
Lorsque status c'estCREATE FAILED, la réponse inclut la failureReason clé, qui décrit 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"
},
"rankingInfluence": {
"string" : number
},
"syncWithLatestSolutionVersion": boolean
},
"creationDateTime": number,
"failureReason": "string",
"lastUpdatedDateTime": number,
"latestCampaignUpdate": {
"campaignConfig": {
"enableMetadataWithRecommendations": boolean,
"itemExplorationConfig": {
"string" : "string"
},
"rankingInfluence": {
"string" : number
},
"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.
Erreurs
- InvalidInputException
-
Fournissez 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
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 :