Die AWS Partner Central API-Referenz wurde neu strukturiert. Weitere Informationen zu den unterstützten API-Vorgängen finden Sie in der AWS Partner Central API-Referenz.

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.

Arbeiten mit Leistungsanträgen

Eine Leistungsanwendung modelliert den Antrag eines Partners auf eine bestimmte Leistung. Es erfasst alle Informationen, die für die Bewertung und Bearbeitung des Antrags gemäß den leistungsspezifischen Bedingungen erforderlich sind. Der Lebenszyklus eines Leistungsantrags durchläuft mehrere Phasen, von der Erstellung des Entwurfs bis zur endgültigen Genehmigung oder Ablehnung.

Erstellung von Leistungsanträgen

Partner initiieren den Prozess zur Beantragung von Leistungen, indem sie mithilfe der CreateBenefitApplication API-Aktion einen Leistungsantrag erstellen. Bei der Erstellung wechselt der Antrag in den PENDING_SUBMISSION Status, sodass die Partner vollständige Informationen vorbereiten können, bevor sie sie zur Überprüfung einreichen.

Bei der Erstellung eines Leistungsantrags müssen die Partner Folgendes vorlegen:

Partner können optional Folgendes bereitstellen:

Die CreateBenefitApplication API führt eine Soft-Validation durch und überprüft nur grundlegende Feldtypen und Muster. Die vollständige Validierung der Geschäftslogik erfolgt während der Einreichung, sodass Partner unvollständige Anträge speichern und später zurückkehren können, um sie auszufüllen.

Best Practice: Partner sollten das Schema für Leistungsanträge von verwendenGetBenefit, um genau zu verstehen, welche Informationen benötigt werden, bevor sie einen Antrag erstellen. Dies reduziert die Wahrscheinlichkeit, dass die Einreichung aufgrund fehlender oder ungültiger Daten fehlschlägt.

Aktualisierung der Leistungsanträge

Partner können die Entwürfe von Leistungsanträgen mithilfe der UpdateBenefitApplication API-Aktion ändern. Auf diese Weise können Partner Informationen verfeinern, Unterlagen hinzufügen oder Fehler vor der Einreichung korrigieren.

Bei der Aktualisierung eines Leistungsantrags müssen die Partner Folgendes angeben:

Partner müssen den vollständigen Leistungsantrag einreichen, auch wenn sich nur bestimmte Felder ändern. Es hat sich bewährt, zuerst die neuesten Antragsdetails mithilfe von Hilfe abzurufenGetBenefitApplication, die erforderlichen Felder zu ändern und dann die vollständige, aktualisierte Nutzlast an zu UpdateBenefitApplication senden.

Optimistische Sperrung: Das Revisionsfeld stellt sicher, dass Aktualisierungen nur angewendet werden, wenn sich die Anwendung seit dem letzten Abruf nicht geändert hat. Wenn die Revision nicht mit dem aktuellen Datenbankwert übereinstimmt, wird das Update mit einem Konfliktfehler abgelehnt. Dadurch wird verhindert, dass Partner versehentlich Änderungen überschreiben, die von anderen Prozessen oder Systemen vorgenommen wurden.

Aktualisierungen können nur durchgeführt werden, solange sich die Anwendung im PENDING_SUBMISSION Status befindet. Sobald Anträge eingereicht wurden, durchlaufen sie den Überprüfungsprozess und können nicht mehr über diese API aktualisiert werden.

Zuordnen von Ressourcen zu Leistungsanträgen

Partner können Leistungsanträge mithilfe der AssociateBenefitApplicationResource API-Aktion mit verwandten Ressourcen verknüpfen. Dadurch entstehen wertvolle Verbindungen zwischen den Leistungen und dem Geschäftskontext, in dem sie genutzt werden.

Unterstützte Ressourcentypen sind u. a.:

Die Zuordnung von Ressourcen kann nur vor der Einreichung erfolgen. Sobald ein Leistungsantrag eingereicht wurde (der Status ändert sich inIN_REVIEW), sind keine weiteren Zuordnungen zulässig. Partner können jedem Leistungsantrag bis zu 10 Ressourcen zuordnen.

Um die Zuordnung einer Ressource aufzuheben, verwenden Partner die DisassociateBenefitApplicationResource API-Aktion. Wie bei der Verknüpfung kann auch die Trennung nur im PENDING_SUBMISSION Status erfolgen.

Einreichung von Leistungsanträgen

Wenn ein Leistungsantrag vollständig und zur AWS Prüfung bereit ist, reichen die Partner ihn mithilfe der SubmitBenefitApplication API-Aktion ein. Die Einreichung löst einen Statusübergang von PENDING_SUBMISSION zu aus aus IN_REVIEW und leitet den leistungsspezifischen Genehmigungsworkflow ein.

Nach der Einreichung führt die API eine umfassende Validierung durch, einschließlich:

Wenn die Validierung fehlschlägt, gibt die API eine ValidationException mit detaillierten Fehlercodes und Meldungen zurück, die angeben, welche Felder korrigiert werden müssen. Partner müssen diese Probleme mithilfe von Hilfe lösen, UpdateBenefitApplication bevor sie erneut versuchen, die Einreichung zu versuchen.

Anforderung an die Dateiverarbeitung: Leistungsanträge können nicht eingereicht werden, wenn sich die angehängten Dateien noch im PENDING Status befinden. Partner müssen warten, bis die Dateiverarbeitung abgeschlossen ist (der Status ändert sich zuSUCCEEDED), bevor sie sie einreichen. Wenn Dateien nicht verarbeitet werden können (StatusFAILED), sollten Partner korrigierte Versionen hochladen.

Nach erfolgreicher Einreichung:

Partner können den Fortschritt der Einreichung verfolgen, indem sie den Antrag aufrufen und das Feld Phase überwachen, in dem die aktuelle Genehmigungsphase angegeben ist (z. B. „Geschäftsgenehmigung“, „Technische Genehmigung“, „Finanzielle Genehmigung“).

Verwaltung der eingereichten Anträge

Nach der Einreichung haben Partner nur begrenzte Möglichkeiten, Leistungsanträge zu verwalten, aber die API bietet spezifische Aktionen für häufig auftretende Szenarien.

Rückruf von Leistungsanträgen

Wenn ein Partner nach der Einreichung einen Fehler entdeckt oder Änderungen vornehmen muss, kann er den Antrag mithilfe der RecallBenefitApplication API-Aktion zurückrufen. Durch Rückruf wird die Anwendung wieder in den PENDING_SUBMISSION Status versetzt, sodass sie aktualisiert und erneut eingereicht werden kann.

Beim Rückruf eines Antrags sollten Partner Folgendes angeben:

Das Feld „Grund“ ermöglicht eine bessere Rückverfolgbarkeit und hilft dabei, häufig auftretende Probleme zu AWS verstehen, die zu Rückrufaktionen führen, sodass zukünftige Verbesserungen des Antragsverfahrens für Leistungen berücksichtigt werden können.

Nach dem Rückruf können die Partner die erforderlichen UpdateBenefitApplication Änderungen vornehmen und dann erneut einreichen, wenn sie bereit sind. SubmitBenefitApplication

Änderung von Leistungsanträgen

Bei geringfügigen Korrekturen nach der Einreichung können Partner die AmendBenefitApplication API-Aktion verwenden, um bestimmte Felder zu aktualisieren, ohne den gesamten Antrag erneut aufrufen zu müssen. Dies ist besonders nützlich, wenn AWS Gutachter während des Überprüfungsprozesses um Klarstellungen oder Korrekturen bitten.

Änderungsanträge verwenden einen Patch-style JSON-Ansatz, bei dem die Partner Folgendes angeben:

Partner können in einem einzigen API-Aufruf bis zu 10 Änderungen einreichen. Jede Änderung muss eine aktualisierte Revisionsnummer enthalten, um eine optimistische Sperrung zu gewährleisten.

Änderungen sollten für geringfügige Korrekturen verwendet werden. Bei wesentlichen Änderungen sollten die Partner nutzen, RecallBenefitApplication um den Antrag wieder in den Entwurfsstatus zu versetzen, sodass er umfassend aktualisiert werden kann.

Stornierung von Leistungsanträgen

Wenn ein Partner keine Leistung mehr benötigt oder seinen Antrag zurückziehen möchte, kann er ihn mithilfe der CancelBenefitApplication API-Aktion stornieren. Bei einer Stornierung wird der Antrag in den CANCELED Status versetzt, wodurch der Antragsprozess dauerhaft beendet wird.

Bei der Stornierung einer Bewerbung sollten Partner Folgendes vorlegen:

Einmal stornierte Anwendungen können nicht mehr reaktiviert werden. Wenn der Partner später entscheidet, dass er die Leistung benötigt, muss er einen neuen Leistungsantrag stellen.

Zu den häufigsten Gründen für eine Kündigung gehören:

Einzelheiten zum Leistungsantrag anzeigen

Partner können mithilfe der GetBenefitApplication API-Aktion vollständige Informationen zu einem Leistungsantrag abrufen. Dies bietet einen umfassenden Überblick über den Antrag, einschließlich:

Metadaten der Anwendung:

Informationen zum Status:

Inhalt der Bewerbung:

Informationen zur Prüfung:

Die Codes für die Gründe für den Status sind besonders nützlich, wenn sich eine Anwendung im ACTION_REQUIRED Status befindet. Diese Codes bieten konkrete, umsetzbare Hinweise dazu, was die Partner beachten müssen, damit der Antrag bearbeitet werden kann.

Auflisten von Leistungsanträgen

Partner können alle ihre Leistungsanträge mithilfe der ListBenefitApplications API-Aktion einsehen. Dadurch wird eine paginierte Liste von Anwendungszusammenfassungen mit leistungsstarken Filterfunktionen zurückgegeben.

Partner können Anwendungen nach folgenden Kriterien filtern:

Die Antwort auf die Liste enthält wichtige zusammenfassende Informationen wie:

Partner können mithilfe des Parameters „Sortieren“ die Sortierung der Ergebnisse konfigurieren. Dabei stehen Optionen zur Sortierung nach Erstellungsdatum, Status, Programm oder Leistungskennzeichnung in aufsteigender oder absteigender Reihenfolge zur Verfügung.

Dashboard-Erstellung: Die ListBenefitApplications API wurde entwickelt, um die Erstellung von Partner-Dashboards zu unterstützen. Durch das Filtern und Sortieren von Anwendungen können Partner Ansichten wie die folgenden erstellen: