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.
ListCampaigns
Devuelve una lista de campañas que utilizan la solución dada. Si no se especifica una solución, se enumeran todas las campañas asociadas a la cuenta. La respuesta proporciona las propiedades de cada campaña, incluido el Nombre de recurso de Amazon (ARN). Para obtener más información sobre las campañas, consulte CreateCampaign.
Sintaxis de la solicitud
{
"maxResults": number,
"nextToken": "string",
"solutionArn": "string"
}Parámetros de solicitud
La solicitud acepta los siguientes datos en formato JSON.
- maxResults
-
El número máximo de campañas que se van a devolver.
Tipo: entero
Rango válido: valor mínimo de 1. Valor máximo de 100.
Obligatorio: no
- nextToken
-
Un token devuelto de la convocatoria anterior ListCampaignspara obtener la siguiente serie de campañas (si existe).
Tipo: cadena
Limitaciones de longitud: longitud máxima de 1500 caracteres.
Obligatorio: no
- solutionArn
-
El nombre de recurso de Amazon (ARN) de la solución para la que se enumeran las campañas. Si no se especifica una solución, se enumeran todas las campañas asociadas a la cuenta.
Tipo: cadena
Limitaciones de longitud: longitud máxima de 256.
Patrón:
arn:([a-z\d-]+):personalize:.*:.*:.+Obligatorio: no
Sintaxis de la respuesta
{
"campaigns": [
{
"campaignArn": "string",
"creationDateTime": number,
"failureReason": "string",
"lastUpdatedDateTime": number,
"name": "string",
"status": "string"
}
],
"nextToken": "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.
- campaigns
-
Una lista de las campañas.
Tipo: Matriz de objetos CampaignSummary
Miembros de la matriz: número máximo de 100 elementos.
- nextToken
-
Un token para obtener la siguiente serie de campañas (si existen).
Tipo: cadena
Limitaciones de longitud: longitud máxima de 1500 caracteres.
Errores
- InvalidInputException
-
Proporcione un valor válido para el campo o parámetro.
Código de estado HTTP: 400
- InvalidNextTokenException
-
El token no es válido.
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:
