Veröffentlichen eines Produkts in AWS Data Exchange enthält APIs

Fügen Sie der Ressourcenrichtlinie Ihrer API die folgende Richtlinie hinzu:

{
"Effect": "Allow",
"Principal": {"Service": "dataexchange.amazonaws.com"},
"Action": "execute-api:Invoke",
"Resource": "*",
"Condition": {"StringEquals": {"aws:SourceAccount": "<account-id>"}}
}

account-idErsetzen Sie es durch das Konto, das den API-Datensatz erstellen wird.

Das Konto mit der API Gateway-Ressource muss sich nicht in demselben Konto befinden, das den Datensatz erstellt.

Öffnen Sie Ihren Webbrowser und melden Sie sich bei der AWS Data Exchange Konsole an.

Wählen Sie im linken Navigationsbereich unter Meine Daten die Option Eigene Datensätze aus.

Wählen Sie unter Eigene Datensätze die Option Datensatz erstellen aus, um den Assistenten für die Schritte zur Erstellung von Datensätzen zu öffnen.

Wählen Sie unter Datensatztyp auswählen die Option Amazon API Gateway API aus.

Geben Sie unter Datensatz definieren einen Namen und eine Beschreibung für Ihren Datensatz ein. Weitere Informationen finden Sie unter Bewährte Verfahren für Datensätze.

(Optional) Fügen Sie unter Tags hinzufügen — optional Tags hinzu.

Wählen Sie Erstellen aus.

Verwenden Sie den create-data-set Befehl, um einen API-Datensatz zu erstellen:

$ AWS dataexchange create-data-set \
--asset-type API_GATEWAY_API \
--description 'Data Set Description' \
--name 'Data Set Name'

{
"Arn": "arn:aws:dataexchange:us-east-1:123456789012:data-sets/$DATA_SET_ID",
"AssetType": "API_GATEWAY_API",
"CreatedAt": "2021-09-11T00:16:46.349000+00:00",
"Description": "Data Set Description",
"Id": "$DATA_SET_ID",
"Name": "Data Set Name",
"Origin": "OWNED",
"UpdatedAt": "2021-09-11T00:16:46.349000+00:00"
}

Beachten Sie den neuen Asset-Typ vonAPI_GATEWAY_API.

Gehen Sie auf der Seite mit den Datensatzdetails im Abschnitt „Datensatzübersicht“ wie folgt vor:

1. (Optional) Wählen Sie Namen bearbeiten, um Informationen zu Ihrem Datensatz zu bearbeiten.

2. (Optional) Wählen Sie Löschen, um den Datensatz zu löschen.

Wählen Sie im Abschnitt Revisionen die Option Revision erstellen aus.

Geben Sie unter Revision definieren optional einen Kommentar zu Ihrer Revision ein, der den Zweck der Revision beschreibt.

(Optional) Fügen Sie unter Schlagworte hinzufügen — optional die mit der Ressource verknüpften Tags hinzu.

Wählen Sie Revision erstellen aus.

Überprüfe, bearbeite oder lösche deine Änderungen aus dem vorherigen Schritt.

Verwenden Sie den create-revision Befehl, um eine Revision zu erstellen:

$ AWS dataexchange create-revision \
--data-set-id $DATA_SET_ID \
--comment 'First Atlas Revision'
{
"Arn": "arn:aws:dataexchange:us-east-1:123456789012:data-sets/$DATA_SET_ID/revisions/$REVISION_ID",
"Comment": "First Atlas Revision",
"CreatedAt": "2021-09-11T00:18:49.160000+00:00",
"DataSetId": "$DATA_SET_ID",
"Finalized": false,
"Id": "$REVISION_ID",
"UpdatedAt": "2021-09-11T00:18:49.160000+00:00"
}

Fügen Sie die API-Assets zur Revision hinzu.

Wählen Sie auf der Seite mit den Datensatzdetails im Abschnitt API-Assets die Option API-Stufe hinzufügen aus.

Geben Sie unter API-Stufe auswählen für Amazon API Gateway-API eine API in das Eingabefeld ein, oder wählen Sie eine der folgenden Optionen aus der Dropdownliste aus:

1. Wenn Sie in einem anderen die API ausgewählt haben AWS-Konto, geben Sie die API-ID und den Namen der API-Stufe in die Eingabefelder ein.

2. Wenn Sie In diesem Feld ausgewählt haben AWS-Konto, wählen Sie den Namen der API-Stufe aus der Dropdownliste

Unter Erweiterte Konfiguration — optional können Sie den bestehenden Amazon API Gateway-Nutzungsplan verbinden, um die im bestehenden Nutzungsplan definierten Drosselungs- und Kontingentbeschränkungen zu verwenden, und den API-Schlüssel eingeben.

Geben Sie unter Dokument-API für Abonnenten Details zur API an, die Abonnenten sehen werden, nachdem sie Ihr Produkt abonniert haben.

1. Geben Sie als API-Name einen Namen ein, den Abonnenten zur Identifizierung des API-Assets verwenden können.

   Anmerkung

   Wenn hier ein In ausgewählt AWS-Konto wurde, wird der API-Name automatisch ausgefüllt, den Sie bei Bedarf ändern können.

   Wenn eine API in einer anderen ausgewählt AWS-Konto wurde, wird der API-Name mit einem Standardnamen aufgefüllt, den Sie ändern sollten, damit der Abonnent leicht verstehen kann, um welchen Namen es sich handelt.

2. Für die OpenAPI 3.0-Spezifikation gilt entweder:

   1. Geben Sie die OpenAPI 3.0-Spezifikationsdatei ein oder kopieren Sie sie und fügen Sie sie ein.

   2. Wählen Sie Aus JSON-Datei importieren und wählen Sie dann die JSON-Datei von Ihrem lokalen Computer zum Importieren aus.

      Die importierte Spezifikation wird in dem Feld angezeigt.

   3. Wählen Sie Aus Amazon API Gateway importieren und wählen Sie dann eine Spezifikation für den Import aus.

      Die importierte Spezifikation wird in dem Feld angezeigt.

3. Für zusätzliche Dokumentation — optional — geben Sie alle zusätzlichen Informationen ein, die für den Abonnenten nützlich sind, um über Ihre API Bescheid zu wissen. Markdown wird unterstützt.

Wählen Sie API-Stufe hinzufügen aus.

Ein Job wird gestartet, um Ihr Asset (in diesem Fall die API) in Ihren Datensatz zu importieren.

Nach Abschluss des Jobs wird das Feld Status im Abschnitt Jobs auf Abgeschlossen aktualisiert.

Wenn Sie weitere APIs hinzufügen möchten, wiederholen Sie Schritt 2.

Überprüfen Sie unter Revisionsübersicht Ihre Revision und ihre Ressourcen.

Wählen Sie „Abschließen“.

Verwenden Sie den create-job Befehl, um API-Assets zur Revision hinzuzufügen:

$ AWS dataexchange create-job \
  --type IMPORT_ASSET_FROM_API_GATEWAY_API \
  --details '{"ImportAssetFromApiGatewayApi":{"DataSetId":"$DATA_SET_ID","RevisionId":"$REVISION_ID","ApiId":"$API_ID","Stage":"$API_STAGE","ProtocolType":"REST"}}'
{
    "Arn": "arn:aws:dataexchange:us-east-1:123456789012:jobs/$JOB_ID",
    "CreatedAt": "2021-09-11T00:38:19.875000+00:00",
    "Details": {
        "ImportAssetFromApiGatewayApi": {
            "ApiId": "$API_ID",
            "DataSetId": "$DATA_SET_ID",
            "ProtocolType": "REST",
            "RevisionId": "$REVISION_ID",
            "Stage": "$API_STAGE"
        }
    },
    "Id": "$JOB_ID",
    "State": "WAITING",
    "Type": "IMPORT_ASSET_FROM_API_GATEWAY_API",
    "UpdatedAt": "2021-09-11T00:38:19.875000+00:00"
}

$ AWS dataexchange start-job --job-id $JOB_ID
$ AWS dataexchange get-job --job-id $JOB_ID
{
    "Arn": "arn:aws:dataexchange:us-east-1:0123456789012:jobs/$JOB_ID",
    "CreatedAt": "2021-09-11T00:38:19.875000+00:00",
    "Details": {
        "ImportAssetFromApiGatewayApi": {
            "ApiId": "$API_ID",
            "DataSetId": "$DATA_SET_ID",
            "ProtocolType": "REST",
            "RevisionId": "$REVISION_ID",
            "Stage": "$API_STAGE"
            "ApiEndpoint": "string",
            "ApiKey": "string",
            "ApiName": "string",            
            "ApiDescription": "string",
            "ApiSpecificationDownloadUrl": "string",
            "ApiSpecificationDownloadUrlExpiresAt": "string"
        }
    },
    "Id": "$JOB_ID",
    "State": "COMPLETED",
    "Type": "IMPORT_ASSET_FROM_API_GATEWAY_API",
    "UpdatedAt": "2021-09-11T00:38:52.538000+00:00"
}

Verwenden Sie den list-revision-assets Befehl, um zu bestätigen, dass das neue Asset ordnungsgemäß erstellt wurde:

$ AWS dataexchange list-revision-assets \
  --data-set-id $DATA_SET_ID \
  --revision-id $REVISION_ID
{
    "Assets": [
    {
        "Arn": "arn:aws:dataexchange:us-east-1:123456789012:data-sets/$DATA_SET_ID/revisions/$REVISION_ID/assets/$ASSET_ID",
        "AssetDetails": {
            "ApiGatewayApiAsset": {
                "ApiEndpoint": "https://$API_ID.execute-api.us-east-1.amazonaws.com/$API_STAGE",
                "ApiId": "$API_ID",
                "ProtocolType": "REST",
                "Stage": "$API_STAGE"
            }
        },
        "AssetType": "API_GATEWAY_API",
        "CreatedAt": "2021-09-11T00:38:52.457000+00:00",
        "DataSetId": "$DATA_SET_ID",
        "Id": "$ASSET_ID",
        "Name": "$ASSET_ID/$API_STAGE",
        "RevisionId": "$REVISION_ID",
        "UpdatedAt": "2021-09-11T00:38:52.457000+00:00"
    }
    ]
}

Wählen De-finalize Sie in der Revisionsübersicht.

Sie erhalten eine Meldung, dass sich die Revision nicht mehr im finalisierten Zustand befindet.

Um die Revision zu bearbeiten, wählen Sie in der Revisionsübersicht die Option Aktionen > Bearbeiten aus.

Nehmen Sie Ihre Änderungen vor und wählen Sie dann Aktualisieren.

Überprüfe deine Änderungen und wähle dann Finalisieren.

Wählen Sie in der Revisionsübersicht Löschen aus.

Geben Sie den Text Delete in das Dialogfeld Revision löschen ein, und wählen Sie dann Löschen.

Wählen Sie im linken Navigationsbereich der AWS Data Exchange Konsole unter Daten veröffentlichen die Option Produkte aus.

Wählen Sie unter Produkte die Option Neues Produkt veröffentlichen aus, um den Assistenten zur Veröffentlichung neuer Produkte zu öffnen.

Unter Sichtbarkeit des Produkts:

1. Wählen Sie für die Sichtbarkeitsoptionen Ihres Produkts entweder Öffentlich oder Privat aus.

   Für alle AWS Data Exchange Produkte, für die die Sichtbarkeit auf Öffentlich gesetzt ist, ist ein öffentliches Angebot erforderlich.

   Weitere Informationen finden Sie unter Sichtbarkeit des Produkts in AWS Data Exchange.

2. Wählen Sie die Konfiguration für vertrauliche Informationen Ihres Produkts.

   Weitere Informationen finden Sie unter Vertrauliche Informationskategorien in AWS Data Exchange.

3. Wählen Sie Weiter aus.

Unter Daten hinzufügen:

1. Markieren Sie unter Eigene Datensätze die Kontrollkästchen neben den Datensätzen, die Sie hinzufügen möchten, und wählen Sie dann Ausgewählte hinzufügen aus.

   Anmerkung

   Die ausgewählten Datensätze müssen eine endgültige Revision haben. Datensätze ohne finalisierte Revisionen werden nicht hinzugefügt.

2. Gehen Sie zu Ausgewählte Datensätze, um Ihre Auswahl zu überprüfen.

   Sie können den Namen des Datensatzes, den Typ des Datensatzes und den Zeitstempel der letzten Aktualisierung des Datensatzes überprüfen.

3. Gehen Sie zu Zugriffsregeln für Revisionen auswählen und wählen Sie die Revisionszugriffsregeln aus, die Sie für die in diesem Produkt enthaltenen Datensätze festlegen möchten.

   Weitere Informationen finden Sie unter Überarbeitung der Zugriffsregeln in AWS Data Exchange.

