DescribeCampaign - Amazon Personalize
Sintassi della richiestaParametri della richiestaSintassi della rispostaElementi di rispostaErroriVedi anche

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

DescribeCampaign

Descrive la campagna specificata, incluso il suo stato.

Una campagna può trovarsi in uno dei seguenti stati:

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

  • DELETE PENDING > DELETE IN_PROGRESS

Quando status èCREATE FAILED, la risposta include la failureReason chiave, che descrive il motivo.

Per ulteriori informazioni sulle campagne, consulta CreateCampaign.

Sintassi della richiesta

{
   "campaignArn": "string"
}

Parametri della richiesta

La richiesta accetta i seguenti dati in formato JSON.

campaignArn

L'Amazon Resource Name (ARN) della campagna.

▬Tipo: stringa

Limitazioni di lunghezza: lunghezza massima di 256.

Modello: arn:([a-z\d-]+):personalize:.*:.*:.+

Campo obbligatorio: sì

Sintassi della risposta

{
   "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"
   }
}

Elementi di risposta

Se l'operazione riesce, il servizio restituisce una risposta HTTP 200.

I dati seguenti vengono restituiti in formato JSON mediante il servizio.

campaign

Le proprietà della campagna.

Tipo: oggetto Campaign

Errori

InvalidInputException

Fornisci un valore valido per il campo o il parametro.

Codice di stato HTTP: 400

ResourceNotFoundException

Impossibile trovare la risorsa specificata.

Codice di stato HTTP: 400

Vedi anche

Per ulteriori informazioni sull'utilizzo di questa API in uno degli AWS SDK specifici della lingua, consulta quanto segue: