Menerbitkan produk di 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 pelanggan setelah mereka berlangganan produk Anda.

1. Untuk nama API, masukkan nama yang dapat digunakan pelanggan 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 pelanggan 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.

Dari panel navigasi kiri AWS Data Exchange konsol, di bawah Publi kasikan data, pilih Produk.

Dari Produk, pilih Publikasikan produk baru untuk membuka wizard Publikasikan produk baru.

Dalam visibilitas Produk:

1. Pilih opsi visibilitas produk Anda sebagai Pu blik atau Pri badi.

   Semua AWS Data Exchange produk dengan visibilitas disetel ke Pu blik memerlukan penawaran umum.

   Untuk informasi selengkapnya, lihat Visibilitas produk di AWS Data Exchange.

2. Pilih konfigurasi informasi sensitif produk Anda.

   Untuk informasi selengkapnya, lihat Kategori informasi sensitif di AWS Data Exchange.

3. Pilih Berikutnya.

Di Tambahkan data:

1. Di bawah Kumpulan data yang dimiliki, pilih kotak centang di sebelah kumpulan data yang ingin Anda tambahkan, lalu pilih Tambahkan yang dipilih.

   catatan

   Kumpulan data yang Anda pilih harus memiliki revisi yang diselesaikan. Kumpulan data tanpa revisi selesai tidak ditambahkan.

2. Buka Kumpulan data yang dipilih untuk meninjau pilihan Anda.

   Anda dapat meninjau Nama kum pulan data, Jenis kum pulan data, dan stempel waktu kapan kumpulan data terakhir diperbarui.

3. Buka Pilih aturan akses revisi, dan pilih aturan akses revisi yang ingin Anda tetapkan untuk kumpulan data yang disertakan dalam produk ini.

   Untuk informasi selengkapnya, lihat Aturan akses revisi di AWS Data Exchange.

4. Pilih Berikutnya.

Dalam Definisikan produk:

1. Di bawah Ikhtisar produk, masukkan informasi tentang produk Anda, termasuk Nama Produk, Logo Produk, Informasi kontak Dukungan, dan Kategori Produk.

   Untuk informasi selengkapnya, lihat Praktik terbaik produk di AWS Data Exchange.

2. (Opsional) Di bawah Kamus data dan sampel — opsional, pilih kumpulan data dengan memilih tombol opsi di sebelah nama kumpulan data dan kemudian pilih Edit.

   1. Di kotak dialog Edit, pilih Ungg ah untuk mengunggah kamus data baru.

      Anda dapat memilih satu kamus data, dalam format.csv, dengan ukuran maksimum 1 MB.

   2. Pilih kamus data yang disimpan dari komputer Anda dan kemudian pilih Buka.

      File kamus data .csv muncul di kotak dialog Edit.

      catatan

      Kamus data Anda harus sesuai dengan template AWS Data Exchange kamus data. Jika Anda tidak memiliki kamus data yang disimpan untuk diunggah, Anda dapat memilih tautan templat kamus data kosong atau tautan kamus data contoh di AWS Data Exchange konsol.

   3. Pilih Pratinjau kamus data untuk melihat kamus data.

   4. Di bawah Sam pel - opsional, pilih Unggah sampel, pilih sampel dari komputer Anda, lalu pilih Buka.

      Sampel muncul di kotak dialog Edit.

      catatan

      Anda dapat mengunggah hingga 10 sampel dengan ukuran maksimum 50 MB. Sampel dalam format.csv dapat dipratinjau.

   5. Masukkan deskripsi untuk setiap sampel yang akan terlihat di halaman detail produk.

   6. Pilih Simpan.

Di bawah Definisi produk, masukkan deskripsi singkat dan deskripsi panjang produk Anda.

Jika Anda ingin menggunakan template untuk deskripsi panjang Anda, pilih Ter apkan template, pilih jenis templat Anda, lalu isi template dengan detail produk spesifik Anda.

Pilih Berikutnya.

Konfigurasikan penawaran Anda di Tambahkan penawaran umum (untuk penawaran umum) atau Tambahkan penawaran khusus (untuk penawaran pribadi):

Semua AWS Data Exchange produk dengan visibilitas disetel ke Pu blik memerlukan penawaran umum.

1. Hanya untuk penawaran pribadi:

   1. Pilih salah satu jenis Pen awaran yang tercantum: Pen awaran pribadi, Pen awaran pribadi yang diperbarui, atau B awa Langganan Anda Sendiri (BYOS).

   2. Di bagian Informasi akun Pelanggan, tambahkan setidaknya satu akun pelanggan yang ingin Anda perpanjang penawaran.

2. Pilih opsi Harga dan durasi akses untuk langganan.

3. Untuk Biaya terukur - opsional, pilih Tam bah.

   1. Untuk Tambahkan biaya ter ukur, pilih jenis biaya untuk panggilan API dari daftar Jenis:

      • Per permintaan API

      • Per permintaan API yang berhasil

      • Per unit data yang ditransfer dalam byte

      • Biaya meteran khusus baru

   2. Masukkan atau perbarui nama tampilan Biaya, yang terlihat pada faktur pelanggan.

   3. Jika Anda menggunakan biaya Pre-defined terukur, K unci dibuat secara otomatis, tidak dapat diedit, dan tidak perlu dikirim kembali di header respons.

   4. Jika Anda membuat biaya ter ukur kustom baru, masukkan K unci, yang merupakan pengidentifikasi untuk biaya terukur di header respons API (maksimum 15 karakter).

      K unci ini harus dikirim kembali sebagai bagian dari header x-amz-dataexchange-metering respons.

      contoh Kunci kustom

      Jika Anda memiliki kunci khusus yang dipanggil VertexCount dan kunci khusus lainnya dipanggilEdgeCount, header respons “x-amz-dataexchange-metering” dapat memiliki nilai VertexCount=3,EdgeCount=10 atau Anda dapat mengembalikan dua baris header terpisah:

      x-amz-dataexchange-metering: VertextCount=3

      x-amz-dataexchange-metering: EdgeCount=10

   5. Masukkan harga yang dikenakan pelanggan per unit dalam Harga/unit.

   6. (Opsional) Masukkan jumlah unit untuk menampilkan contoh biaya di kalkulator biaya terukur.

   7. (Opsional) Masukkan Deskripsi singkat tentang biaya terukur yang muncul di halaman detail produk.

   8. Pilih Tambahkan.

   9. (Opsional) Ulangi untuk menambahkan biaya terukur tambahan. 

      Urutan biaya yang diukur muncul di halaman detail produk. Anda tidak dapat mengatur ulang mereka.

      catatan

      Setelah penawaran dibuat, Anda dapat mengedit harga dan deskripsi biaya terukur. Untuk informasi selengkapnya, lihat Memperbarui detail produk dan penawaran di AWS Data Exchange.

4. Untuk penawaran pribadi saja, pilih tanggal kedaluwarsa Penawaran di mana pelanggan harus menerima penawaran.

5. Pilih pengaturan P ajak, Perjanjian berlangganan data (DSA), dan kebijakan pengembalian uang.

6. (Opsional) Hanya untuk penawaran umum, setel Verifikasi Langganan, yang memungkinkan Anda mengontrol siapa yang dapat berlangganan produk ini. Untuk informasi selengkapnya, lihat Verifikasi langganan untuk penyedia di AWS Data Exchange.

7. Pilih opsi perpanj angan otomatis Offer Anda. Untuk informasi selengkapnya, lihat Membuat penawaran untuk AWS Data Exchange produk.

8. Pilih Berikutnya.

Di bagian Tinjau & publikasikan, tinjau informasi produk Anda.

1. Perluas pratinjau halaman Produk untuk melihat bagaimana halaman produk akan terlihat setelah publikasi.

2. (Opsional) Pilih tombol Edit di bagian mana pun untuk mengedit bagian itu.

Jika Anda yakin ingin membuat produk dan penawaran umum terlihat dan tersedia untuk semua orang, pilih Publikasikan.

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

Dari panel navigasi kiri, di bawah Publikasikan data, pilih Produk.

Dari Produk, pilih tombol di sebelah produk yang ingin Anda salin.

Pilih menu tar ik -turun Tindakan, lalu pilih Buat salinan.

Lanjutkan melalui al ur kerja Publikasikan produk baru, dengan detail yang sudah diisi, berdasarkan produk yang Anda pilih di Langkah 3. Untuk informasi selengkapnya, lihat Langkah 5: Publikasikan produk baru.