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

DescribeCampaign

Describe el la campaña indicada, incluido su estado.

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

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

  • DELETE PENDING > DELETE IN_PROGRESS

Cuando status es CREATE FAILED, la respuesta incluye la clave failureReason, que describe el motivo.

Para obtener información acerca de las campañas, consulte CreateCampaign.

Sintaxis de la solicitud

{ "campaignArn": "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í

Sintaxis de la respuesta

{ "campaign": { "campaignArn": "string", "campaignConfig": { "enableMetadataWithRecommendations": boolean, "itemExplorationConfig": { "string" : "string" } }, "creationDateTime": number, "failureReason": "string", "lastUpdatedDateTime": number, "latestCampaignUpdate": { "campaignConfig": { "enableMetadataWithRecommendations": boolean, "itemExplorationConfig": { "string" : "string" } }, "creationDateTime": number, "failureReason": "string", "lastUpdatedDateTime": number, "minProvisionedTPS": number, "solutionVersionArn": "string", "status": "string" }, "minProvisionedTPS": number, "name": "string", "solutionVersionArn": "string", "status": "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.

campaign

Las propiedades de la campaña.

Tipo: objeto Campaign

Errores

InvalidInputException

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

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 un SDK de AWS de un lenguaje específico, consulte: