Einen Datenzuschuss erstellen am 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 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 aus

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 Einzelheiten zur API an, die den Empfängern angezeigt wird, nachdem sie die Datengewährung akzeptiert haben.

1. Geben Sie als API-Name einen Namen ein, den Empfänger 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 Empfänger 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 Exchanged data grants die Option Send data grants aus.

Wählen Sie unter Gesendete Datengewährung die Option Datengewährung erstellen aus, um den Assistenten zum Definieren von Datengewährungen zu öffnen.

Aktivieren Sie im Abschnitt Eigenen Datensatz auswählen das Kontrollkästchen neben dem Datensatz, den Sie hinzufügen möchten.

Geben Sie im Abschnitt Förderübersicht Informationen ein, die der Empfänger zu Ihrer Datengewährung sehen wird, einschließlich des Namens der Datengewährung und der Beschreibung der Datengewährung.

Wählen Sie „Weiter“.

Geben Sie im Abschnitt Zugangsinformationen für Empfänger unter AWS-Konto ID die AWS-Konto ID des Empfängerkontos ein, das die Datengewährung erhalten soll.

Wählen Sie außerdem im Abschnitt Zugangsinformationen zum Empfänger unter Zugriffsenddatum aus, ob die Datengewährung unbefristet laufen soll. Wählen Sie Kein Enddatum aus oder ob sie ein Enddatum haben soll, wählen Sie Spezifisches Enddatum und dann das gewünschte Enddatum aus.

Wählen Sie Weiter aus.

Überprüfen Sie im Abschnitt Prüfen und Senden die Informationen zur Datengewährung.

Wenn Sie sicher sind, dass Sie die Datengewährung erstellen und an den ausgewählten Empfänger senden möchten, wählen Sie „Datengewährung erstellen und senden“.