CreateCampaign - Amazon Personalize

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

CreateCampaign

Importante

Os custos da campanha são acumulados enquanto ela está ativa. Para evitar custos desnecessários, certifique-se de excluir a campanha quando terminar. Para obter mais informações sobre os custos das campanhas, consulte Preços do Amazon Personalize.

Crie uma campanha que implanta uma versão da solução. Quando um cliente liga para o GetRecommendationse GetPersonalizedRanking APIs, uma campanha é especificada na solicitação.

TPS provisionado mínimo e ajuste de escala automático

Importante

Um minProvisionedTPS alto aumentará o custo. 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.

Ao criar uma campanha do Amazon Personalize, é possível especificar o mínimo de transações provisionadas por segundo (minProvisionedTPS) para a campanha. Esse é o throughput de transação básico para a campanha provisionada pelo Amazon Personalize. Ele define a cobrança mínima para a campanha enquanto ela está ativa. Transação é uma solicitação GetRecommendations ou GetPersonalizedRanking única. O minProvisionedTPS padrão é um.

Se o TPS ultrapassar o minProvisionedTPS, o Amazon Personalize fará um ajuste de escala automático da capacidade provisionada, mas nunca a definirá como abaixo de minProvisionedTPS. Há um pequeno atraso no aumento da capacidade, o que pode causar perda de transações. Quando o tráfego é reduzido, a capacidade retorna ao minProvisionedTPS.

Você recebe cobrança pelo TPS mínimo provisionado ou, se as solicitações excederem o minProvisionedTPS, o TPS real. O TPS real é o número total de solicitações de recomendação realizadas. Recomendamos começar com uma baixaminProvisionedTPS, monitorar seu uso usando CloudWatch as métricas da Amazon e depois aumentá-las minProvisionedTPS conforme necessário.

Para obter mais informações sobre custos de campanhas, consulte Preços do Amazon Personalize.

Status

Uma campanha pode estar em um dos seguintes estados:

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

  • DELETE PENDING > DELETE IN_PROGRESS

Para obter o status da campanha, ligue DescribeCampaign.

nota

Aguarde até que o status da campanha seja ACTIVE para pedir recomendações à campanha.

Sintaxe da Solicitação

{ "campaignConfig": { "enableMetadataWithRecommendations": boolean, "itemExplorationConfig": { "string" : "string" }, "syncWithLatestSolutionVersion": boolean }, "minProvisionedTPS": number, "name": "string", "solutionVersionArn": "string", "tags": [ { "tagKey": "string", "tagValue": "string" } ] }

Parâmetros da solicitação

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

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

name

Um nome para a nova campanha. O nome da campanha deve ser exclusivo na sua conta.

Tipo: string

Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.

Padrão: ^[a-zA-Z0-9][a-zA-Z0-9\-_]*

Exigido: Sim

solutionVersionArn

O nome de recurso da Amazon (ARN) do modelo treinado a ser implantado com a campanha. 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.

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.

Tipo: string

Restrições de tamanho: o tamanho máximo é 256.

Padrão: arn:([a-z\d-]+):personalize:.*:.*:.+

Exigido: Sim

tags

Uma lista de tags a serem aplicadas à campanha.

Tipo: matriz de objetos Tag

Membros da Matriz: número mínimo de 0 itens. Número máximo de 200 itens.

Obrigatório: não

Sintaxe da Resposta

{ "campaignArn": "string" }

Elementos de Resposta

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

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:.*:.*:.+

Erros

InvalidInputException

Forneça um valor válido para o campo ou parâmetro.

Código de status HTTP: 400

LimitExceededException

O limite de número de solicitações por segundo foi excedido.

Código de status HTTP: 400

ResourceAlreadyExistsException

O recurso especificado já existe.

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

TooManyTagsException

Você excedeu o número máximo de tags que pode aplicar a esse recurso.

Código de Status HTTP: 400

Consulte Também

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte: