Creazione di una concessione di dati sul contenimento AWS Data Exchange APIs

Aggiungi la seguente politica alla politica delle risorse della tua API:

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

Sostituiscila account-id con l'account che creerà il set di dati dell'API.

Non è necessario che l'account con la risorsa API Gateway si trovi nello stesso account che sta creando il set di dati.

Apri il browser web e accedi alla AWS Data Exchange console.

Nel riquadro di navigazione a sinistra, in I miei dati, scegli Set di dati di proprietà.

In Set di dati di proprietà, scegli Crea set di dati per aprire la procedura guidata di creazione dei set di dati.

In Seleziona il tipo di set di dati, scegli l'API Amazon API Gateway.

In Definisci set di dati, inserisci un nome e una descrizione per il set di dati. Per ulteriori informazioni, consulta Le migliori pratiche relative ai set di dati.

(Facoltativo) In Aggiungi tag: facoltativo, aggiungi tag.

Scegli Create (Crea) .

Usa il create-data-set comando per creare un set di dati API:

$ 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"
}

Nota il nuovo tipo di risorsa diAPI_GATEWAY_API.

Nella sezione Panoramica del set di dati della pagina dei dettagli del set di dati:

1. (Facoltativo) Scegliete Modifica nome per modificare le informazioni sul set di dati.

2. (Facoltativo) Scegliete Elimina per eliminare il set di dati.

Nella sezione Revisioni, scegli Crea revisione.

In Definisci revisione, fornisci un commento facoltativo per la revisione che descriva lo scopo della revisione.

(Facoltativo) In Aggiungi tag: facoltativo, aggiungi i tag associati alla risorsa.

Scegli Crea revisione.

Rivedi, modifica o elimina le modifiche del passaggio precedente.

Utilizzate il create-revision comando per creare una revisione:

$ 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"
}

Aggiungi le risorse API alla revisione.

Nella sezione Risorse API della pagina dei dettagli del set di dati, scegli Aggiungi fase API.

Nella fase Seleziona API, per l'API Amazon API Gateway, inserisci un'API nella casella di input o scegli una delle seguenti opzioni dall'elenco a discesa:

1. Se hai scelto API in un altro campo Account AWS, inserisci l'ID API e il nome della fase API nelle caselle di input.

2. Se hai scelto In questo campo Account AWS, scegli il nome dell'API Stage dall'elenco a discesa

In Configurazione avanzata, opzionale, puoi scegliere di collegare il piano di utilizzo esistente di Amazon API Gateway per utilizzare i limiti di limitazione e quota definiti nel piano di utilizzo esistente e inserire la chiave API.

In Document API per abbonati, fornisci i dettagli sull'API che i destinatari vedranno dopo aver accettato la concessione dei dati.

1. Per il nome dell'API, inserisci un nome che i destinatari possano utilizzare per identificare la risorsa API.

   Nota

   Se Account AWSè stato selezionato un In this, il nome dell'API viene compilato automaticamente, e potete modificarlo se necessario.

   Se Account AWSè stata selezionata un'API in un'altra, il nome dell'API viene compilato con un nome predefinito, che è necessario modificare in modo che il destinatario possa capire facilmente di cosa si tratta.

2. Per le specifiche di OpenAPI 3.0, puoi:

   1. Inserisci o copia e incolla il file delle specifiche OpenAPI 3.0.

   2. Scegliete Importa dal file.JSON, quindi selezionate il file.json dal computer locale da importare.

      La specifica importata viene visualizzata nella casella.

   3. Scegli Importa da Amazon API Gateway, quindi scegli una specifica da importare.

      La specifica importata viene visualizzata nella casella.

3. Per la documentazione aggiuntiva, facoltativa, inserisci tutte le informazioni aggiuntive utili per consentire all'abbonato di conoscere la tua API. Markdown è supportato.

Scegliete la fase Aggiungi API.

Viene avviato un processo per importare la risorsa (in questo caso, l'API) nel set di dati.

Al termine del lavoro, il campo Stato nella sezione Lavori viene aggiornato a Completato.

Se hai altro APIs da aggiungere, ripeti il passaggio 2.

Nella sezione Panoramica delle revisioni, esamina la revisione e le relative risorse.

Scegli Finalizza.

Utilizzate il create-job comando per aggiungere risorse API alla revisione:

$ 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"
}

Utilizzate il list-revision-assets comando per confermare che la nuova risorsa è stata creata correttamente:

$ 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"
    }
    ]
}

Nella panoramica delle revisioni, scegli De-finalizza.

Viene visualizzato un messaggio che indica che la revisione non è più nello stato di completamento.

Per modificare la revisione, da Panoramica delle revisioni, scegli Azioni, Modifica.

Apporta le modifiche, quindi scegli Aggiorna.

Controlla le modifiche, quindi scegli Finalizza.

Nella panoramica delle revisioni, scegli Elimina.

Digitate Delete nella finestra di dialogo Elimina revisione, quindi scegliete Elimina.

Nel riquadro di navigazione a sinistra della AWS Data Exchange console, in Concessioni dati scambiate, scegli Concessioni dati inviate.

Da Concessioni dati inviate, scegli Crea concessione dati per aprire la procedura guidata Definisci concessione dati.

Nella sezione Seleziona il set di dati di proprietà, seleziona la casella di controllo accanto al set di dati che desideri aggiungere.

Nella sezione Panoramica della concessione, inserisci le informazioni che il destinatario vedrà sulla concessione dei dati, inclusi il nome della concessione dei dati e la descrizione della concessione dei dati.

Scegli Avanti.

Nella sezione Informazioni di accesso al destinatario, in Account AWS ID, inserisci l' Account AWS ID dell'account del destinatario che dovrebbe ricevere la concessione dei dati.

Inoltre, nella sezione Informazioni di accesso al destinatario, in Data di fine accesso, scegli se la concessione dei dati deve essere eseguita in modo perpetuo, selezionando Nessuna data di fine o se deve avere una data di fine, selezionando Data di fine specifica e scegliendo la data di fine desiderata.

Scegli Next (Successivo).

Nella sezione Revisione e invio, esamina le informazioni sulla concessione dei dati.

Se sei sicuro di voler creare la concessione di dati e inviarla al destinatario scelto, scegli Crea e invia la concessione di dati.