4. Wählen Sie Weiter aus.

Unter Produkt definieren:

1. Geben Sie unter Produktübersicht Informationen zu Ihrem Produkt ein, einschließlich des Produktnamens, des Produktlogos, der Support-Kontaktinformationen und der Produktkategorien.

   Weitere Informationen finden Sie unter Bewährte Produktpraktiken in AWS Data Exchange.

2. (Optional) Wählen Sie unter Datenwörterbücher und Beispiele — optional einen Datensatz aus, indem Sie auf das Optionsfeld neben dem Namen des Datensatzes klicken und dann Bearbeiten auswählen.

   1. Wählen Sie im Dialogfeld „Bearbeiten“ die Option „Hochladen“, um ein neues Datenwörterbuch hochzuladen.

      Sie können ein Datenwörterbuch im CSV-Format mit einer maximalen Größe von 1 MB auswählen.

   2. Wählen Sie ein gespeichertes Datenwörterbuch von Ihrem Computer aus und klicken Sie dann auf Öffnen.

      Die CSV-Datei mit dem Datenwörterbuch wird im Dialogfeld „Bearbeiten“ angezeigt.

      Anmerkung

      Ihr Datenwörterbuch muss der AWS Data Exchange Datenwörterbuchvorlage entsprechen. Wenn Sie kein gespeichertes Datenwörterbuch zum Hochladen haben, können Sie in der AWS Data Exchange Konsole entweder den Link zur leeren Datenwörterbuchvorlage oder den Beispiel-Datenwörterbuch-Link wählen.

   3. Wählen Sie Datenwörterbuchvorschau, um eine Vorschau des Datenwörterbuches anzuzeigen.

   4. Wählen Sie unter Beispiele — optional die Option Muster hochladen aus, wählen Sie eine Probe von Ihrem Computer aus und wählen Sie dann Öffnen aus.

      Die Proben werden im Dialogfeld „Bearbeiten“ angezeigt.

      Anmerkung

      Sie können bis zu 10 Samples mit einer maximalen Größe von 50 MB hochladen. Proben im CSV-Format können in der Vorschau angezeigt werden.

   5. Geben Sie für jedes Muster eine Beschreibung ein, die auf der Produktdetailseite angezeigt wird.

   6. Wählen Sie Speichern.

Geben Sie unter Produktdefinition eine Kurzbeschreibung und eine ausführliche Beschreibung Ihres Produkts ein.

Wenn Sie eine Vorlage für Ihre ausführliche Beschreibung verwenden möchten, wählen Sie Vorlage anwenden aus, wählen Sie Ihren Vorlagentyp aus und füllen Sie dann die Vorlage mit Ihren spezifischen Produktdetails aus.

Wählen Sie Weiter aus.

Konfiguriere dein Angebot entweder in Öffentliches Angebot hinzufügen (für öffentliches Angebot) oder Benutzerdefiniertes Angebot hinzufügen (für private Angebote):

Für alle AWS Data Exchange Produkte, für die Sichtbarkeit auf Öffentlich gesetzt ist, ist ein öffentliches Angebot erforderlich.

1. Nur für private Angebote:

   1. Wählen Sie eine der aufgeführten Angebotstypen: Privatangebot, Erneuertes Privatangebot oder Bring Your Own Subscription (BYOS).

   2. Fügen Sie im Abschnitt Informationen zum Abonnentenkonto mindestens ein Abonnentenkonto hinzu, auf das Sie das Angebot verlängern möchten.

2. Wählen Sie Ihre Optionen für Preise und Zugriffsdauer für das Abonnement.

3. Wählen Sie unter Kostenberechnung — optional die Option Hinzufügen aus.

   1. Wählen Sie für Gebührenpflichtige Kosten hinzufügen die Art der Kosten für den API-Aufruf aus der Typliste aus:

      • Pro API-Anfrage

      • Pro erfolgreicher API-Anfrage

      • Pro übertragener Dateneinheit in Byte

      • Neue, nach Kundenangaben berechnete Kosten

   2. Geben Sie den Anzeigenamen für die Kosten ein, der auf der Rechnung des Abonnenten sichtbar ist, oder aktualisieren Sie ihn.

   3. Wenn du einen Pre-defined Kostenvoranschlag verwendest, wird der Schlüssel automatisch generiert, kann nicht bearbeitet werden und muss nicht im Antwort-Header zurückgesendet werden.

   4. Wenn Sie einen neuen benutzerdefinierten Kostenpunkt erstellen, geben Sie den Schlüssel ein. Dabei handelt es sich um die Kennung für die gemessenen Kosten im API-Antwort-Header (maximal 15 Zeichen).

      Dieser Schlüssel sollte als Teil des x-amz-dataexchange-metering Antwort-Headers zurückgesendet werden.

      Beispiel Benutzerdefinierter Schlüssel

      Wenn Sie einen benutzerdefinierten Schlüssel VertexCount und einen anderen benutzerdefinierten Schlüssel aufgerufen habenEdgeCount, könnte der Antwort-Header „x-amz-dataexchange-metering“ den Wert von haben, VertexCount=3,EdgeCount=10 oder Sie könnten zwei separate Header-Zeilen zurückgeben:

      x-amz-dataexchange-metering: VertextCount=3

      x-amz-dataexchange-metering: EdgeCount=10

   5. Geben Sie im Feld Preis /Einheit den Preis ein, der dem Abonnenten pro Einheit berechnet wird.

   6. (Optional) Geben Sie die Anzahl der Einheiten ein, um ein Beispiel für die Kosten im Gebührenrechner anzuzeigen.

   7. (Optional) Geben Sie eine kurze Beschreibung der berechneten Kosten ein, die auf der Produktdetailseite angezeigt wird.

   8. Wählen Sie Hinzufügen aus.

   9. (Optional) Wiederholen Sie den Vorgang, um weitere berechnete Kosten hinzuzufügen. 

      Die Reihenfolge der berechneten Kosten wird auf der Produktdetailseite angezeigt. Sie können sie nicht nachbestellen.

      Anmerkung

      Nachdem das Angebot erstellt wurde, kannst du den Preis und die Beschreibung der berechneten Kosten bearbeiten. Weitere Informationen finden Sie unter Aktualisierung der Produkt- und Angebotsdetails in AWS Data Exchange.

4. Wählen Sie nur für private Angebote das Ablaufdatum des Angebots, bis zu dem der Abonnent das Angebot annehmen muss.

5. Wählen Sie Ihre Steuereinstellungen, den Datenabonnementvertrag (DSA) und Ihre Rückerstattungsrichtlinie.

6. (Optional) Stellen Sie nur für öffentliche Angebote die Abonnementüberprüfung ein, mit der Sie kontrollieren können, wer dieses Produkt abonnieren kann. Weitere Informationen finden Sie unter Abonnementüberprüfung für Anbieter in AWS Data Exchange.

7. Wählen Sie Ihre Option zur automatischen Verlängerung. Weitere Informationen finden Sie unter Ein Angebot für AWS Data Exchange Produkte erstellen.

8. Wählen Sie Weiter aus.

Überprüfen Sie im Abschnitt Überprüfen und veröffentlichen Ihre Produktinformationen.

1. Erweitern Sie die Vorschau der Produktseite, um zu sehen, wie die Produktseite nach der Veröffentlichung aussehen wird.

2. (Optional) Wählen Sie in einem beliebigen Abschnitt die Schaltfläche „Bearbeiten“, um diesen Abschnitt zu bearbeiten.

Wenn Sie sicher sind, dass Sie das Produkt und das öffentliche Angebot für alle sichtbar und verfügbar machen möchten, wählen Sie Veröffentlichen.

Öffnen Sie Ihren Webbrowser und melden Sie sich bei der AWS Data Exchange Konsole an.

Wählen Sie im linken Navigationsbereich unter Daten veröffentlichen die Option Produkte aus.

Wählen Sie unter Produkte die Schaltfläche neben dem Produkt aus, das Sie kopieren möchten.

Wählen Sie das Drop-down-Menü Aktionen aus und wählen Sie dann Kopie erstellen aus.

Fahren Sie mit dem Workflow „Neues Produkt veröffentlichen“ fort, wobei die Details bereits ausgefüllt sind, basierend auf dem Produkt, das Sie in Schritt 3 ausgewählt haben. Weitere Informationen finden Sie unter Schritt 5: Veröffentlichen Sie ein neues Produkt.