As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
ListCampaigns
Retorna uma lista de campanhas que usam a solução fornecida. Quando uma solução não é especificada, todas as campanhas associadas à conta são listadas. A resposta fornece as propriedades para cada campanha, incluindo o nome do recurso da Amazon (ARN). Para obter mais informações sobre campanhas, consulte CreateCampaign.
Sintaxe da Solicitação
{
"maxResults": number,
"nextToken": "string",
"solutionArn": "string"
}Parâmetros da solicitação
A solicitação aceita os dados a seguir no formato JSON.
- maxResults
-
O número máximo de campanhas a serem retornadas.
Tipo: inteiro
Intervalo válido: valor mínimo de 1. Valor máximo de 100.
Obrigatório: não
- nextToken
-
Um token retornado da chamada anterior ListCampaignspara obter o próximo conjunto de campanhas (se existirem).
Tipo: string
Restrições de tamanho: tamanho máximo de 1500.
Padrão:
\p{ASCII}{0,1500}Obrigatório: não
- solutionArn
-
O nome do recurso da Amazon (ARN) da solução para a qual listar as campanhas. Quando uma solução não é especificada, todas as campanhas associadas à conta são listadas.
Tipo: string
Restrições de tamanho: o tamanho máximo é 256.
Padrão:
arn:([a-z\d-]+):personalize:.*:.*:.+Obrigatório: Não
Sintaxe da Resposta
{
"campaigns": [
{
"campaignArn": "string",
"creationDateTime": number,
"failureReason": "string",
"lastUpdatedDateTime": number,
"name": "string",
"status": "string"
}
],
"nextToken": "string"
}Elementos de Resposta
Se a ação tiver êxito, o serviço enviará de volta uma resposta HTTP 200.
Os dados a seguir são retornados no formato JSON pelo serviço.
- campaigns
-
Uma lista das campanhas.
Tipo: matriz de objetos CampaignSummary
Membros da matriz: número máximo de 100 itens.
- nextToken
-
Um token para obter o próximo conjunto de campanhas (se existirem).
Tipo: string
Restrições de tamanho: tamanho máximo de 1500.
Padrão:
\p{ASCII}{0,1500}
Erros
- InvalidInputException
-
Forneça um valor válido para o campo ou parâmetro.
Código de Status HTTP: 400
- InvalidNextTokenException
-
O token de ID não é válido.
Código de Status HTTP: 400
Consulte também
Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos da linguagem, consulte o seguinte:
