

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á.

# UpdateCampaign
<a name="API_UpdateCampaign"></a>

 Atualiza uma campanha para implantar uma versão retreinada da solução com uma campanha existente, alterar `minProvisionedTPS` da sua campanha ou modificar a configuração dela, por exemplo, a configuração de exploração. Por exemplo, você pode definir `enableMetadataWithRecommendations` como verdadeiro para uma campanha existente.

 Para atualizar uma campanha e começar a usar automaticamente a versão mais recente da solução, especifique o seguinte:
+ Para o parâmetro `SolutionVersionArn`, especifique o nome do recurso da Amazon (ARN) da solução no formato `SolutionArn/$LATEST`. 
+  Na `campaignConfig`, defina `syncWithLatestSolutionVersion` como `true`. 

Para atualizar uma campanha, o status da campanha deve ser ATIVO ou FALHA NA CRIAÇÃO. Verifique o status da campanha usando a [DescribeCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html)operação.

**nota**  
Você ainda pode receber recomendações de uma campanha enquanto uma atualização está em andamento. A campanha usará a versão anterior da solução e a configuração da campanha para gerar recomendações até que o status de atualização mais recente da campanha seja`Active`. 

Para obter mais informações sobre a atualização de uma campanha, incluindo exemplos de código, consulte [Atualização de uma campanha](https://docs.aws.amazon.com/personalize/latest/dg/update-campaigns.html). Para obter informações sobre como criar uma campanha, consulte [Criar uma campanha](https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html)

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

```
{
   "campaignArn": "string",
   "campaignConfig": { 
      "enableMetadataWithRecommendations": boolean,
      "itemExplorationConfig": { 
         "string" : "string" 
      },
      "rankingInfluence": { 
         "string" : number 
      },
      "syncWithLatestSolutionVersion": boolean
   },
   "minProvisionedTPS": number,
   "solutionVersionArn": "string"
}
```

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

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

 ** [campaignArn](#API_UpdateCampaign_RequestSyntax) **   <a name="personalize-UpdateCampaign-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

 ** [campaignConfig](#API_UpdateCampaign_RequestSyntax) **   <a name="personalize-UpdateCampaign-request-campaignConfig"></a>
Os detalhes de configuração de uma campanha.  
Tipo: objeto [CampaignConfig](API_CampaignConfig.md)  
Obrigatório: não

 ** [minProvisionedTPS](#API_UpdateCampaign_RequestSyntax) **   <a name="personalize-UpdateCampaign-request-minProvisionedTPS"></a>
Especifica o mínimo de transações provisionadas (recomendações) solicitadas por segundo para o qual o Amazon Personalize oferecerá suporte. Uma `minProvisionedTPS` alta aumentará sua conta. Recomendamos começar com 1 para `minProvisionedTPS` (o padrão). Acompanhe seu uso usando CloudWatch as métricas da Amazon e aumente as `minProvisionedTPS` conforme necessário.  
Tipo: inteiro  
Intervalo válido: valor mínimo de 1.  
Obrigatório: não

 ** [solutionVersionArn](#API_UpdateCampaign_RequestSyntax) **   <a name="personalize-UpdateCampaign-request-solutionVersionArn"></a>
O nome do recurso da Amazon (ARN) do novo modelo a ser implantado. Para especificar a versão mais recente da solução, indique o ARN da *solução* no formato `SolutionArn/$LATEST`. Você deve usar esse formato se você `syncWithLatestSolutionVersion` definir como `True` no [CampaignConfig](https://docs.aws.amazon.com/personalize/latest/dg/API_CampaignConfig.html).   
 Para implantar um modelo que não seja a versão mais recente da solução, especifique o ARN da versão da solução.   
 Para obter informações sobre as atualizações automáticas das campanhas, consulte [Habilitar as atualizações de campanha automáticas](https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-automatic-latest-sv-update).   
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

## Sintaxe da resposta
<a name="API_UpdateCampaign_ResponseSyntax"></a>

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

## Elementos de resposta
<a name="API_UpdateCampaign_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.

 ** [campaignArn](#API_UpdateCampaign_ResponseSyntax) **   <a name="personalize-UpdateCampaign-response-campaignArn"></a>
O mesmo ARN da campanha fornecido na solicitação.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

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

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
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_UpdateCampaign_SeeAlso"></a>

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