CreateCampaign - Amazon Personalize

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

CreateCampaign

importante

Generará costos de campaña mientras esté activa. Para evitar costos innecesarios, asegúrese de eliminar la campaña cuando haya terminado. Para obtener información sobre los costos de campaña, consulte Precios de Amazon Personalize.

Crea una campaña que implementa una versión de solución. Cuando un cliente llama a las API GetRecommendations y GetPersonalizedRanking, se especifica una campaña en la solicitud.

Valor TPS mínimo aprovisionado y escalado automático

importante

Un valor elevado de minProvisionedTPS aumentará los costos. Le recomendamos empezar con 1 para minProvisionedTPS (el valor predeterminado). Realice un seguimiento de su uso mediante las métricas de Amazon CloudWatch y aumente el valor de minProvisionedTPS según sea necesario.

Al crear una campaña de Amazon Personalize, puede especificar el número mínimo de transacciones aprovisionadas por segundo (minProvisionedTPS) para la campaña. Este es el rendimiento de transacciones de línea base para la campaña aprovisionada por Amazon Personalize. Establece el cargo de facturación mínimo de la campaña mientras esté activa. Una transacción es una solicitud GetRecommendations o GetPersonalizedRanking simple. El valor predeterminado de minProvisionedTPS es 1.

Si su TPS aumenta más de minProvisionedTPS, Amazon Personalize escala automáticamente la capacidad aprovisionada hacia arriba y hacia abajo, pero nunca por debajo de minProvisionedTPS. Se produce un breve retraso durante el aumento de la capacidad que podría provocar la pérdida de transacciones. Cuando se reduce el tráfico, la capacidad vuelve al valor de minProvisionedTPS.

Se le cobrará por el valor de TPS mínimo aprovisionado o, si sus solicitudes superan el valor de minProvisionedTPS, el TPS real. El TPS real es el número total de solicitudes de recomendación que realiza. Recomendamos empezar con un nivel bajo de minProvisionedTPS, realizar un seguimiento del uso mediante las métricas de Amazon CloudWatch y, a continuación, aumentar el minProvisionedTPS según sea necesario.

Para obtener más información sobre los costos de las campañas, consulte Precios de Amazon Personalize.

Status

Una campaña puede tener uno de los siguientes estados:

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

  • DELETE PENDING > DELETE IN_PROGRESS

Para obtener el estado de la campaña, llame a DescribeCampaign.

nota

Espera a que el status de la campaña sea ACTIVE antes de pedir recomendaciones a la campaña.

Sintaxis de la solicitud

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

Parámetros de la solicitud

La solicitud acepta los siguientes datos en formato JSON.

campaignConfig

Los detalles de la configuración de una campaña.

Tipo: objeto CampaignConfig

Requerido: no

minProvisionedTPS

Especifica el número mínimo de transacciones aprovisionadas (recomendaciones) por segundo solicitadas que Amazon Personalize va a admitir. Un valor elevado de minProvisionedTPS aumentará su factura. Le recomendamos empezar con 1 para minProvisionedTPS (el valor predeterminado). Realice un seguimiento de su uso mediante las métricas de Amazon CloudWatch y aumente el valor de minProvisionedTPS según sea necesario.

Tipo: entero

Rango válido: valor mínimo de 1.

Requerido: no

name

Un nombre para la nueva campaña. El nombre de la campaña debe ser único en la cuenta.

Tipo: cadena

Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 63.

Patrón: ^[a-zA-Z0-9][a-zA-Z0-9\-_]*

Obligatorio: sí

solutionVersionArn

Nombre de recurso de Amazon (ARN) del modelo entrenado que se implementará con la campaña. Para especificar la versión más reciente de la solución, especifique el ARN de la solución en formato SolutionArn/$LATEST. Debe utilizar este formato si ha establecido syncWithLatestSolutionVersion a True en CampaignConfig.

Para implementar un modelo que no sea la última versión de solución, especifique el ARN de la versión de solución.

Para obtener más información sobre las actualizaciones de campaña automáticas, consulte Habilitación de las actualizaciones de campaña automáticas.

Tipo: cadena

Limitaciones de longitud: longitud máxima de 256.

Patrón: arn:([a-z\d-]+):personalize:.*:.*:.+

Obligatorio: sí

tags

Lista de etiquetas que se aplican a la campaña.

Tipo: matriz de objetos Tag

Miembros de la matriz: número mínimo de 0 artículos. La cantidad máxima es de 200 artículos.

Requerido: no

Sintaxis de la respuesta

{ "campaignArn": "string" }

Elementos de respuesta

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

campaignArn

El nombre de recurso de Amazon (ARN) de la campaña.

Tipo: cadena

Limitaciones de longitud: longitud máxima de 256.

Patrón: arn:([a-z\d-]+):personalize:.*:.*:.+

Errores

InvalidInputException

Proporcione un valor válido para el campo o el parámetro.

Código de estado HTTP: 400

LimitExceededException

Se ha excedido el límite en el número de solicitudes por segundo.

Código de estado HTTP: 400

ResourceAlreadyExistsException

El recurso especificado ya existe.

Código de estado HTTP: 400

ResourceInUseException

El recurso especificado está en uso.

Código de estado HTTP: 400

ResourceNotFoundException

No se ha encontrado el recurso especificado.

Código de estado HTTP: 400

TooManyTagsException

Ha superado el número máximo de etiquetas que puede aplicar a este recurso.

Código de estado HTTP: 400

Véase también

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte: