Membuat hibah data pada AWS Data Exchange berisi API

Tambahkan kebijakan berikut ke kebijakan sumber daya API Anda:

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

Ganti account-id dengan akun yang akan membuat kumpulan data API.

Akun dengan sumber daya API Gateway tidak perlu berada di akun yang sama yang membuat kumpulan data.

Buka browser web Anda dan masuk ke AWS Data Exchange konsol.

Di panel navigasi sisi kiri, di bawah Data saya, pilih Kum pulan data yang dimiliki.

Di Kumpulan data yang dimiliki, pilih Buat kumpulan data untuk membuka panduan langkah pembuatan kumpulan data.

Di Pilih jenis kumpulan data, pilih API Gateway API Amazon.

Di Tentukan kumpulan data, masukkan Nama dan Deskripsi untuk kumpulan data Anda. Untuk informasi selengkapnya, lihat Praktik terbaik kumpulan data.

(Opsional) Di bawah Tambahkan tag - opsional, tambahkan tag.

Pilih Buat.

Gunakan create-data-set perintah untuk membuat kumpulan data 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"
}

Perhatikan Jenis Aset baruAPI_GATEWAY_API.

Pada bagian ik htisar kumpulan data pada halaman detail kumpulan data:

1. (Opsional) Pilih Edit nama untuk mengedit informasi tentang kumpulan data Anda.

2. (Opsional) Pilih Hapus untuk menghapus kumpulan data.

Pada bagian Revisi, pilih Buat revisi.

Di bawah T entukan revisi, berikan komentar opsional untuk revisi Anda yang menjelaskan tujuan revisi.

(Opsional) Di bawah Tambah tag — opsional, tambahkan tag yang terkait dengan sumber daya.

Pilih Buat revisi.

Tinjau, edit, atau hapus perubahan Anda dari langkah sebelumnya.

Gunakan create-revision perintah untuk membuat revisi:

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

Tambahkan aset API ke revisi.

Di bawah bagian aset API pada halaman detail kumpulan data, pilih Add API stage.

Di bawah Sel ect API stage, untuk Amazon API Gateway API API, masukkan API di kotak input atau pilih salah satu dari berikut ini dari daftar drop-down:

1. Jika Anda memilih API di yang lain Akun AWS, masukkan ID API dan nama Panggung API di kotak input.

2. Jika Anda memilih Dalam hal ini Akun AWS, pilih nama Panggung API dari daftar drop-down

Di bawah Konfigurasi lanjutan — opsional, Anda dapat memilih untuk Menghubun gkan paket penggunaan Amazon API Gateway yang ada untuk menggunakan batas pembatasan dan kuota seperti yang ditentukan dalam paket penggunaan yang ada, dan memasukkan kunci API.

Di bawah API Dokumen untuk pelanggan, berikan detail tentang API yang akan dilihat penerima setelah mereka menerima hibah data.

1. Untuk nama API, masukkan nama yang dapat digunakan penerima untuk mengidentifikasi aset API.

   catatan

   Jika Dalam hal ini Akun AWS dipilih, nama API secara otomatis diisi, yang dapat Anda modifikasi jika perlu.

   Jika API di API lain Akun AWS dipilih, nama API diisi dengan nama default, yang harus Anda modifikasi sehingga penerima dapat dengan mudah memahami apa itu.

2. Untuk spesifikasi OpenAPI 3.0, salah satunya:

   1. Masukkan atau salin dan tempel file spesifikasi OpenAPI 3.0.

   2. Pilih Impor dari file.JSON, lalu pilih file.json dari komputer lokal Anda untuk diimpor.

      Spesifikasi yang diimpor muncul di kotak.

   3. Pilih Impor dari Amazon API Gateway, lalu pilih spesifikasi untuk diimpor.

      Spesifikasi yang diimpor muncul di kotak.

3. Untuk Dokumentasi tambahan - opsional, masukkan informasi tambahan apa pun yang berguna bagi pelanggan untuk mengetahui tentang API Anda. Markdown didukung.

Pilih Add API stage.

Pekerjaan dimulai untuk mengimpor aset Anda (dalam hal ini, API) ke kumpulan data Anda.

Setelah pekerjaan selesai, bidang Status di bagian Pekerjaan diperbarui ke Sel esai.

Jika Anda memiliki lebih banyak API untuk ditambahkan, ulangi Langkah 2.

Di bawah Tinjauan Rev isi, tinjau revisi Anda dan asetnya.

Pilih Finalize.

Gunakan create-job perintah untuk menambahkan aset API ke revisi:

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

Gunakan list-revision-assets perintah untuk mengonfirmasi bahwa aset baru dibuat dengan benar:

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

Pada ikh tisar Rev isi, pilih De-finalize.

Anda melihat pesan bahwa revisi tidak lagi dalam keadaan selesai.

Untuk mengedit revisi, dari Ikhtis ar revisi, pilih T indakan, Edit.

Buat perubahan Anda, lalu pilih Per barui.

Tinjau perubahan Anda dan kemudian pilih Finalize.

Pada ikh tisar Rev isi, pilih Hapus.

K Delete etik kotak dialog H apus revisi, lalu pilih H apus.

Di panel navigasi kiri AWS Data Exchange konsol, di bawah Hibah data yang diper tukarkan, pilih Hi bah data terkirim.

Dari hibah data terki rim, pilih Buat hibah data untuk membuka wizard Definisikan hibah data.

Di bagian Pilih kum pulan data yang dimiliki, pilih kotak centang di sebelah kumpulan data yang ingin Anda tambahkan.

Di bagian Ringkasan Hibah, masukkan informasi yang akan dilihat penerima mengenai hibah data Anda, termasuk nama hibah data, dan deskripsi hibah data.

Pilih Berikutnya.

Di bagian Informasi akses Penerima, di bawah Akun AWS ID, masukkan Akun AWS ID akun penerima yang harus menerima hibah data.

Juga, di bagian Informasi akses penerima, di bawah Tanggal akhir Akses, pilih apakah pemberian data harus berjalan selamanya, pilih Tidak ada tanggal akhir, atau jika harus memiliki tanggal akhir, pilih Tanggal akhir tertentu, dan pilih tanggal akhir yang diinginkan.

Pilih Berikutnya.

Di bagian T injau dan kirim, tinjau informasi hibah data Anda.

Jika Anda yakin ingin membuat hibah data dan mengirimkannya ke penerima yang dipilih, pilih Buat dan kirim hibah data.