ListApplications - Guia do desenvolvedor do Amazon Kinesis Data Analytics SQL para aplicativos

Para novos projetos, recomendamos que você use o novo Managed Service para Apache Flink Studio em vez do Kinesis Data Analytics for Applications. SQL O Managed Service for Apache Flink Studio combina facilidade de uso com recursos analíticos avançados, permitindo que você crie aplicativos sofisticados de processamento de stream em minutos.

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

ListApplications

nota

Esta documentação é para a versão 1 da API do Amazon Kinesis Data Analytics, que oferece suporte somente a aplicativos SQL. A versão 2 da API oferece suporte a aplicativos Java e SQL. Para obter mais informações sobre a versão 2, consulte Documentação da API V2 do Amazon Kinesis Data Analytics.

Retorna uma lista dos aplicativos do Amazon Kinesis Analytics em sua conta. Para cada aplicativo, a resposta inclui o nome do aplicativo, nome do recurso da Amazon (ARN) e status. Se a resposta retornar o valor HasMoreApplications como verdadeiro, você poderá enviar outra solicitação adicionando o ExclusiveStartApplicationName ao corpo da solicitação e definindo o valor como o último nome do aplicativo da resposta anterior.

Se você quiser informações detalhadas sobre um aplicativo específico, use DescribeApplication.

Essa operação exige permissões para executar a ação kinesisanalytics:ListApplications.

Sintaxe da Solicitação

{ "ExclusiveStartApplicationName": "string", "Limit": number }

Parâmetros da solicitação

A solicitação aceita os dados a seguir no formato JSON.

ExclusiveStartApplicationName

Nome do aplicativo com o qual iniciar a lista. Ao usar a paginação para recuperar a lista, você não precisa especificar esse parâmetro na primeira solicitação. No entanto, nas solicitações subsequentes você adiciona o último nome do aplicativo da resposta anterior para obter a próxima página de aplicativos.

Tipo: sequência

Restrições de tamanho: tamanho mínimo 1. O tamanho máximo é 128.

Padrão: [a-zA-Z0-9_.-]+

Obrigatório: não

Limit

Número máximo de aplicativos a serem listados.

Tipo: inteiro

Faixa válida: valor mínimo de 1. Valor máximo de 50.

Obrigatório: Não

Sintaxe da Resposta

{ "ApplicationSummaries": [ { "ApplicationARN": "string", "ApplicationName": "string", "ApplicationStatus": "string" } ], "HasMoreApplications": boolean }

Elementos de Resposta

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

ApplicationSummaries

Lista de objetos ApplicationSummary.

Tipo: matriz de objetos ApplicationSummary

HasMoreApplications

Retorna verdadeiro se houver mais aplicativos para recuperar.

Tipo: booliano

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: