Pubblicazione di un prodotto in AWS Data Exchange contenente API

Aggiungi la seguente politica alla politica sulle 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 API.

L'account con la risorsa API Gateway non deve necessariamente appartenere allo 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 per la creazione dei set di dati.

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

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

(Facoltativo) In Aggiungi tag — opzionale, aggiungi tag.

Scegli 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) Scegli Modifica nome per modificare le informazioni sul set di dati.

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

Nella sezione Revisioni, scegli Crea revisione.

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

(Facoltativo) In Aggiungi tag — opzionale, aggiungi i tag associati alla risorsa.

Scegli Crea revisione.

Rivedi, modifica o elimina le modifiche apportate al passaggio precedente.

Usa 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.

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

1. Se hai scelto API in un'altra Account AWS, inserisci l'ID API e il nome dello stage dell'API nelle caselle di input.

2. Se hai scelto In questo Account AWS, scegli il nome della fase API dall'elenco a discesa

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

In Document API for subscribers, fornisci dettagli sull'API che gli abbonati vedranno dopo la sottoscrizione al tuo prodotto.

1. Per il nome dell'API, inserisci un nome che gli abbonati possano utilizzare per identificare l'asset API.

   Nota

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

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

2. Per la specifica OpenAPI 3.0, puoi:

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

   2. Scegli Importa da file .JSON, quindi seleziona il file .json dal tuo 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 Documentazione aggiuntiva, facoltativa, inserisci qualsiasi informazione aggiuntiva utile all'abbonato per conoscere la tua API. Markdown è supportato.

Scegli Aggiungi fase 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 in Completato.

Se hai altre API da aggiungere, ripeti il passaggio 2.

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

Scegli Finalizza.

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

Usa 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-finalize

Viene visualizzato un messaggio indicante che la revisione non è più in stato di completamento.

Per modificare la revisione, dalla panoramica delle revisioni, scegli Azioni, Modifica.

Apporta le modifiche, quindi scegli Aggiorna.

Rivedi le modifiche e scegli Finalizza.

Nella panoramica delle revisioni, scegli Elimina.

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

Dal riquadro di navigazione sinistro della AWS Data Exchange console, in Pubblica dati, scegli Prodotti.

Da Prodotti, scegli Pubblica nuovo prodotto per aprire la procedura guidata Pubblica nuovo prodotto.

In Visibilità del prodotto:

1. Scegli le opzioni di visibilità del prodotto tra Pubbliche o Private.

   Tutti i AWS Data Exchange prodotti con visibilità impostata su Pubblico richiedono un'offerta pubblica.

   Per ulteriori informazioni, consulta Visibilità del prodotto in AWS Data Exchange.

2. Scegli la configurazione delle informazioni sensibili del tuo prodotto.

   Per ulteriori informazioni, consulta Categorie di informazioni sensibili in AWS Data Exchange.

3. Scegli Avanti.

In Aggiungi dati:

1. In Set di dati di proprietà, seleziona le caselle di controllo accanto ai set di dati che desideri aggiungere, quindi scegli Aggiungi selezionato.

   Nota

   I set di dati scelti devono avere una revisione definitiva. I set di dati senza revisioni finalizzate non vengono aggiunti.

2. Vai a Set di dati selezionati per rivedere le tue selezioni.

   È possibile visualizzare il nome del set di dati, il tipo di set di dati e il timestamp dell'ultimo aggiornamento del set di dati.

3. Vai a Seleziona le regole di accesso alle revisioni e scegli le regole di accesso alle revisioni che desideri impostare per i set di dati inclusi in questo prodotto.

   Per ulteriori informazioni, consulta Revisione delle regole di accesso in AWS Data Exchange.

4. Scegli Avanti.

In Definisci prodotto:

1. In Panoramica del prodotto, inserisci le informazioni sul tuo prodotto, tra cui il nome del prodotto, il logo del prodotto, le informazioni di contatto dell'assistenza e le categorie di prodotti.

   Per ulteriori informazioni, consulta Le migliori pratiche di prodotto in AWS Data Exchange.

2. (Facoltativo) In Dizionari ed esempi di dati: opzionale, scegli un set di dati selezionando il pulsante di opzione accanto al nome del set di dati, quindi scegli Modifica.

   1. Nella finestra di dialogo Modifica, scegli Carica per caricare un nuovo dizionario di dati.

      Puoi scegliere un dizionario di dati, in formato .csv, con una dimensione massima di 1 MB.

   2. Scegli un dizionario di dati salvato dal tuo computer, quindi scegli Apri.

      Il file .csv del dizionario dati viene visualizzato nella finestra di dialogo Modifica.

      Nota

      Il dizionario dati deve essere conforme al modello di dizionario AWS Data Exchange dati. Se non hai un dizionario dati salvato da caricare, puoi scegliere il link vuoto al modello di dizionario dati o il link del dizionario dati di esempio nella AWS Data Exchange console.

   3. Scegli Anteprima del dizionario dati per visualizzare l'anteprima del dizionario dati.

   4. In Esempi - opzionale, scegli Carica campioni, scegli un campione dal tuo computer, quindi scegli Apri.

      Gli esempi vengono visualizzati nella finestra di dialogo Modifica.

      Nota

      Puoi caricare fino a 10 campioni con una dimensione massima di 50 MB. Gli esempi in formato .csv possono essere visualizzati in anteprima.

   5. Inserisci una descrizione per ogni campione che sarà visibile nella pagina dei dettagli del prodotto.

   6. Selezionare Salva.

In Definizione del prodotto, inserisci una breve descrizione e una descrizione lunga del prodotto.

Se desideri utilizzare un modello per la descrizione dettagliata, seleziona Applica modello, scegli il tipo di modello e compila il modello con i dettagli specifici del prodotto.

Scegli Avanti.

Configura la tua offerta in Aggiungi offerta pubblica (per offerta pubblica) o Aggiungi offerta personalizzata (per offerte private):

Tutti i AWS Data Exchange prodotti con visibilità impostata su Pubblico richiedono un'offerta pubblica.

1. Solo per le offerte private:

   1. Scegli uno dei tipi di offerta elencati: Offerta privata, Offerta privata rinnovata o BYOS (Bring Your Own Subscription).

   2. Nella sezione Informazioni sull'account dell'abbonato, aggiungi almeno un account abbonato a cui desideri estendere l'offerta.

2. Scegli le opzioni relative ai prezzi e alla durata dell'accesso per l'abbonamento.

3. Per i costi a pagamento, facoltativo, scegli Aggiungi.

   1. Per Aggiungi costo a consumo, seleziona il tipo di costo per la chiamata API dall'elenco Tipo:

      • Per richiesta API

      • Per richiesta API andata a buon fine

      • Per unità di dati trasferita in byte

      • Nuovo costo misurato personalizzato

   2. Inserisci o aggiorna il nome visualizzato del costo, visibile sulla fattura dell'abbonato.

   3. Se utilizzi un costo Pre-defined misurato, la chiave viene generata automaticamente, non può essere modificata e non deve essere rispedita nell'intestazione della risposta.

   4. Se stai creando un nuovo costo misurato personalizzato, inserisci la chiave, che è l'identificatore del costo misurato nell'intestazione della risposta API (massimo 15 caratteri).

      Questa chiave deve essere restituita come parte dell'intestazione della risposta. x-amz-dataexchange-metering

      Esempio Chiave personalizzata

      Se hai una chiave personalizzata chiamata VertexCount e un'altra chiave personalizzata chiamataEdgeCount, l'intestazione di risposta «x-amz-dataexchange-metering» potrebbe avere un valore pari o potresti restituire due righe di intestazione separate: VertexCount=3,EdgeCount=10

      x-amz-dataexchange-metering: VertextCount=3

      x-amz-dataexchange-metering: EdgeCount=10

   5. Inserisci il prezzo unitario che viene addebitato all'abbonato in Prezzo/unità.

   6. (Facoltativo) Inserisci il numero di unità per visualizzare un esempio del costo nel calcolatore dei costi misurati.

   7. (Facoltativo) Inserisci una breve descrizione del costo misurato che appare nella pagina dei dettagli del prodotto.

   8. Scegliere Aggiungi.

   9. (Facoltativo) Ripetere l'operazione per aggiungere costi contabilizzati aggiuntivi. 

      L'ordine dei costi misurati viene visualizzato nella pagina dei dettagli del prodotto. Non puoi riordinarli.

      Nota

      Dopo aver creato l'offerta, puoi modificare il prezzo e la descrizione di un costo misurato. Per ulteriori informazioni, consulta Aggiornamento dei dettagli del prodotto e dell'offerta in AWS Data Exchange.

4. Solo per le offerte private, scegli la data di scadenza dell'offerta entro la quale l'abbonato deve accettare l'offerta.

5. Scegli le impostazioni fiscali, il contratto di sottoscrizione dei dati (DSA) e la politica di rimborso.

6. (Facoltativo) Solo per le offerte pubbliche, imposta la verifica dell'abbonamento, che ti consente di controllare chi può abbonarsi a questo prodotto. Per ulteriori informazioni, consulta Verifica dell'abbonamento per i fornitori di AWS Data Exchange.

7. Scegli l'opzione di rinnovo automatico dell'offerta. Per ulteriori informazioni, consulta Creazione di un'offerta di AWS Data Exchange prodotti.

8. Scegli Avanti.

Nella sezione Rivedi e pubblica, rivedi le informazioni sul prodotto.

1. Espandi l'anteprima della pagina del prodotto per vedere come apparirà la pagina del prodotto dopo la pubblicazione.

2. (Facoltativo) Scegli il pulsante Modifica in qualsiasi sezione per modificare quella sezione.

Se sei sicuro di voler rendere il prodotto e l'offerta pubblica visibili e disponibili per tutti, scegli Pubblica.

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

Dal riquadro di navigazione a sinistra, in Pubblica dati, scegli Prodotti.

Da Prodotti, scegli il pulsante accanto al prodotto che desideri copiare.

Seleziona il menu a discesa Azioni, quindi scegli Crea copia.

Continua con il flusso di lavoro Pubblica un nuovo prodotto, con i dettagli già compilati, in base al prodotto scelto nel passaggio 3. Per ulteriori informazioni, consulta Fase 5: Pubblica un nuovo prodotto.