View a markdown version of this page

ListJobs - Amazon Location Service
Cas d’utilisationComprendre la demandeComprendre la réponse

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

ListJobs

L'ListJobsopération récupère une liste paginée de tâches avec des fonctionnalités de filtrage facultatives. Vous pouvez filtrer par statut de tâche et contrôler le nombre de résultats renvoyés. L'opération prend en charge la pagination via les jetons suivants, ce qui vous permet de récupérer efficacement de grandes listes de tâches.

Pour plus d'informations, consultez ListJobsle manuel Amazon Location Service API Reference.

Pour des exemples de demandes, de réponses et de commandes CLI pour cette API, consultez Comment répertorier les tâches.

Cas d’utilisation

  • Gestion de l'inventaire des tâches : récupérez toutes les tâches pour auditer l'historique des traitements et suivre l'utilisation des ressources au cours des opérations de validation.

  • Surveillance basée sur le statut : filtrez les tâches par statut pour identifier les tâches en cours nécessitant une attention particulière ou les tâches terminées prêtes à être extraites des résultats.

  • Rapports opérationnels : générez des rapports sur les modèles d'exécution des tâches, les taux de réussite et les volumes de traitement à des fins d'analyse commerciale.

  • Résolution des problèmes et débogage : Répertoriez les tâches ayant échoué afin d'identifier les modèles d'erreurs de traitement et de diagnostiquer les problèmes systématiques.

Comprendre la demande

La ListJobs demande accepte les paramètres facultatifs de filtrage et de pagination. Sans aucun paramètre, l'opération renvoie toutes les tâches avec la pagination par défaut.

La demande inclut les paramètres facultatifs suivants :

Options de filtrage

Paramètres facultatifs permettant de réduire la liste des tâches renvoyées.

  • Filter: objet contenant des critères de filtre.

    • JobStatus: filtrez les offres d'emploi en fonction de leur statut actuel. Valeurs valides : PendingRunning,Completed,Failed,Cancelling, ouCancelled.

Contrôles de pagination

Paramètres facultatifs pour contrôler la pagination des résultats.

  • MaxResults: nombre maximum de tâches à renvoyer en une seule réponse. Utilisez-le pour contrôler la taille de page pour les grands ensembles de résultats.

  • NextToken: jeton de pagination issu d'une ListJobs réponse précédente. Incluez ce jeton pour récupérer la page de résultats suivante.

Comprendre la réponse

La ListJobs réponse fournit une liste paginée de résumés de tâches avec des informations de configuration et d'état pour chaque tâche. Utilisez le jeton suivant pour récupérer des pages supplémentaires lorsque d'autres résultats sont disponibles.

La réponse inclut les champs suivants :

Liste des emplois

Tableau de résumés de tâches correspondant aux critères du filtre.

  • Entries: Ensemble de résumés de tâches, notamment :

    • Action: action exécutée par le job.

    • CreatedAt: Horodatage de la création du job au format ISO 8601.

    • EndedAt: horodatage de fin de la tâche au format ISO 8601. Présent uniquement pour les tâches en état terminal (terminées, échouées ou annulées).

    • ExecutionRoleArn: rôle IAM utilisé pour l'exécution.

    • InputOptions: objet de configuration d'entrée.

    • JobArn: Amazon Resource Name (ARN) de la tâche.

    • JobId: identifiant de tâche unique.

    • Name: nom du job s'il a été fourni lors de la création.

    • OutputOptions: objet de configuration de sortie.

    • Status: statut actuel du poste.

    • UpdatedAt: horodatage de la dernière mise à jour au format ISO 8601.

    • ActionOptions: Fonctionnalités supplémentaires demandées, le cas échéant.

Jeton de pagination

Jeton permettant de récupérer des résultats supplémentaires.

  • NextToken: jeton à inclure dans la prochaine ListJobs demande pour récupérer la page de résultats suivante. Ce champ n'est présent que lorsque d'autres résultats sont disponibles. L'absence de ce champ indique que vous avez récupéré la dernière page.

Note

Les résultats permettent de maintenir un ordre de commande cohérent sur toutes les pages. Utilisez le NextToken code de chaque réponse dans les demandes suivantes pour parcourir toutes les pages de résultats.