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
Atualiza uma campanha para implantar uma versão retreinada da solução com uma campanha existente, alterar a sua campanha ou modificar a configuração da sua campanha. minProvisionedTPS Por exemplo, você pode definir como verdadeiro enableMetadataWithRecommendations para uma campanha existente.
Para atualizar uma campanha para começar a usar automaticamente a versão mais recente da solução, especifique o seguinte:
-
Para o
SolutionVersionArnparâmetro, especifique o Amazon Resource Name (ARN) da sua solução emSolutionArn/$LATESTformato. -
No
campaignConfig,syncWithLatestSolutionVersiondefina comotrue.
Para atualizar uma campanha, o status da campanha deve ser ATIVO ou FALHA NA CRIAÇÃO. Verifique o status da campanha usando a DescribeCampaignoperaçã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 sejaActive.
Para obter mais informações sobre a atualização de uma campanha, incluindo exemplos de código, consulte Atualização de uma campanha. Para obter informações sobre como criar uma campanha, consulte Criar uma campanha
Sintaxe da Solicitação
{
"campaignArn": "string",
"campaignConfig": {
"enableMetadataWithRecommendations": boolean,
"itemExplorationConfig": {
"string" : "string"
},
"syncWithLatestSolutionVersion": boolean
},
"minProvisionedTPS": number,
"solutionVersionArn": "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
- campaignConfig
-
Os detalhes de configuração de uma campanha.
Tipo: objeto CampaignConfig
Obrigatório: Não
- minProvisionedTPS
-
Especifica o mínimo de transações provisionadas (recomendações) solicitadas por segundo para o qual o Amazon Personalize oferecerá suporte. Uma
minProvisionedTPSalta aumentará sua conta. Recomendamos começar com 1 paraminProvisionedTPS(o padrão). Acompanhe seu uso usando CloudWatch as métricas da Amazon e aumente asminProvisionedTPSconforme necessário.Tipo: inteiro
Intervalo válido: valor mínimo de 1.
Obrigatório: não
- solutionVersionArn
-
O Amazon Resource Name (ARN) de um novo modelo a ser implantado. Para especificar a versão mais recente da solução, especifique o ARN da solução no
SolutionArn/$LATESTformato. Você deve usar esse formato se vocêsyncWithLatestSolutionVersiondefinir comoTrueno CampaignConfig.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 mais informações sobre atualizações automáticas de campanhas, consulte Habilitar atualizações automáticas de campanhas.
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
{
"campaignArn": "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.
- campaignArn
-
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
- 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
Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos da linguagem, consulte o seguinte:
