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

UpdateCampaign

Actualiza una campaña para implementar una versión de solución rediseñada con una campaña existente, cambiar la minProvisionedTPS campaña o modificar la configuración de la campaña. Por ejemplo, puedes establecerlo en true enableMetadataWithRecommendations para una campaña existente.

Para actualizar una campaña para que comience automáticamente con la versión más reciente de la solución, especifique lo siguiente:

  • Para el SolutionVersionArn parámetro, especifique el nombre de recurso de Amazon (ARN) de la solución en SolutionArn/$LATEST formato.

  • En elcampaignConfig, establézcalo ensyncWithLatestSolutionVersion. true

Para actualizar una campaña, el estado de la campaña debe ser ACTIVE o CREATE FAILED. Compruebe el estado de la campaña mediante la DescribeCampaignoperación.

nota

Puede seguir recibiendo recomendaciones de una campaña mientras haya una actualización en curso. La campaña utilizará la versión de la solución y la configuración de la campaña anterior para generar recomendaciones hasta que el estado de la última actualización de la campaña sea Active.

Para obtener más información sobre la actualización de una campaña, incluidos ejemplos de código, consulte Actualización de una campaña. Para obtener información acerca de las campañas, consulte Creación de una campaña.

Sintaxis de la solicitud

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

Parámetros de la solicitud

La solicitud acepta los siguientes datos 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:.*:.*:.+

Obligatorio: sí

campaignConfig

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

Tipo: objeto CampaignConfig

Obligatorio: 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). Realiza un seguimiento de tu consumo mediante CloudWatch las métricas de Amazon y minProvisionedTPS auméntalas según sea necesario.

Tipo: entero

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

Obligatorio: no

solutionVersionArn

El nombre de recurso de Amazon (ARN) del nuevo modelo que se va a implementar. Para especificar la versión más reciente de la solución, especifique el ARN de la solución en SolutionArn/$LATEST formato. Debe usar este formato si lo configura syncWithLatestSolutionVersion True en. CampaignConfig

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

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

Tipo: cadena

Limitaciones de longitud: longitud máxima de 256.

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

Obligatorio: 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 mismo ARN de campaña que figura en la solicitud.

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

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

Véase también

Para obtener más información sobre el uso de esta API en uno de los AWS SDK específicos del idioma, consulta lo siguiente: