Referensi API AWS Marketplace direstrukturisasi. Untuk informasi selengkapnya tentang operasi API yang didukung, lihat Referensi API AWS Marketplace.
Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
Bekerja dengan produk komponen EC2 Image Builder
Sebagai penjual AWS Marketplace, Anda dapat membuat daftar AMI-based produk yang dikirimkan ke pembeli AWS Marketplace menggunakan komponen EC2 Image Builder. Untuk membuat komponen Anda dan menerbitkan AWS Marketplace daftar, lanjutkan secara berurutan melalui bagian berikut.
Membangun dan menguji komponen Image Builder Anda
Buat dan uji komponen Anda di Image Builder. Untuk petunjuk, lihat Mengembangkan komponen kustom untuk image Image Builder Anda di Panduan Pengguna Image Builder. Saat membuat komponen menggunakan Image Builder, pastikan Anda melakukan hal berikut:
-
Komponen dan semua dependensi yang mendasarinya, seperti bucket, rahasia, atau parameter Amazon Simple Storage Service (Amazon S3), harus dibuat di Wilayah AWS AS Timur (Virginia N.) ().
us-east-1 -
Sertakan arsitektur yang didukung dan dependensi perangkat lunak apa pun dalam deskripsi komponen.
-
Uji komponen Anda di AWS akun Anda dengan membuat pipeline gambar dan menerapkan AMI yang dibuat oleh pipeline.
-
Jika komponen Anda berisi instruksi untuk menyalin binari, paket, atau file dari bucket S3, gunakan modul
S3Downloadtindakan. DalamS3Downloadmodul, untuksource, masukkan lokasi statis file Anda di bucket S3. Contoh berikut menyalin biner dari bucket S3 sebagai bagian dari instalasi komponen.- name: DownloadMyFile action: S3Download inputs: - source: s3://amzn-s3-demo-source-bucket/path/to/package.zip destination: C:\myfolder\package.zip -
Komponen dapat menelan file hingga 2 GB saat menggunakan
S3Downloadtindakan. -
Jika komponen Anda menggunakan parameter, pastikan semua parameter memiliki nilai default. Misalnya, jika Anda memiliki parameter bernama
region, pastikan bahwa Anda memiliki nilai default yang valid sepertius-east-1. Nilai default ini untuk AWS Marketplace pemrosesan dan pengujian. Pengujian mungkin gagal jika Anda tidak menyertakan nilai default. -
Jika komponen Anda menggunakan AWS Secrets Manager, Parameter Store, atau kemampuan AWS Systems Manager untuk menyimpan parameter, lakukan hal berikut:
-
-
Untuk mengambil nilai sebagai langkah dalam komponen Anda, sematkan AWS Command Line Interface perintah dalam file konfigurasi YAMM Anda.
-
Buat entri yang sesuai di Secrets Manager atau Parameter Store di AWS akun Anda. Gunakan kunci default dan berikan nilai yang valid yang akan membantu membangun komponen selama proses AWS Marketplace pengujian. Misalnya, Anda memiliki parameter yang dipanggil
saas_tokendengan nilai defaulttokenyang menggunakan Parameter Store. Dalam hal ini, buat pasangan kunci-nilai di Parameter Store. Gunakantokensebagai kuncinya. Untuk nilainya, masukkan token SaaS yang valid untuk aplikasi Anda.Perhatikan bahwa nilai yang disimpan di akun AWS Marketplace penjual Anda hanya akan digunakan untuk tujuan AWS Marketplace pengujian. Nilai-nilai ini tidak akan dibagi dengan pembeli.
-
AWS Marketplace secara otomatis menghasilkan Amazon Machine Images (AMI) untuk komponen Anda di semua versi sistem operasi yang kompatibel yang Anda pilih selama proses pembuatan komponen. Saat membuat komponen Anda, pilih setidaknya satu versi sistem operasi yang kompatibel. Validasi kompatibilitas komponen Anda dengan semua versi sistem operasi yang dipilih dengan menggunakan pipeline EC2 Image Builder untuk membuat dan menguji AMI.
-
Menyalin komponen ARN
Setelah membuat dan menguji komponen pada Image Builder, salin dan simpan komponen ARN. Anda akan menggunakan ARN saat mempublikasikan daftar produk menggunakan API AWS Marketplace Katalog.
Untuk menyalin komponen Image Builder ARN
-
Masuk ke AWS Management Console dan buka konsol Image Builder dihttps://console.aws.amazon.com/imagebuilder/
. -
Di bilah navigasi kiri, di bawah Sumber daya tersimpan, pilih Komponen.
-
Pada halaman Komponen, untuk pemilik Filter, pilih Dimiliki oleh saya.
-
Pilih nama komponen.
-
Pada halaman detail komponen, di bagian Ringkasan, salin ARN.
Membuat AWS Marketplace Kebijakan IAM
Buat kebijakan IAM berikut untuk memberikan AWS Marketplace akses ke komponen Image Builder dan sumber daya terkait seperti bucket dan rahasia Amazon S3. Gunakan contoh kebijakan yang disediakan. Anda melampirkan kebijakan ini ke peran AWS Marketplace IAM. Untuk bantuan membuat kebijakan, lihat Membuat kebijakan menggunakan editor JSON di Panduan Pengguna IAM.
-
Kebijakan mendapatkan komponen Image Builder, AWS Marketplace untuk memungkinkan mengakses komponen Anda di Image Builder. Kebijakan ini diperlukan. Sebutkan kebijakan
mp_ib_ingest. -
Kebijakan akses baca Amazon S3, untuk memungkinkan mengambil binari dari AWS Marketplace bucket S3. Kebijakan ini hanya diperlukan jika komponen Anda menggunakan modul
S3Downloadtindakan dan menyimpan binari terkait dalam bucket S3. Sebutkan kebijakanmp_ib_s3_read_only. -
Kebijakan akses baca Secrets Manager, untuk memungkinkan AWS Marketplace untuk mengambil rahasia yang disimpan di Secrets Manager. Kebijakan ini hanya diperlukan jika komponen Anda menggunakan Secrets Manager untuk menyimpan rahasia. Sebutkan kebijakan
mp_ib_sm_read_only. Untuk membatasi kebijakan hanya rahasia Anda, ganti bagian*diResourcebagian dengan rahasia Anda. -
Parameter Menyimpan kebijakan akses baca, untuk memungkinkan AWS Marketplace untuk mengambil rahasia yang disimpan di Parameter Store. Kebijakan ini hanya diperlukan jika komponen Anda menggunakan Parameter Store untuk menyimpan rahasia. Sebutkan kebijakan
mp_ib_ssm_parameter_read_only. Untuk membatasi kebijakan hanya rahasia Anda, ganti bagian*diResourcebagian dengan rahasia Anda.
Menciptakan AWS Marketplace IAM Role
Gunakan prosedur berikut untuk membuat peran AWS Marketplace IAM dengan kebijakan untuk memberikan AWS Marketplace akses ke komponen Anda dan dependensinya.
Untuk membuat AWS Marketplace IAM Role
-
Masuk ke AWS Management Console dan buka konsol IAM di https://console.aws.amazon.com/iam/
. -
Di bilah navigasi kiri, pilih Peran.
-
Pilih Buat peran.
-
Pilih Kebijakan kepercayaan khusus.
-
Masukkan pernyataan berikut:
-
Pilih Berikutnya.
-
Tambahkan kebijakan mendapatkan komponen Image Builder yang Anda buat sebelumnya. Kebijakan get-component diperlukan. Tambahkan kebijakan yang relevan untuk S3, Secrets Manager, dan Parameter Store jika komponen Anda menggunakan AWS layanan ini.
-
Pilih Berikutnya.
-
Masukkan nama peran, seperti
MPEC2IBIngestion. -
Pilih Buat peran.
Salin AWS Marketplace ARN peran IAM
Setelah membuat peran AWS Marketplace IAM, salin dan simpan peran ARN. Anda akan menggunakan ARN saat menerbitkan daftar menggunakan API AWS Marketplace Katalog.
Untuk menyalin AWS Marketplace ARN peran IAM
-
Di konsol IAM, di bilah navigasi kiri, pilih Peran.
-
Pilih peran AWS Marketplace IAM yang Anda buat sebelumnya, seperti
MPEC2IBIngestion. -
Pada halaman detail peran, di bagian Ringkasan, salin ARN.
Siapkan daftar komponen Image Builder
Sebelum mempublikasikan AWS Marketplace listing Anda, pastikan bahwa Anda memiliki informasi berikut siap:
-
Metadata produk — Metadata mencakup logo produk, judul produk, perjanjian Lisensi Pengguna Akhir, jenis instans yang didukung, dan Wilayah AWS.
-
Informasi harga — Anda dapat menawarkan produk Anda secara gratis, dengan tarif per jam, atau dengan tarif per jam dengan periode uji coba gratis awal. Bawa lisensi Anda sendiri (BYOL) tidak didukung.
-
Detail komponen — Detail mencakup komponen Amazon Resource Number (ARN), detail penggunaan, dan peran AWS Identity and Access Management (IAM) yang AWS Marketplace akan diasumsikan untuk memproses komponen Anda.
Menerbitkan daftar produk komponen Image Builder
Topik ini berisi petunjuk untuk mempublikasikan daftar komponen EC2 Image Builder Anda AWS Marketplace saat menggunakan Catalog AWS Marketplace API.
Prasyarat
Pastikan Anda memiliki hal-hal berikut sebelum memublikasikan daftar produk komponen Image Builder Anda:
-
Pendaftaran sebagai penjual di AWS Marketplace. Untuk informasi selengkapnya, lihat Daftar sebagai penjual AWS Marketplace
. -
Pengguna IAM dengan
AWSMarketplaceSellerFullAccessizin. -
Bucket Amazon Simple Storage Service (Amazon S3) yang dapat diakses publik untuk meng-host logo perusahaan Anda dan EULA, jika digunakan dalam komponen Anda. Anda akan memasukkan URL untuk bucket S3 di file
ChangeSetJSON Anda. -
AWS Command Line Interface (AWS CLI). Untuk informasi selengkapnya, lihat Apa itu Antarmuka Baris Perintah AWS? dalam AWS Command Line Interface User Guide.
Membuat produk komponen Image Builder di AWS Marketplace
Untuk membuat produk komponen EC2 Image Builder AWS Marketplace saat menggunakan Catalog API, lihatBuat produk.
Memperbarui informasi produk komponen Image Builder
Anda dapat memperbarui informasi tentang produk komponen Image Builder di Portal AWS Marketplace Manajemen.
Untuk memperbarui informasi produk komponen Image Builder
-
Buka Portal Manajemen AWS Marketplace
dan masuk ke akun penjual Anda. -
Pada menu Produk, pilih Server.
-
Pada halaman Produk Server, pilih produk.
-
Pada halaman detail produk, pada menu Permintaan perubahan, pilih item yang sesuai dengan informasi yang ingin Anda perbarui.
-
Setelah mengirimkan perubahan apa pun, permintaan akan muncul di tab Permintaan dalam status “Dalam peninjauan”, dan akan berubah menjadi “Berhasil” setelah selesai.
Menambahkan versi baru ke produk komponen Image Builder yang sudah ada
Anda dapat menambahkan versi baru ke produk komponen Image Builder saat AWS Marketplace menggunakan AWS Marketplace Catalog API.
Untuk menambahkan versi baru
-
Dari Portal Manajemen AWS Marketplace, dapatkan ID Produk.
-
Buka Portal Manajemen AWS Marketplace
dan masuk ke akun penjual Anda. -
Pada menu Produk, pilih Server.
-
Pada halaman Produk Server, pilih produk.
-
Dalam ringkasan Produk, salin ID Produk.
-
-
Menggunakan contoh kode berikut, membuat file changeset dalam format JSON. Dalam contoh, ganti
your-product-IDdengan ID produk yang Anda peroleh pada langkah 1. Gantinew-version-namedengan judul versi Anda. Gantinew-delivery-option-titledengan judul opsi pengiriman Anda.[ { "ChangeType": "AddDeliveryOptions", "Entity": { "Identifier": "your-product-ID", "Type": "AmiProduct@1.0" }, "DetailsDocument": { "Version": { "VersionTitle": "new-version-name", "ReleaseNotes": "Release notes goes here." }, "DeliveryOptions": [ { "DeliveryOptionTitle": "new title", "Details": { "Ec2ImageBuilderComponentDeliveryOptionDetails": { "UsageInstructions": "Test usage instructions for IB", "AccessRoleArn": "arn:aws:iam::123456789:role/sample", "ComponentArn": "arn:aws:imagebuilder:us-east-1:123456789:component/sample/2.0.0/1" } } } ] } } ] -
Simpan file changeset dengan nama.
addIBversion.json -
Di terminal Anda atau AWS CloudShell, jalankan perintah berikut:
aws marketplace-catalog start-change-set --catalog AWSMarketplace --region us-east-1 --change-set file://addIBversion.json
start-change-setPerintah akan mengembalikan ChangeSetId nilai. Untuk memantau set perubahan, lihatMemantau set perubahan.
Kesalahan Asinkron
Kesalahan berikut khusus untuk AddDeliveryOptions tindakan di AWS Marketplace Catalog API. Kesalahan ini dikembalikan saat Anda memanggil DescribeChangeSet setelah set perubahan diproses. Untuk informasi selengkapnya tentang penggunaan DescribeChangeSet untuk mendapatkan status permintaan perubahan, lihatBekerja dengan set perubahan.
catatan
Kode kesalahan berikut khusus untuk metode pengiriman Image Builder. Untuk pesan kesalahan yang ada di bidang sepertiUsage Instructions,Recommended Instance type, danAccessRoleArn, lihatTambahkan versi baru.
| Kode kesalahan | Pesan kesalahan |
|---|---|
ASSET_NOT_FOUND |
|
ASSET_NOT_FOUND |
|
DUPLIKATE_COMPONENT_NAME |
|
DUPLIKATE_COMPONENT_NAME |
|
DUPLICATE_COMPONENT_ARN |
|
DUPLICATE_COMPONENT_ARN |
|
SCAN_ERROR |
|
ASSET_ACCESS_EXCEPTION |
|
ASSET_ACCESS_EXCEPTION |
|
ASSET_ACCESS_EXCEPTION |
|
ASSET_ACCESS_EXCEPTION |
|
INVALID_IMAGE_BUILDER_COMPONENT_PACKAGE |
|
INVALID_IMAGE_BUILDER_COMPONENT_PACKAGE |
|
TOO_MANY_IMAGE_BUILDER_COMPONENTS |
|
INCOMPLETE_SELLER_PUBLIC_PROFILE |
|
INVALID_DESCRIPTION |
|
INVALID_COMPONENT_NAME |
|
INVALID_SUPPORTED_OS_VERSION |
|
FORMAT INVALID_PATH_ |
|
INCOMPATIBLE_OS_TYPE |
|
ASSET_ACCESS_EXCEPTION |
|
ASSET_ACCESS_EXCEPTION |
|
INVALID_IB_COMPONENT_BUILD_VERSION |
|
INVALID_IB_COMPONENT_PARAMETER |
|
INVALID_IB_COMPONENT_PARAMETER |
|
HILANG_IB_COMPONENT_PARAMETER |
|
INVALID_IB_COMPONENT_PARAMETER |
|
FAILED_LAUNCH_TEST |
|
SSHAuthFailedForUserAndKeypair |
|
INVALID_IB_COMPONENT |
|
DUPLIKATE_VERSION_TITLE |
|
INVALID_VERSION_TITLE |
|
INVALID_VERSION_TITLE |
|
INVALID_VERSION_TITLE |
|
INVALID_VERSION_TITLE |
|
INVALID_RELEASE_NOTES |
|
INVALID_RELEASE_NOTES |
|
INVALID_RELEASE_NOTES |
|
INVALID_RELEASE_NOTES |
|
INVALID_USAGE_INSTRUCTIONS |
|
INVALID_USAGE_INSTRUCTIONS |
|
INVALID_USAGE_INSTRUCTIONS |
|
DUPLIKATE_DELIVERY_OPTION_TITLES |
|
INVALID_DELIVERY_OPTION_TITLES |
|
Memperbarui informasi tentang versi yang ada
Untuk memperbarui informasi tentang versi yang ada
-
Dari Portal Manajemen AWS Marketplace, dapatkan ID Produk.
-
Buka Portal Manajemen AWS Marketplace
dan masuk ke akun penjual Anda. -
Pada menu Produk, pilih Server.
-
Pada halaman Produk Server, pilih produk.
-
Dalam ringkasan Produk, salin ID Produk.
-
-
Di terminal Anda, jalankan perintah berikut. Dalam perintah, ganti
your-product-IDdengan ID yang Anda peroleh pada langkah 1.aws marketplace-catalog describe-entity --catalog AWSMarketplace --region us-east-1 --entity-id 'your-product-ID' -
Dalam output yang dikembalikan, buka
VersionsbagianDetailsDocument,. SalinIdnilaiDeliveryOptions, untuk versi yang ingin Anda perbarui. -
Menggunakan contoh kode berikut, membuat file changeset dalam format JSON. Dalam contoh, ganti
your-product-IDdengan ID produk yang Anda peroleh pada langkah 1. Gantiyour-release-notesdengan catatan rilis Anda. Gantiyour-delivery-option-IDdengan ID opsi pengiriman yang Anda peroleh pada langkah 3. Gantiyour-usage-instructionsdengan petunjuk penggunaan Anda.[ { "ChangeType": "UpdateDeliveryOptions", "Entity": { "Identifier": "your-product-ID", "Type": "AmiProduct@1.0" }, "DetailsDocument": { "Version": { "ReleaseNotes": "your-release-notes" }, "DeliveryOptions": [ { "Id": "your-delivery-option-ID", "Details": { "Ec2ImageBuilderComponentDeliveryOptionDetails": { "UsageInstructions": "your-usage-instructions" } } } ] } } ] -
Simpan file changeset dengan nama.
updateVersionInfo.json -
Di terminal Anda atau AWS CloudShell, jalankan perintah berikut:
aws marketplace-catalog start-change-set --catalog AWSMarketplace --region us-east-1 --change-set file://updateVersionInfo.json
start-change-setPerintah akan mengembalikan ChangeSetId nilai. Untuk memantau set perubahan, lihatMemantau set perubahan.
Membatasi versi produk komponen Image Builder
Membatasi versi membuatnya tidak tersedia untuk pembeli. Anda dapat membatasi versi produk komponen Image Builder saat AWS Marketplace menggunakan AWS Marketplace Catalog API. Anda harus menyimpan setidaknya satu versi produk Anda tidak dibatasi. AWS Marketplace Anda tidak dapat membatasi akses ke satu-satunya versi publik.
Untuk memperbarui informasi tentang versi yang ada
-
Dari Portal Manajemen AWS Marketplace, dapatkan ID Produk.
-
Buka Portal Manajemen AWS Marketplace
dan masuk ke akun penjual Anda. -
Pada menu Produk, pilih Server.
-
Pada halaman Produk Server, pilih produk.
-
Dalam ringkasan Produk, salin ID Produk.
-
-
Di terminal Anda, jalankan perintah berikut. Dalam perintah, ganti
your-product-IDdengan ID yang Anda peroleh pada langkah 1.aws marketplace-catalog describe-entity --catalog AWSMarketplace --region us-east-1 --entity-id 'your-product-ID' -
Dalam output yang dikembalikan, buka
VersionsbagianDetailsDocument,. SalinIdnilaiDeliveryOptions, untuk versi yang ingin Anda perbarui. -
Menggunakan contoh kode berikut, membuat file changeset dalam format JSON. Dalam contoh, ganti
your-product-IDdengan ID produk yang Anda peroleh pada langkah 1. Gantiyour-delivery-option-IDdengan ID opsi pengiriman yang Anda peroleh pada langkah 3.[ { "ChangeType": "RestrictDeliveryOptions", "Entity": { "Identifier": "your-product-ID", "Type": "AmiProduct@1.0" }, "DetailsDocument": { "DeliveryOptionIds": [ "your-delivery-option-ID" ] } } ] -
Simpan file changeset dengan nama.
restrictec2ibversion.json -
Di terminal Anda atau AWS CloudShell, jalankan perintah berikut:
aws marketplace-catalog start-change-set --catalog AWSMarketplace --region us-east-1 --change-set file://restrictec2ibversion.json
start-change-setPerintah akan mengembalikan ChangeSetId nilai. Untuk memantau set perubahan, lihatMemantau set perubahan.
Memantau set perubahan
start-change-setPerintah akan mengembalikan ChangeSetId nilai. Anda dapat memantau kemajuan set perubahan dengan cara berikut:
-
Jalankan perintah berikut di terminal Anda. Dalam perintah. ganti
changeset-IDdenganChangeSetIdnilai yang dikembalikan olehstart-change-setperintah.aws marketplace-catalog describe-change-set ‐‐catalog AWSMarketplace ‐‐change-set-idchangesetID -
Lihat status permintaan pada tab Permintaan di Portal AWS Marketplace Manajemen
.
Mengamankan unduhan perangkat lunak
Untuk melindungi kekayaan intelektual perangkat lunak ISV dan memastikan pengiriman perangkat lunak yang stabil dan konsisten kepada AWS Marketplace pembeli, AWS Marketplace secara otomatis mem-parsing S3Download dan modul WebDownload tindakan dalam komponen Anda. File yang direferensikan kemudian disimpan dengan aman di bucket Amazon S3 pribadi yang dikelola oleh. AWS Marketplace Untuk memilih keluar dari proses konsumsi ini dan mengelola unduhan perangkat lunak secara independen, jalankan skrip bash yang menggunakan perintah atau unduh. wget curl