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

Descreve a campanha em questão, incluindo seu status.

Uma campanha pode estar em um dos seguintes estados:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS

Quando o `status` é`CREATE FAILED`, a resposta inclui a `failureReason` chave, que descreve o motivo.

Para obter mais informações sobre campanhas, consulte [CreateCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html).

## Sintaxe da solicitação
<a name="API_DescribeCampaign_RequestSyntax"></a>

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

## Parâmetros da solicitação
<a name="API_DescribeCampaign_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [campaignArn](#API_DescribeCampaign_RequestSyntax) **   <a name="personalize-DescribeCampaign-request-campaignArn"></a>
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:.*:.*:.+`   
Obrigatório: sim

## Sintaxe da resposta
<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"
   }
}
```

## Elementos de resposta
<a name="API_DescribeCampaign_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [campaign](#API_DescribeCampaign_ResponseSyntax) **   <a name="personalize-DescribeCampaign-response-campaign"></a>
O campo `latestCampaignUpdate` só é retornado quando a campanha teve pelo menos uma chamada `UpdateCampaign`. 
As propriedades da campanha.  
O campo `latestCampaignUpdate` só é retornado quando a campanha teve pelo menos uma chamada `UpdateCampaign`.
Tipo: objeto [Campaign](API_Campaign.md)

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

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

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeCampaign) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeCampaign) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeCampaign) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeCampaign) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeCampaign) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeCampaign) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeCampaign) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeCampaign) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeCampaign) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeCampaign)