As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
DescribeCampaign
Descreve a campanha em questão, incluindo seu status.
Uma campanha pode estar em um dos seguintes estados:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
-
DELETE PENDING > DELETE IN_PROGRESS
Quando o status éCREATE FAILED, a resposta inclui a failureReason chave, que descreve o motivo.
Para obter mais informações sobre campanhas, consulte CreateCampaign.
Sintaxe da Solicitação
{
"campaignArn": "string"
}Parâmetros da solicitação
A solicitação aceita os dados a seguir no formato JSON.
- campaignArn
-
O nome do recurso da Amazon (ARN) da campanha.
Tipo: string
Restrições de tamanho: o tamanho máximo é 256.
Padrão:
arn:([a-z\d-]+):personalize:.*:.*:.+Exigido: Sim
Sintaxe da Resposta
{
"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"
}
}Elementos de Resposta
Se a ação tiver êxito, o serviço enviará de volta uma resposta HTTP 200.
Os dados a seguir são retornados no formato JSON pelo serviço.
Erros
- InvalidInputException
-
Forneça um valor válido para o campo ou parâmetro.
Código de Status HTTP: 400
- ResourceNotFoundException
-
Não foi possível encontrar o recurso especificado.
Código de Status HTTP: 400
Consulte também
Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos da linguagem, consulte o seguinte:
