View a markdown version of this page

ListJobs - Amazon Location Service
AnwendungsfälleVerstehen Sie die AnfrageVerstehe die Antwort

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

ListJobs

Der ListJobs Vorgang ruft eine paginierte Liste von Jobs mit optionalen Filterfunktionen ab. Sie können nach Auftragsstatus filtern und die Anzahl der zurückgegebenen Ergebnisse kontrollieren. Der Vorgang unterstützt die Seitennummerierung durch die nächsten Tokens, sodass Sie umfangreiche Joblisten effizient abrufen können.

Weitere Informationen finden Sie ListJobsin der Amazon Location Service API-Referenz.

Beispiele für Anfragen, Antworten und CLI-Befehle für diese API finden Sie unter So listen Sie Jobs auf.

Anwendungsfälle

  • Verwaltung des Auftragsinventars: Rufen Sie alle Jobs ab, um den Verarbeitungsverlauf zu überprüfen und die Ressourcennutzung bei allen Validierungsvorgängen zu verfolgen.

  • Statusbasierte Überwachung: Filtern Sie Jobs nach Status, um zu ermitteln, ob gerade Aufträge bearbeitet werden müssen, oder abgeschlossene Jobs, die zum Abrufen der Ergebnisse bereit sind.

  • Operative Berichterstattung: Generieren Sie Berichte über die Ausführungsmuster, Erfolgsquoten und das Verarbeitungsvolumen von Jobs für Geschäftsanalysen.

  • Problembehandlung und Debugging: Listet fehlgeschlagene Jobs auf, um Muster bei Verarbeitungsfehlern zu identifizieren und systematische Probleme zu diagnostizieren.

Verstehen Sie die Anfrage

Die ListJobs Anfrage akzeptiert optionale Parameter für Filterung und Paginierung. Ohne Parameter gibt der Vorgang alle Jobs mit der Standardpaginierung zurück.

Die Anfrage umfasst die folgenden optionalen Parameter:

Optionen zum Filtern

Optionale Parameter, um die Liste der zurückgegebenen Jobs einzugrenzen.

  • Filter: Objekt, das Filterkriterien enthält.

    • JobStatus: Filtert Jobs nach ihrem aktuellen Status. Gültige Werte: PendingRunning,Completed,Failed,Cancelling, oderCancelled.

Steuerelemente für die Seitennummerierung

Optionale Parameter zur Steuerung der Ergebnispaginierung.

  • MaxResults: Maximale Anzahl von Jobs, die in einer einzigen Antwort zurückgegeben werden können. Verwenden Sie diese Option, um die Seitengröße für große Ergebnismengen zu steuern.

  • NextToken: Paginierungstoken aus einer früheren ListJobs Antwort. Fügen Sie dieses Token hinzu, um die nächste Ergebnisseite abzurufen.

Verstehe die Antwort

Die ListJobs Antwort enthält eine paginierte Liste von Jobzusammenfassungen mit Konfiguration und Statusinformationen für jeden Job. Verwenden Sie das nächste Token, um weitere Seiten abzurufen, wenn weitere Ergebnisse verfügbar sind.

Die Antwort umfasst die folgenden Felder:

Liste der Job

Reihe von Jobzusammenfassungen, die den Filterkriterien entsprechen.

  • Entries: Reihe von Jobzusammenfassungen, darunter:

    • Action: Aktion, die durch den Job ausgeführt wird.

    • CreatedAt: Zeitstempel für die Joberstellung im ISO 8601-Format.

    • EndedAt: Zeitstempel für den Abschluss des Job im ISO 8601-Format. Nur für Jobs im Terminalstatus (Abgeschlossen, Fehlgeschlagen oder Storniert) vorhanden.

    • ExecutionRoleArn: Für die Ausführung verwendete IAM-Rolle.

    • InputOptions: Eingabe-Konfigurationsobjekt.

    • JobArn: Amazon-Ressourcenname (ARN) des Jobs.

    • JobId: Eindeutige Job-ID.

    • Name: Jobname, falls er bei der Erstellung angegeben wurde.

    • OutputOptions: Konfigurationsobjekt ausgeben.

    • Status: Aktueller Jobstatus.

    • UpdatedAt: Zeitstempel der letzten Aktualisierung im ISO 8601-Format.

    • ActionOptions: Zusätzliche Funktionen werden angefordert, falls vorhanden.

Paginierungstoken

Token zum Abrufen zusätzlicher Ergebnisse.

  • NextToken: Token, das in die nächste ListJobs Anfrage zum Abrufen der nächsten Ergebnisseite aufgenommen werden soll. Dieses Feld ist nur vorhanden, wenn mehr Ergebnisse verfügbar sind. Das Fehlen dieses Felds bedeutet, dass Sie die letzte Seite abgerufen haben.

Anmerkung

Die Ergebnisse sorgen für eine konsistente Reihenfolge auf allen Seiten. Verwenden Sie in nachfolgenden Anfragen den Wert NextToken von jeder Antwort, um alle Ergebnisseiten durchzugehen.