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á.
ListJobs
A ListJobs operação recupera uma lista paginada de trabalhos com recursos de filtragem opcionais. Você pode filtrar por status do trabalho e controlar o número de resultados retornados. A operação suporta a paginação por meio de próximos tokens, permitindo que você recupere grandes listas de tarefas com eficiência.
Para obter mais informações, consulte ListJobsa Amazon Location Service API Reference.
Por exemplo, solicitações, respostas e comandos da CLI para essa API, consulte Como listar trabalhos.
Casos de uso
-
Gerenciamento de inventário de trabalhos: recupere todos os trabalhos para auditar o histórico de processamento e monitorar a utilização de recursos nas operações de validação.
-
Monitoramento baseado em status: filtre trabalhos por status para identificar trabalhos em execução que requerem atenção ou trabalhos concluídos prontos para recuperação de resultados.
-
Relatórios operacionais: gere relatórios sobre padrões de execução de trabalhos, taxas de sucesso e volumes de processamento para análises de negócios.
-
Solução de problemas e depuração: liste trabalhos com falha para identificar padrões nos erros de processamento e diagnosticar problemas sistemáticos.
Sobre a solicitação
A ListJobs solicitação aceita parâmetros opcionais para filtragem e paginação. Sem nenhum parâmetro, a operação retorna todos os trabalhos com paginação padrão.
A solicitação inclui os seguintes parâmetros opcionais:
- Opções de filtragem
-
Parâmetros opcionais para restringir a lista de trabalhos retornados.
-
Filter: Objeto contendo critérios de filtro.-
JobStatus: filtre trabalhos de acordo com seu status atual. Valores válidos:PendingRunning,Completed,Failed,Cancelling, ouCancelled.
-
-
- Controles de paginação
-
Parâmetros opcionais para controlar a paginação dos resultados.
-
MaxResults: Número máximo de trabalhos a serem retornados em uma única resposta. Use isso para controlar o tamanho da página para grandes conjuntos de resultados. -
NextToken: token de paginação de uma resposta anteriorListJobs. Inclua esse token para recuperar a próxima página de resultados.
-
Sobre a resposta
A ListJobs resposta fornece uma lista paginada de resumos de tarefas com informações de configuração e status de cada tarefa. Use o próximo token para recuperar páginas adicionais quando houver mais resultados disponíveis.
A resposta inclui os seguintes campos:
- Lista de empregos
-
Conjunto de resumos de trabalhos que correspondem aos critérios do filtro.
-
Entries: Conjunto de resumos de trabalhos, incluindo:-
Action: Ação executada pelo trabalho. -
CreatedAt: Carimbo de data e hora de criação de emprego no formato ISO 8601. -
EndedAt: Carimbo de data e hora de conclusão do trabalho no formato ISO 8601. Presente somente para trabalhos em estados de terminal (concluído, com falha ou cancelado). -
ExecutionRoleArn: função do IAM usada para execução. -
InputOptions: objeto de configuração de entrada. -
JobArn: Nome de recurso da Amazon (ARN) do trabalho. -
JobId: Identificador de trabalho exclusivo. -
Name: Nome do trabalho, se fornecido durante a criação. -
OutputOptions: objeto de configuração de saída. -
Status: Status atual do trabalho. -
UpdatedAt: data e hora da última atualização no formato ISO 8601. -
ActionOptions: recursos adicionais solicitados, se houver.
-
-
- Token de paginação
-
Token para recuperar resultados adicionais.
-
NextToken: token a ser incluído na próximaListJobssolicitação para recuperar a próxima página de resultados. Esse campo só está presente quando há mais resultados disponíveis. A ausência desse campo indica que você recuperou a última página.
-
nota
Os resultados mantêm uma ordem consistente em todas as páginas. Use a resposta NextToken de cada resposta em solicitações subsequentes para percorrer todas as páginas de resultados.
