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. Cuando no se especifica una solución, se muestran todas las campañas asociadas a la cuenta. La respuesta proporciona las propiedades para cada campaña, incluido el nombre de recurso de Amazon (ARN). Para obtener información acerca de las campañas, consulte CreateCampaign.
Sintaxis de la solicitud
{
"maxResults": number,
"nextToken": "string",
"solutionArn": "string"
}Parámetros de la solicitud
La solicitud acepta los siguientes datos en formato JSON.
- maxResults
-
Número máximo de filas que se devolverán.
Tipo: entero
Rango válido: valor mínimo de 1. Valor máximo de 100.
Requerido: no
- nextToken
-
Un token devuelto por la llamada anterior a ListCampaigns para obtener el siguiente conjunto de campañas (si existen).
Tipo: cadena
Limitaciones de longitud: longitud máxima de 1500 caracteres.
Patrón:
\p{ASCII}{0,1500}Requerido: no
- solutionArn
-
El nombre de recurso de Amazon (ARN) de la solución para la que se mostrarán las campañas. Cuando no se especifica una solución, se muestran 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:.*:.*:.+Requerido: 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 el siguiente conjunto de campañas (si existen).
Tipo: cadena
Limitaciones de longitud: longitud máxima de 1500 caracteres.
Patrón:
\p{ASCII}{0,1500}
Errores
- InvalidInputException
-
Proporcione un valor válido para el campo o el 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 idioma específico, consulte:
