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
<a name="API_DescribeCampaign"></a>

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\$1PROGRESS > ACTIVE -ou- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS

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

Pour plus d'informations sur les campagnes, consultez [CreateCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html).

## Syntaxe de la requête
<a name="API_DescribeCampaign_RequestSyntax"></a>

```
{
   "campaignArn": "string"
}
```

## Paramètres de demande
<a name="API_DescribeCampaign_RequestParameters"></a>

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

 ** [campaignArn](#API_DescribeCampaign_RequestSyntax) **   <a name="personalize-DescribeCampaign-request-campaignArn"></a>
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
<a name="API_DescribeCampaign_ResponseSyntax"></a>

```
{
   "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
<a name="API_DescribeCampaign_ResponseElements"></a>

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](#API_DescribeCampaign_ResponseSyntax) **   <a name="personalize-DescribeCampaign-response-campaign"></a>
Le `latestCampaignUpdate` champ n'est renvoyé que lorsque la campagne a reçu au moins un `UpdateCampaign` appel. 
Les propriétés de la campagne.  
Le `latestCampaignUpdate` champ n'est renvoyé que lorsque la campagne a reçu au moins un `UpdateCampaign` appel.
Type : objet [Campaign](API_Campaign.md)

## Erreurs
<a name="API_DescribeCampaign_Errors"></a>

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

## Voir aussi
<a name="API_DescribeCampaign_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeCampaign) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeCampaign) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeCampaign) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeCampaign) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeCampaign) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeCampaign) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeCampaign) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeCampaign) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeCampaign) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeCampaign)