View a markdown version of this page

Bekerja dengan AMI-based produk - AWS Marketplace

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 AMI-based produk

Anda dapat menggunakan AWS Marketplace Catalog API untuk mengotomatiskan tugas untuk bekerja dengan produk berbasis Amazon Machine Image (AMI).

Untuk informasi tentang membuat AMI-based produk menggunakan API Katalog, lihatBuat produk.

Topik berikut menjelaskan cara menggunakan API Katalog untuk melakukan tindakan pada AMI-based produk Anda:

Tambahkan versi baru

Anda dapat menggunakan API Katalog untuk menambahkan versi baru ke AMI-based produk yang sudah ada diAWS Marketplace. Untuk informasi selengkapnya tentang menambahkan versi AMI baru ke produk Anda menggunakanPortal Manajemen AWS Marketplace, lihat Menambahkan versi baru di Panduan AWS Marketplace Penjual.

Saat Anda membuat permintaan yang mencakup penambahan AMI baru ke AWS Marketplace, AMI harus disalin ke sistem AWS Marketplace dan kemudian dipindai untuk masalah keamanan. Anda harus memberikan AWS Marketplace akses ke AMI dengan membuat peran AWS Identity and Access Management (IAM) dengan izin untuk melakukan tindakan pada AMI Anda. Untuk informasi selengkapnya tentang izin yang diperlukan, lihat Memberi AWS Marktplace akses ke AMI Anda di Panduan Penjual. AWS Marketplace

Untuk menambahkan versi baru, panggil operasi StartChangeSet API dengan jenis AddDeliveryOptions perubahan untuk AMI-based produk, seperti yang ditunjukkan pada contoh berikut. Untuk menguji panggilan API Anda tanpa benar-benar membuat versi baru, setel Intent parameternya keVALIDATE. Untuk informasi selengkapnya, lihat Maksud.

catatan

Untuk produk AMI, versi terdiri dari satu atau lebih opsi pengiriman. Semua opsi pengiriman dalam versi yang sama harus memiliki AmiSource objek yang sama dengan detail yang sama. Semua opsi pengiriman harus ditambahkan ke versi saat versi dibuat. Tidak mungkin menambahkan opsi pengiriman ke versi yang ada.

Permintaan Sintaks

POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "AddDeliveryOptions", "Entity": { "Type": "AmiProduct@1.0", "Identifier": "prod-example12345" }, "DetailsDocument": { "Version": { "VersionTitle": "My new title", "ReleaseNotes": "My new Release notes" }, "DeliveryOptions": [ { "Details": { "AmiDeliveryOptionDetails": { "AmiSource": { "AmiId": "ami-1234567890abcdef", "AccessRoleArn": "arn:aws:iam::12345678901:role/AwsMarketplaceAmiIngestion", "UserName": "ec2-user", "OperatingSystemName": "AMAZONLINUX", "OperatingSystemVersion": "Amazon Linux 2 AMI 2.0.20210126.0 x86_64 HVM gp2", "AfiIds": ["afi-1234567890abcdefg", "afi-abcdefg1234567890"] //Optional (Required only for FPGA products) }, "UsageInstructions": "Easy to use AMI", "RecommendedInstanceType": "m4.xlarge", "SecurityGroups": [ { "IpProtocol": "tcp", "FromPort": 443, "ToPort": 443, "IpRanges": [ "0.0.0.0/0" ] } ] } } }, { "DeliveryOptionTitle": "My new AMI with CFTdelivery option", "Details": { "DeploymentTemplateDeliveryOptionDetails": { "ShortDescription": "My new short description", "LongDescription": "My new long description", "UsageInstructions": "My new usage instructions", "RecommendedInstanceType": "m4.xlarge", "ArchitectureDiagram": "https://my-bucket.s3.amazonaws.com/my-folder/diagram.png", "Template": "https://my-bucket.s3.amazonaws.com/my-folder/cft.template", "TemplateSources": [ { "ParameterName": "MyAmiParam", "AmiSource": { "AmiId": "ami-1234567890abcdef", "AccessRoleArn": "arn:aws:iam::12345678901:role/AwsMarketplaceAmiIngestion", "UserName": "ec2-user", "OperatingSystemName": "AMAZONLINUX", "OperatingSystemVersion": "Amazon Linux 2 AMI 2.0.20210126.0 x86_64 HVM gp2" } } ] } } } ] } } ], "Intent": "APPLY" }

Daftar berikut memberikan informasi tentang bidang input yang Anda gunakan dengan jenis AddDeliveryOptions perubahan. Semua bidang diperlukan kecuali dinyatakan lain. Untuk informasi selengkapnya tentang bidang ini, lihat Menambahkan versi baru di Panduan AWS Marketplace Penjual.

  • DeliveryOptions(array objek) - Daftar objek opsi pengiriman, termasuk detail masing-masing. Anda harus menyertakan setidaknya satu.

    • Untuk opsi pengiriman AMI (mandiri), tentukan objek dengan detail berikut. Anda hanya dapat memiliki satu opsi pengiriman dengan jenis ini.

      • Detail (objek) - Menyimpan detail opsi pengiriman ini. Perhatikan bahwa objek detail bersarang ini tidak perlu diloloskan ganda.

        • AmiDeliveryOptionDetails(objek) — Gunakan untuk memberikan rincian setiap opsi pengiriman AMI.

          • AmiSource(objek) - Detail tentang AMI yang akan digunakan untuk versi yang ditambahkan.

            • AmiId(string) — ID untuk sumber AMI, yang terletak di Wilayah AWS tempat API dipanggil. Ini harus selalu US East (Virginia N.) karena itu adalah satu-satunya wilayah di mana API Katalog tersedia. Harus milik akun penelepon.

            • AccessRoleArn(string) — Peran IAM Nama Sumber Daya Amazon (ARN) yang digunakan AWS Marketplace oleh untuk mengakses AMI yang disediakan. Untuk detail tentang membuat dan menggunakan ARN ini, lihat Memberi AWS Marketplace akses ke AMI Anda di Panduan AWS MarketplacePenjual.

            • UserName(string) — Login nama pengguna untuk mengakses sistem operasi (OS) di AMI. Biasanya ec2-user untuk Linux AMI atau Administrator untuk Windows.

            • ScanningPort(integer) — SSH atau port RDP yang digunakan untuk mengakses OS. Digunakan untuk memindai AMI yang disediakan untuk kerentanan keamanan. Default ke 22.

            • OperatingSystemName(string) — Nama sistem operasi yang ditampilkan kepada pembeli.

            • OperatingSystemVersion(string) — String versi sistem operasi ditampilkan kepada pembeli.

            • AfiIds(array string) (opsional) - Amazon FPGA Image (AFI) ID untuk mengaktifkan dukungan FPGA untuk versi ini. Saat disediakan, ini memungkinkan produk Anda berjalan pada jenis instans FPGA-enabled F2. Anda dapat memberikan hingga 15 ID AFI per versi. Semua ID AFI yang Anda masukkan harus berasal dari wilayah AS Timur (Virginia Utara) dan berada dalam akun penjual AWS Marketplace Anda, dan peran akses IAM yang disediakan harus memiliki izin untuk membagikan AFI tersebut kepada AWS Marketplace. Untuk detail selengkapnya tentang izin yang diperlukan, lihat Memberi AWS Marketplace akses ke gambar FPGA Anda di Panduan Penjual. AWS Marketplace

          • UsageInstructions(string) — Petunjuk untuk menggunakan AMI, atau tautan ke informasi lebih lanjut tentang AMI.

          • AccessEndpointUrl(objek) (opsional) - Digunakan untuk membuat jalur untuk mengakses AMI setelah digunakan.

            • Port (string) — Nomor port yang digunakan untuk mengakses layanan yang berjalan pada AMI.

            • Protokol (string) — Protokol (http atau https) yang digunakan untuk mengakses layanan yang berjalan pada AMI.

            • RelativePath(string) - Jalur dari root web untuk mengakses layanan yang berjalan pada AMI (misalnya /index.html).

          • RecommendedInstanceType(string) - Jenis instans yang direkomendasikan untuk menjalankan layanan dengan AMI dan merupakan default untuk instalasi 1-klik layanan Anda. Untuk daftar jenis instans, lihat Jenis instans di Panduan Pengguna Amazon Elastic Compute Cloud untuk Instans Linux.

          • SecurityGroups(array objek) - Daftar objek yang mewakili aturan masuk untuk grup yang dibuat secara otomatis untuk versi tersebut.

            • IpProtocol(string) — Protokol yang digunakan (tcp atau udp).

            • FromPort(integer) — Port sumber.

            • ToPort(integer) — Port tujuan.

            • IpRanges(array string) - Rentang IP untuk memungkinkan, dalam format CIDR (dalam bentuk xxx.xxx.xxx. xxx/nn, misalnya,192.0.2.0/24).

    • Untuk AMI dengan opsi CloudFormation pengiriman, tentukan objek dengan detail berikut. Anda dapat memiliki hingga tiga opsi pengiriman jenis ini.

      • DeliveryOptionTitle(string) - Judul untuk opsi pengiriman.

      • Detail (objek) — Menyimpan detail opsi pengiriman AMI. Perhatikan bahwa objek detail bersarang ini tidak perlu diloloskan ganda.

        • DeploymentTemplateDeliveryOptionDetails(objek) — Gunakan untuk memberikan rincian setiap opsi pengiriman CFT.

          • ShortDescription(string) - Deskripsi singkat tentang opsi pengiriman CloudFormation template Anda.

          • LongDescription(string) - Deskripsi rinci dari opsi pengiriman CloudFormation template Anda.

          • UsageInstructions(string) — Petunjuk untuk menggunakan AMI, atau tautan ke informasi lebih lanjut tentang AMI.

          • RecommendedInstanceType(string) - Jenis instans yang direkomendasikan untuk menjalankan layanan dengan AMI dan merupakan default untuk instalasi 1-klik layanan Anda. Untuk daftar jenis instans, lihat Jenis instans di Panduan Pengguna Amazon Elastic Compute Cloud untuk Instans Linux.

          • ArchitectureDiagram(string) — URL ke lokasi diagram arsitektur Anda di Amazon S3.

          • Template (string) — URL ke lokasi CloudFormation Template Anda di Amazon S3.

          • TemplateSources(array objek)

            • ParameterName(string) — Nama parameter dalam CloudFormation Template tempat AMI dalam versi ini harus diteruskan. Untuk informasi selengkapnya, lihat Persyaratan untuk detail AMI.

            • AmiSource(objek)

              • AmiId(string) — ID untuk sumber AMI, yang terletak di Wilayah AWS tempat API dipanggil (saat ini harus selalu US East (Virginia N.) karena itu adalah satu-satunya wilayah di mana API Katalog tersedia). Harus milik akun penelepon.

              • AccessRoleArn(string) — Peran IAM Nama Sumber Daya Amazon (ARN) yang digunakan Wilayah AWS oleh untuk mengakses AMI yang disediakan. Untuk detail tentang membuat dan menggunakan ARN ini, lihat Memberi AWS Marketplace akses ke AMI Anda di Panduan AWS MarketplacePenjual.

              • UserName(string) — Login nama pengguna untuk mengakses sistem operasi (OS) di AMI. Biasanya ec2-user untuk AMI Linux atau Administrator untuk Windows.

              • OperatingSystemName(string) — Nama sistem operasi yang ditampilkan kepada pembeli.

              • OperatingSystemVersion(string) — String versi sistem operasi ditampilkan kepada pembeli.

Sintaks Respon

Set perubahan dibuat untuk permintaan Anda. Respons terhadap permintaan ini memberi Anda ChangeSetId dan ChangeSetArn untuk set perubahan dan terlihat seperti berikut.

{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }

Permintaan perubahan ditambahkan ke antrian dan diproses. Ini termasuk memvalidasi informasi untuk memastikannya memenuhi AWS Marketplace pedoman. Proses validasi dapat berlangsung dari beberapa menit hingga beberapa jam.

Anda dapat memeriksa status permintaan melaluiPortal Manajemen AWS Marketplace, atau langsung melalui API Katalog menggunakan operasi DescribeChangeSet API.

Untuk informasi selengkapnya tentang kesalahan dalam set perubahan produk penjual, lihatUbah status dan kesalahan yang disetel.

Ketika permintaan selesai, versi ditambahkan, dan setiap pelanggan yang ada akan menerima pesan email yang memberi tahu mereka tentang versi baru. Untuk informasi selengkapnya tentang proses menambahkan versi baru, lihat Menambahkan versi baru di Panduan AWS Marketplace Penjual.

Kesalahan Asinkron

Kesalahan berikut khusus untuk AddDeliveryOptions tindakan diAWS 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.

Kode kesalahan Pesan kesalahan
INVALID_AMI_NAME Awalan (x) dalam nama AMI tidak valid. Berikan nama baru menggunakan nama perusahaan atau merek Anda sebagai awalan.

INVALID_PRODUCT

Gunakan produk terbatas atau publik yang ada.

DUPLIKATE_VERSION_TITLE

Judul versi harus berbeda dari judul versi lain dari produk ini.

INVALID_VERSION_TITLE

Hapus spasi sebelum simbol merek dagang.

INVALID_VERSION_TITLE

Hapus karakter yang tidak didukung: [x, y, z]

INVALID_VERSION_TITLE

Hapus spasi dari awal judul versi.

INVALID_VERSION_TITLE

Berikan judul versi dengan karakter kurang dari [x].

INVALID_RELEASE_NOTES

Hapus spasi sebelum simbol merek dagang.

INVALID_RELEASE_NOTES

Hapus karakter yang tidak didukung: [x, y, z]

INVALID_RELEASE_NOTES

Hapus spasi dari awal catatan rilis.

INVALID_RELEASE_NOTES

Berikan catatan rilis dengan karakter kurang dari (x).

INVALID_USAGE_INSTRUCTIONS

Hapus spasi sebelum simbol merek dagang.

INVALID_USAGE_INSTRUCTIONS

Hapus karakter yang tidak didukung: [x, y, z]

INVALID_USAGE_INSTRUCTIONS

Hapus spasi dari awal catatan rilis.

INVALID_USAGE_INSTRUCTIONS

Berikan petunjuk penggunaan dengan karakter kurang dari (x).

DIREKOMENDASIKAN_INSTANCE_TYPE_NOT_AVAILABLE

Menyediakan jenis instans yang ada dan tersedia.

INVALID_RECOMMENDED

Berikan jenis instance yang valid.

INVALID_SECURITY_GROUP

Port grup keamanan harus antara 1 dan [maks].

INVALID_SECURITY_GROUP

Berikan nilai untuk rentang IP CIDR.

INVALID_SECURITY_GROUP

Menyediakan port start grup keamanan yang tidak lebih besar dari port akhir.

INVALID_SECURITY_GROUP_PROTOCOL

Protokol grup keamanan harus 'tcp' atau 'udp'.

TIDAK VALID_CIDR_IP

Menyediakan rentang IP CIDR standar dalam bentuk '0.0.0. 0/0'.

INVALID_ACCESS_ENDPOINT_PORT

Menyediakan port endpoint kurang dari [x].

INVALID_ACCESS_ENDPOINT_PORT

Menyediakan port endpoint antara 1 dan [max].

INVALID_ACCESS_ENDPOINT_PORT

Menyediakan port endpoint.

INVALID_ACCESS_ENDPOINT_RELATIVE_PATH

Hapus spasi di jalur relatif.

INVALID_ACCESS_ENDPOINT_RELATIVE_PATH

Hapus '/' sebelumnya dari jalur relatif.

INCOMPATIBLE_OPERATING_SYSTEM

Berikan nama dan versi sistem operasi yang kompatibel dengan tipe instance: [x]

INCOMPATIBLE_OPERATING_SYSTEM_NAME

Berikan nama dengan karakter kurang dari (x).

INCOMPATIBLE_OPERATING_SYSTEM_NAME

Berikan nama sistem operasi yang didukung.

INCOMPATIBLE_OPERATING_SYSTEM_VERSION

Berikan versi dengan karakter kurang dari (x).

INVALID_SCANNING_PORT

Menyediakan port pemindaian antara 1 dan [maks].

INVALID_AMI_ID

Berikan ID AMI yang valid.

EXISTING_AMI_PRODUCT_CODE

Hapus kode produk yang dilampirkan pada gambar X.

INVALID_AMI_ARCHITECTURE

Menyediakan AMI baru dengan arsitektur [x].

INVALID_AMI_VIRTUALIZATION_TYPE

Berikan AMI baru dengan tipe virtualisasi [x].

INVALID_AMI_VIRTUALIZATION_TYPE

Berikan volume [z] yang diharapkan pada gambar [x].

TIDAK KOMPATIBIL_AMI

Menyediakan AMI baru sebagai arsitektur [x] pada [y] tidak didukung oleh jenis instance berikut: [z]

TIDAK KOMPATIBIL_AMI

Berikan AMI baru sebagai tipe virtualisasi [x] pada [y] tidak didukung oleh tipe instance berikut: [z]

TIDAK KOMPATIBIL_AMI

Aktifkan dukungan ENA untuk image x karena tipe instance berikut memerlukan dukungan ENA: [y]

ASSET_NOT_FOUND

Periksa apakah [ami-id] ada di Wilayah us-east-1 dari [account-id] dan [AccessARNARN] yang disediakan memiliki izin Akun AWS untuk membagikan AMI ini. AWS Marketplace

ASSET_ACCESS_EXCEPTION

Tidak dapat menyalin AMI [x] ke AWS Marketplace akun.

SCAN_ERROR

Perbaiki kerentanan keamanan [y] pada Gambar [x].

ASSET_NOT_FOUND

Periksa apakah [afi-id] ada di Wilayah us-east-1 dari [account-id] dan AccessARN [ARN] yang disediakan memiliki izin untuk berbagi AFI Akun AWS ini dengan. AWS Marketplace

ASSET_ACCESS_EXCEPTION

Tidak dapat mengakses AFI. Periksa apakah AccessARN disediakan [ARN] memiliki izin untuk berbagi AFI ini dengan AWS Marketplace dan peran akses Akun adalah pemilik AFI.

MISSING_FPGA_INSTANCE_TYPE

Tidak ada jenis instans berbasis FPGA yang ditemukan. Gunakan jenis AddInstanceTypes perubahan untuk menambahkan jenis instance berbasis FPGA.

Anda juga dapat membuat AMI-based produk menggunakanPortal Manajemen AWS Marketplace. Untuk informasi selengkapnya, lihat produk AMI di Panduan AWS Marketplace Penjual.

Untuk panduan yang menunjukkan cara mengotomatiskan pembaruan AMI-based produk Anda, Anda juga dapat merujuk ke video, Mengotomatiskan pembaruan ke daftar produk Anda AWS Marketplace dengan API Katalog (5:08).

Perbarui informasi versi

Anda dapat menggunakan API Katalog untuk memperbarui detail versi AMI-based produk yang ada diAWS Marketplace.

catatan

Untuk informasi selengkapnya tentang memperbarui informasi versi menggunakanPortal Manajemen AWS Marketplace, lihat Memperbarui informasi versi di Panduan AWS Marketplace Penjual.

Anda tidak dapat memperbarui AMI untuk versi tersebut. Jika Anda perlu memperbarui AMI, buat versi baru sebagai gantinya.

Untuk menambahkan versi baru, panggil operasi StartChangeSet API dengan jenis UpdateDeliveryOptions perubahan, seperti yang ditunjukkan pada contoh berikut.

Permintaan Sintaks

POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "UpdateDeliveryOptions", "Entity": { "Identifier": "example1-abcd-1234-5ef6-7890abcdef12@1", "Type": "AmiProduct@1.0" }, "DetailsDocument": { "Version": { "ReleaseNotes": "*My new Release notes*" }, "DeliveryOptions": [ { "Id": "example1-2222-cccc-2222-cccccccccccc", "Details": { "AmiDeliveryOptionDetails": { "UsageInstructions": "Easy to use AMI" } } }, { "Id": "example1-2222-dddd-2222-dddddddddddd", "Details": { "DeploymentTemplateDeliveryOptionDetails": {work with ami "DeliveryOptionTitle": "My updated delivery option title", "UsageInstructions": "Updated usage instructions here." } } } ] } } ] }

Berikut ini adalah informasi tentang kolom input yang Anda berikan untuk menambahkan jenis UpdateDeliveryOptions perubahan. Untuk informasi selengkapnya tentang bidang ini, lihat Memperbarui informasi versi di Panduan AWS Marketplace Penjual.

  • Entitas (objek) (wajib) — AMI-based Produk Anda.

    • Identifier (string) (wajib) - ID produk Anda. Untuk informasi selengkapnya, lihat Pengidentifikasi.

    • Jenis (string) (wajib) — Type Ini didasarkan pada metode pengiriman (tipe produk) yang akan digunakan produk Anda:AmiProduct@1.0.

  • DetailsDocument(objek) (wajib) — Detail permintaan. Ini mencakup informasi apa pun tentang versi AMI-based produk Anda yang ingin Anda perbarui. Bidang yang disertakan semuanya opsional, tetapi Anda harus menyertakan setidaknya satu bidang untuk diperbarui.

    • Versi (objek) — Detail tentang versi perangkat lunak.

      • ReleaseNotes(string) — Catatan bagi pembeli untuk memberi tahu mereka tentang perubahan dari satu versi ke versi berikutnya.

    • DeliveryOptions(array objek) - Daftar objek opsi pengiriman. Sertakan hanya opsi pengiriman yang ingin Anda perbarui.

      • Untuk opsi pengiriman AMI (mandiri), tentukan objek dengan detail berikut. Sertakan hanya bidang yang ingin Anda perbarui. Semua bidang bersifat opsional kecuali dinyatakan lain.

        • Id (string) (wajib) - Pengidentifikasi unik untuk opsi pengiriman (Anda bisa mendapatkan pengenal unik untuk opsi pengiriman dengan memanggil DescribeEntity tindakan pada produk yang Anda perbarui).

        • Detail (objek) — Menyimpan detail opsi pengiriman AMI. Perhatikan bahwa objek detail bersarang ini tidak perlu diloloskan ganda.

          • AmiDeliveryOptionDetails(objek) — Rincian satu opsi pengiriman AMI.

            • UsageInstructions(string) — Petunjuk untuk menggunakan AMI, atau tautan ke informasi lebih lanjut tentang AMI.

            • AccessEndpointUrl(objek) — Digunakan untuk membuat jalur untuk mengakses AMI setelah digunakan.

              • Port (string) — Nomor port yang digunakan untuk mengakses layanan yang berjalan pada AMI.

              • Protokol (string) — Protokol (httpatauhttps) yang digunakan untuk mengakses layanan yang berjalan pada AMI.

              • RelativePath(string) — Jalur dari root web untuk mengakses layanan yang berjalan pada AMI (misalnya/index.html).

            • RecommendedInstanceType(string) - Jenis instans yang direkomendasikan untuk menjalankan layanan dengan AMI dan merupakan default untuk instalasi 1-klik layanan Anda.

            • SecurityGroups(array objek) - Daftar objek yang mewakili aturan masuk untuk grup yang dibuat secara otomatis untuk versi:

              • FromPort(integer) — Port sumber.

              • IpProtocol(string) — Protokol untuk menggunakan (tcpatauidp).

              • IpRanges(array string) - Rentang IP untuk memungkinkan, dalam format CIDR (dalam bentuk xxx.xxx.xxx. xxx/nn, misalnya,192.0.2.0/24).

              • ToPort(integer) — Port tujuan.

      • Untuk AMI dengan opsi CloudFormation pengiriman, tentukan objek dengan detail berikut. Sertakan hanya bidang yang ingin Anda perbarui. Semua bidang bersifat opsional kecuali dinyatakan lain.

        • Id (string) (wajib) - Pengidentifikasi unik untuk opsi pengiriman (Anda bisa mendapatkan pengenal unik untuk opsi pengiriman dengan memanggil DescribeEntity tindakan pada produk yang Anda perbarui).

        • Detail (objek) — Menyimpan detail opsi pengiriman AMI. Perhatikan bahwa objek detail bersarang ini tidak perlu diloloskan ganda.

          • DeploymentTemplateDeliveryOptionDetails(objek) — Gunakan untuk memberikan rincian setiap opsi pengiriman CFT.

            • DeliveryOptionTitle(string) - Judul untuk opsi pengiriman.

            • ShortDescription(string) - Deskripsi singkat tentang opsi pengiriman CloudFormation template Anda.

            • LongDescription(string) - Deskripsi rinci dari opsi pengiriman CloudFormation template Anda.

            • UsageInstructions(string) — Petunjuk untuk menggunakan AMI, atau tautan ke informasi lebih lanjut tentang AMI.

            • RecommendedInstanceType(string) - Jenis instans yang direkomendasikan untuk menjalankan layanan dengan AMI dan merupakan default untuk instalasi 1-klik layanan Anda. Untuk daftar jenis instans, lihat Jenis instans di Panduan Pengguna Amazon Elastic Compute Cloud untuk Instans Linux.

            • ArchitectureDiagram(string) — URL ke lokasi diagram arsitektur Anda di Amazon S3.

            • Template (string) — URL ke lokasi CloudFormation Template Anda di Amazon S3.

            • TemplateSources(array objek)

              • ParameterName(string) — Nama parameter dalam CloudFormation Template tempat AMI dalam versi ini harus diteruskan. Untuk informasi selengkapnya, lihat Persyaratan untuk detail AMI.

              • AmiSource(objek)

                • AmiId(string) — ID untuk sumber AMI, yang terletak di Wilayah AWS tempat API dipanggil (saat ini harus selalu US East (Virginia N.) karena itu adalah satu-satunya wilayah di mana API Katalog tersedia). Harus milik akun penelepon.

                • AccessRoleArn(string) — Peran IAM Nama Sumber Daya Amazon (ARN) yang digunakan Wilayah AWS oleh untuk mengakses AMI yang disediakan. Untuk detail tentang membuat dan menggunakan ARN ini, lihat Memberi AWS Marketplace akses ke AMI Anda di Panduan AWS MarketplacePenjual.

                • UserName(string) — Login nama pengguna untuk mengakses sistem operasi (OS) di AMI. Biasanya ec2-user untuk AMI Linux atau Administrator untuk Windows.

                • OperatingSystemName(string) — Nama sistem operasi yang ditampilkan kepada pembeli.

                • OperatingSystemVersion(string) — String versi sistem operasi ditampilkan kepada pembeli.

Sintaks Respon

Set perubahan dibuat untuk permintaan Anda. Respons terhadap permintaan ini memberi Anda ChangeSetId dan ChangeSetArn untuk set perubahan dan terlihat seperti berikut.

{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }

Permintaan perubahan ditambahkan ke antrian dan diproses. Ini termasuk memvalidasi informasi untuk memastikannya memenuhi AWS Marketplace pedoman. Proses validasi dapat berlangsung dari beberapa menit hingga beberapa jam.

Anda dapat memeriksa status permintaan melaluiPortal Manajemen AWS Marketplace, atau langsung melalui API Katalog menggunakan operasi DescribeChangeSet API.

Untuk informasi selengkapnya tentang set perubahan, lihatBekerja dengan set perubahan. Untuk informasi selengkapnya tentang kesalahan dalam set perubahan produk penjual, lihatUbah status dan kesalahan yang disetel.

Kesalahan Asinkron

Kesalahan berikut khusus untuk UpdateDeliveryOptions tindakan diAWS 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.

Anda dapat mengambil UpdatePricingTerms tindakan dengan menggunakan DescribeChangeSet operasi setelah set perubahan mulai diproses. Untuk informasi selengkapnya tentang detail kesalahan dan pemecahan masalah, lihatUbah status dan kesalahan yang disetel, sebelumnya dalam panduan ini.

Kode kesalahan Pesan kesalahan
INVALID_PRODUCT Gunakan produk terbatas atau publik yang ada.
HILANG_DELIVERY_OPTION_IDS Berikan setidaknya satu ID opsi pengiriman.
INVALID_DELIVERY_OPTION_IDS Berikan ID opsi pengiriman yang dapat ditemukan di produk. ID tidak ditemukan: [x]
INVALID_DELIVERY_OPTIONS Berikan ID opsi pengiriman yang termasuk dalam versi yang sama.

Batasi versi

Anda dapat menggunakan API Katalog untuk membatasi versi AMI-based produk Anda. Ini mencegah pembeli baru menggunakan versi itu, tetapi membuatnya tetap tersedia untuk pembeli yang ada. Membatasi semua opsi pengiriman dari versi membatasi versi. Membatasi satu atau lebih, tetapi tidak semua, opsi pengiriman dari versi membatasi hanya opsi pengiriman dalam versi itu. Anda harus selalu memiliki setidaknya satu versi produk yang tidak terbatas yang tersedia, sehingga Anda tidak dapat membatasi versi produk terakhir yang tersedia untuk umum.

catatan

Untuk informasi selengkapnya tentang membatasi versi AMI AWS Marketplace melaluiPortal Manajemen AWS Marketplace, lihat Membatasi versi di Panduan AWS MarketplacePenjual.

Untuk membatasi versi, panggil operasi StartChangeSet API dengan jenis RestrictDeliveryOptions perubahan, seperti yang ditunjukkan pada contoh berikut.

catatan

Semua pelanggan dapat menggunakan versi saat ini terlepas dari status pembatasan. AWS Marketplacepedoman mengharuskan Anda terus menawarkan dukungan kepada pembeli yang ada selama 90 hari setelah membatasi versi. AMI Anda akan ditandai sebagai usang setelah versi dibatasi. Untuk informasi selengkapnya, lihat Menghentikan AMI di Panduan Pengguna Amazon Elastic Compute Cloud untuk Instans. Windows

Permintaan Sintaks

POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "RestrictDeliveryOptions", "Entity": { "Identifier": "example1-abcd-1234-5ef6-7890abcdef12@1", "Type": "AmiProduct@1.0" }, "DetailsDocument": { "DeliveryOptionIds": [ "example1-2222-cccc-2222-cccccccccccc" ] } } ] }

Berikut ini adalah informasi tentang kolom input yang Anda berikan untuk menambahkan jenis RestrictDeliveryOptions perubahan:

  • Entitas (objek) (wajib) — AMI-based Produk Anda.

    • Identifier (string) (wajib) - ID produk Anda. Untuk informasi selengkapnya, lihat Pengidentifikasi.

    • Jenis (string) (wajib) — Type Ini didasarkan pada metode pengiriman (tipe produk) yang akan digunakan produk Anda:AmiProduct@1.0.

  • DetailsDocument(objek) (wajib) — Detail permintaan. Ini termasuk ID untuk versi AMI-based produk Anda yang ingin Anda batasi.

    • DeliveryOptionIds(array objek) — Daftar DeliveryOption ID untuk versi yang ingin Anda batasi. Anda bisa mendapatkan pengenal unik untuk DeliveryOption dengan memanggil DescribeEntity tindakan pada versi yang Anda batasi.

Sintaks Respon

Set perubahan dibuat untuk permintaan Anda. Respons terhadap permintaan ini memberi Anda ChangeSetId dan ChangeSetArn untuk set perubahan dan terlihat seperti berikut.

{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }

Permintaan perubahan ditambahkan ke antrian dan diproses. Ini termasuk memvalidasi informasi untuk memastikannya memenuhi AWS Marketplace pedoman. Proses validasi dapat berlangsung dari beberapa menit hingga beberapa jam.

Anda dapat memeriksa status permintaan melaluiPortal Manajemen AWS Marketplace, atau langsung melalui API Katalog menggunakan operasi DescribeChangeSet API.

Kesalahan Asinkron

Kesalahan berikut khusus untuk RestrictDeliveryOptions tindakan diAWS 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.

Kode kesalahan Pesan kesalahan

INVALID_PRODUCT

Gunakan produk publik yang sudah ada.

HILANG_DELIVERY_OPTION_IDS

Berikan setidaknya satu ID opsi pengiriman.

INVALID_DELIVERY_OPTION_IDS

Berikan ID opsi pengiriman yang dapat ditemukan di produk. ID tidak ditemukan: [x]

INVALID_DELIVERY_OPTION

Berikan ID opsi pengiriman yang berada dalam keadaan publik. ID tidak dalam keadaan publik: [x]

ALL_DELIVERY_OPTIONS_RESTRICTED

Berikan lebih sedikit opsi pengiriman untuk membatasi karena setidaknya satu harus tetap berada di negara publik.

Perbarui futureWilayah AWSdukungan

Anda dapat menggunakan Catalog API untuk mengubah preferensi Wilayah AWS dukungan future untuk AMI-based produk Anda diAWS Marketplace.

catatan

Untuk informasi selengkapnya tentang mengubah dukungan Wilayah future menggunakanPortal Manajemen AWS Marketplace, lihat Memperbarui dukungan untuk Wilayah AWS masa depan dalam Panduan AWS Marketplace Penjual.

catatan

Jenis UpdateFutureRegionSupport perubahan hanya tersedia diAmiProduct@1.0.

Untuk mengubah preferensi Wilayah AWS dukungan future, panggil operasi StartChangeSet API dengan tipe UpdateFutureRegionSupport perubahan, seperti yang ditunjukkan pada contoh berikut.

Permintaan Sintaks

POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "UpdateFutureRegionSupport", "Entity": { "Identifier": "prod-example12345", "Type": "AmiProduct@1.0" }, "DetailsDocument": { "FutureRegionSupport": { "SupportedRegions": [ "All" ] } } } ] }

Berikan informasi untuk bidang untuk menambahkan jenis UpdateFutureRegionSupport perubahan:

  • Entity(objek) (wajib) — AMI-based Produk Anda.

    • Identifier(string) (wajib) — ID produk Anda. Untuk informasi selengkapnya, lihat Pengidentifikasi.

    • Type(string) (wajib) — Type Ini didasarkan pada metode pengiriman (jenis produk) yang akan digunakan produk Anda:AmiProduct@1.0.

  • DetailsDocument(objek) (wajib) - Detail yang diperlukan untuk mengeksekusi ChangeSet.

    • FutureRegionSupport— Objek

      • SupportedRegions— Single-element array string

        Nilai yang didukung elemen: salah satu ["All","US","None"]

Sintaks Respon

Set perubahan dibuat untuk permintaan Anda. Respons terhadap permintaan ini memberi Anda ChangeSetId dan ChangeSetArn untuk set perubahan dan terlihat seperti berikut.

{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }

Permintaan perubahan ditambahkan ke antrian dan diproses. Ini termasuk memvalidasi informasi untuk memastikannya memenuhi AWS Marketplace pedoman. Proses validasi dapat berlangsung dari beberapa menit hingga beberapa jam.

Anda dapat memeriksa status permintaan melaluiPortal Manajemen AWS Marketplace, atau langsung melalui API Katalog menggunakan operasi DescribeChangeSet API.

Kesalahan Asinkron

Kesalahan berikut khusus untuk UpdateFutureRegionSupport tindakan diAWS 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.

Kode kesalahan Pesan kesalahan
TOO_BANYAK_REGION Saat ini, hanya 1 nilai yang didukung untuk FutureRegionSupport: Semua, AS, atau Tidak Ada
INVALID_REGIONS Wilayah yang Diminta [a, b, c] tidak valid atau tidak tersedia. Hanya nilai yang didukung adalah [x, y, z].
INVALID_INPUT SupportedRegions tidak bisa kosong.

Tambahkan yang didukungWilayah AWS

Anda dapat menggunakan API Katalog untuk menambahkan dukungan baru Wilayah AWS untuk AMI-based produk Anda diAWS Marketplace.

catatan

Untuk informasi selengkapnya tentang menambahkan Wilayah baru yang didukung menggunakanPortal Manajemen AWS Marketplace, lihat Menambahkan Wilayah AWS di Panduan AWS Marketplace Penjual.

catatan

Jenis AddRegions perubahan hanya tersedia diAmiProduct@1.0.

Untuk menambahkan Wilayah baru yang didukung, panggil operasi StartChangeSet API dengan jenis AddRegions perubahan, seperti yang ditunjukkan pada contoh berikut.

Permintaan Sintaks

POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "AddRegions", "DetailsDocument": { "Regions": [ "us-east-1", "ap-northeast-2" ] }, "Entity": { "Identifier": "prod-123456@1", "Type": "AmiProduct@1.0" } } ] }

Berikan informasi untuk bidang untuk menambahkan jenis AddRegions perubahan.

  • Entity(objek) (wajib) — AMI-based Produk Anda.

    • Identifier(string) (wajib) — ID produk Anda. Untuk informasi selengkapnya, lihat Pengidentifikasi.

    • Type(string) (wajib) — Type Ini didasarkan pada metode pengiriman (jenis produk) yang akan digunakan produk Anda:AmiProduct@1.0.

  • contoh
    DetailsDocument (object) (required) – The details required to execute the ChangeSet.
    • Regions: Array string

      Nilai yang didukung elemen: String Wilayah AWS kode yang valid.

      Misalnya, ["us-east- 1"].

Sintaks Respon

Set perubahan dibuat untuk permintaan Anda. Respons terhadap permintaan ini memberi Anda ChangeSetId dan ChangeSetArn untuk set perubahan dan terlihat seperti berikut.

{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }

Permintaan perubahan ditambahkan ke antrian dan diproses. Ini termasuk memvalidasi informasi untuk memastikannya memenuhi AWS Marketplace pedoman. Proses validasi dapat berlangsung dari beberapa menit hingga beberapa jam.

Anda dapat memeriksa status permintaan melaluiPortal Manajemen AWS Marketplace, atau langsung melalui API Katalog menggunakan operasi DescribeChangeSet API.

  • Jika status eksekusi set perubahan adalahSUCCEEDED: Entitas baru Identifier (atauEntityId) dihasilkan. Anda dapat menggunakan operasi DescribeEntityAPI pada entitas produk untuk memeriksa hasilnya.

  • Jika status eksekusi set perubahan adalahCLIENT_ERROR: DescribeChangeSet Respons memberikan rincian kesalahan, serta tindakan terkait yang harus diambil untuk memperbaiki kesalahan.

Kesalahan Asinkron

Kesalahan berikut khusus untuk AddRegions tindakan diAWS 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.

Kode kesalahan Pesan kesalahan
INVALID_REGIONS Wilayah yang diminta [a, b, c] tidak valid atau tidak tersedia. Hanya nilai yang didukung adalah [x, y, z].
INVALID_INPUT Daerah tidak bisa kosong.

BatasiWilayah AWS

Anda dapat menggunakan API Katalog untuk membatasi sebelumnya yang didukung Wilayah AWS untuk AMI-based produk Anda diAWS Marketplace.

catatan

Untuk informasi selengkapnya tentang membatasi Wilayah yang didukung sebelumnya menggunakanPortal Manajemen AWS Marketplace, lihat Membatasi Wilayah AWS di Panduan AWS MarketplacePenjual.

catatan

Jenis RestrictRegions perubahan hanya tersedia diAmiProduct@1.0.

Untuk membatasi Wilayah yang didukung sebelumnya, panggil operasi StartChangeSet API dengan tipe RestrictRegions perubahan, seperti yang ditunjukkan pada contoh berikut.

Permintaan Sintaks

POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "RestrictRegions", "DetailsDocument": { "Regions": [ "us-east-1", "ap-northeast-2" ] }, "Entity": { "Identifier": "prod-123456@1", "Type": "AmiProduct@1.0" } } ] }

Berikan informasi untuk bidang untuk menambahkan jenis AddRegions perubahan.

  • Entity(objek) (wajib) — AMI-based Produk Anda.

    • Identifier(string) (wajib) — ID produk Anda. Untuk informasi selengkapnya, lihat Pengidentifikasi.

    • Type(string) (wajib) — Type Ini didasarkan pada metode pengiriman (jenis produk) yang akan digunakan produk Anda:AmiProduct@1.0.

  • DetailsDocument(objek) (wajib) - Detail yang diperlukan untuk mengeksekusi ChangeSet.

    • Regions— Array string

      Nilai yang didukung elemen: String Wilayah AWS kode yang valid, seperti"us-east-1".

Sintaks Respon

Set perubahan dibuat untuk permintaan Anda. Respons terhadap permintaan ini memberi Anda ChangeSetId dan ChangeSetArn untuk set perubahan dan terlihat seperti berikut.

{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }

Permintaan perubahan ditambahkan ke antrian dan diproses. Ini termasuk memvalidasi informasi untuk memastikannya memenuhi AWS Marketplace pedoman. Proses validasi dapat berlangsung dari beberapa menit hingga beberapa jam.

Anda dapat memeriksa status permintaan melaluiPortal Manajemen AWS Marketplace, atau langsung melalui API Katalog menggunakan operasi DescribeChangeSet API.

  • Jika status eksekusi set perubahan adalah SUCCEEDED - Entitas baru Identifier (atauEntityId) dihasilkan. Anda dapat menggunakan DescribeEntity pada entitas produk untuk memeriksa hasilnya. Untuk informasi selengkapnya, lihat DescribeEntity.

  • Jika status eksekusi set perubahan adalahCLIENT_ERROR: DescribeChangeSet Respons memberikan rincian kesalahan, serta tindakan terkait yang harus diambil untuk memperbaiki kesalahan.

Kesalahan Asinkron

Kesalahan berikut khusus untuk AddRegions tindakan diAWS 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.

Kode kesalahan Pesan kesalahan
INVALID_REGIONS Wilayah yang diminta [a, b, c] tidak valid atau tidak tersedia. Hanya nilai yang didukung adalah [x, y, z].
INVALID_INPUT Daerah tidak bisa kosong.

Menambahkan jenis instance baru

Anda dapat menggunakan API Katalog untuk menambahkan jenis instans baru untuk AMI-based produk AndaAWS Marketplace.

catatan

Untuk informasi selengkapnya tentang menambahkan jenis instance menggunakanPortal Manajemen AWS Marketplace, lihat Menambahkan instance di Panduan AWS Marketplace Penjual.

AddInstanceTypesakan menambahkan jenis instance baru ke produk yang ada dan produk yang baru dibuat saat membuat produk. Jenis perubahan akan memperbarui semua versi dalam dokumen produk dengan jenis instance baru.

catatan

Jenis AddInstanceTypes perubahan hanya tersedia diAmiProduct@1.0.

Saat menambahkan tipe instans terbatas, tipe instance dapat dihapus dari daftar terbatas dan ditambahkan ke daftar tipe instance yang tersedia. Ini memberi penjual lebih banyak kontrol untuk mengubah pembatasan produk mereka. Daftar tipe instance dapat dipertukarkan dan bukan status terbatas permanen untuk suatu produk.

Untuk produk yang diukur secara internal, penjual perlu memanggil jenis perubahan terpisah AddDimensions dan memperbarui harga UpdatePricingTerms untuk jenis instans.

Untuk menambahkan jenis instance baru, panggil operasi StartChangeSet API dengan tipe RestrictRegions perubahan, seperti yang ditunjukkan pada contoh berikut.

Permintaan Sintaks

Hanya jenis AddInstanceTypes perubahan yang ditunjukkan di bawah ini. Meskipun penjual AMI yang diukur secara internal diharuskan untuk menelepon AddInstanceTypes dan UpdatePricingTerms mengubah tipe untuk AMI mereka.

POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "AddInstanceTypes", "Entity": { "Identifier": "prod-example12345", "Type": "AmiProduct@1.0" }, "DetailsDocument": { "InstanceTypes": [ "m1.medium" ] } } ] }

Berikan informasi untuk bidang untuk menambahkan jenis AddInstanceTypes perubahan:

  • Entity(objek) (wajib) — AMI-based Produk Anda.

    • Identifier(string) (wajib) — ID produk Anda. Untuk informasi selengkapnya, lihat Pengidentifikasi.

    • Type(string) (wajib) — Type Ini didasarkan pada metode pengiriman (jenis produk) yang akan digunakan produk Anda:AmiProduct@1.0.

  • DetailsDocument(objek) (wajib) — Rincian yang diperlukan untuk mengeksekusiChangeSet, dalam hal iniInstanceTypes.

    • InstanceTypes(array string) (wajib) - Daftar InstanceTypes untuk ditambahkan ke produk. Contoh ini akan ditambahkan ke yang adaInstanceTypes.

Sintaks Respon

Set perubahan dibuat untuk permintaan Anda. Respons terhadap permintaan ini memberi Anda ChangeSetId dan ChangeSetArn untuk set perubahan dan terlihat seperti berikut.

{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }

Permintaan perubahan ditambahkan ke antrian dan diproses. Ini termasuk memvalidasi informasi untuk memastikannya memenuhi AWS Marketplace pedoman. Proses validasi dapat berlangsung dari beberapa menit hingga beberapa jam.

Anda dapat memeriksa status permintaan melaluiPortal Manajemen AWS Marketplace, atau langsung melalui API Katalog menggunakan operasi DescribeChangeSet API.

Validasi sinkron

Validasi skema berikut khusus untuk AddInstanceTypes tindakan di. AWS Marketplace Catalog API Validasi ini dilakukan saat Anda menelepon. StartChangeSet Jika permintaan tidak memenuhi persyaratan berikut, itu akan gagal dengan respons HTTP.

Bidang masukan Aturan validasi HTTP
InstanceTypes Diperlukan 422
InstanceTypes Tidak boleh kosong 422
InstanceTypes Entri harus antara 1 hingga 24 karakter. Harus cocok ^ [A-Za-z0-9_.-] +$ 422
InstanceTypes Entri harus unik 422
InstanceTypes Tidak boleh lebih dari 1500 entri 422
Properti yang tidak diketahui Properti tambahan tidak diperbolehkan 422

Kesalahan Asinkron

Kesalahan berikut khusus untuk AddInstanceTypes tindakan diAWS 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.

Kode kesalahan Pesan kesalahan
INVALID_INSTANCE_TYPES Jenis contoh berikut tidak valid: [x]
INVALID_INSTANCE_VIRTUALIZATION Virtualisasi produk adalah [x]. Hal ini tidak didukung oleh jenis contoh berikut: [x]
INVALID_AMI_ARCHITECTURE Arsitektur CPU dari produk adalah '%s'.” + “Hal ini tidak didukung oleh jenis contoh berikut: [x]
INCOMPATIBLE_OPERATING_SYSTEM Jenis instance tidak kompatibel dengan OS yang ditentukan dalam produk. Berikan jenis instance yang kompatibel dengan OS yang ditentukan dalam produk.
INVALID_PRODUCT_TYPE Gunakan produk AMI tunggal yang ada.
INVALID_ENA_SETTING Produk ini tidak mendukung ENA. Dukungan ENA diperlukan oleh jenis contoh berikut: [x]
INVALID_DIMENSIONS Tidak ada dimensi terukur internal yang ditemukan untuk tipe contoh: [x]
HILANG_DIMENSI_ Tidak ada dimensi yang ditemukan untuk produk. AddDimensions diperlukan sebelumnya AddInstanceTypes.
UPDATE_PRICING_REQUIRED UpdatePricingTerms jenis perubahan diperlukan ketika dimensi terukur internal tersedia pada produk.

Batasi jenis instance

Anda dapat menggunakan API Katalog untuk membatasi atau membatasi jenis instans yang tersedia untuk AMI-based produk Anda. AWS Marketplace

catatan

Untuk informasi selengkapnya tentang membatasi atau membatasi jenis instans yang tersedia menggunakanPortal Manajemen AWS Marketplace, lihat Membatasi instance di Panduan AWS MarketplacePenjual.

Pelanggan yang ada tidak akan terpengaruh oleh perubahan ini dan mereka dapat menggunakan jenis instans terbatas. Namun, tidak ada pembeli baru yang dapat menggunakan jenis instans terbatas. Untuk menghentikan langganan jenis instans saat ini (setelah jenis instans dibatasi), Anda harus menghubungi Tim Operasi AWS Marketplace Penjual.

RestrictInstanctTypesmembatasi jenis instance untuk semua versi dalam dokumen produk. Dalam jenis AddInstanceTypes perubahan, Anda memperbarui semua versi produk. Anda tidak akan dapat membatasi jenis instans yang direkomendasikan. Jenis instans yang disarankan ada di tingkat versi, jadi ada kemungkinan penjual tidak akan dapat membatasi beberapa jenis instance.

Untuk produk yang diukur secara internal, Anda perlu memanggil jenis perubahan terpisah saat menelepon. RestrictDimensions Ini mencegah penawaran baru dibuat untuk jenis instans terbatas.

catatan

Jenis RestrictInstanceTypes perubahan hanya tersedia diAmiProduct@1.0.

Untuk membatasi atau membatasi jenis instance yang tersedia untuk AMI-based produk Anda, panggil operasi StartChangeSet API dengan tipe RestrictInstanceTypes perubahan, seperti yang ditunjukkan pada contoh berikut.

Permintaan Sintaks

POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "RestrictInstanceTypes", "Entity": { "Identifier": "prod-example12345", "Type": "AmiProduct@1.0" }, "DetailsDocument": { "InstanceTypes": [ "m1.medium" ] } } ] }

Berikan informasi untuk bidang untuk menambahkan jenis RestrictInstanceTypes perubahan.

  • Entity(objek) (wajib) — AMI-based Produk Anda.

    • Identifier(string) (wajib) — ID produk Anda. Untuk informasi selengkapnya, lihat Pengidentifikasi.

    • Type(string) (wajib) — Type Ini didasarkan pada metode pengiriman (jenis produk) yang akan digunakan produk Anda:AmiProduct@1.0.

  • DetailsDocument(objek) (wajib) — Rincian yang diperlukan untuk mengeksekusiChangeSet, dalam hal iniInstanceTypes.

    • InstanceTypes(array string) (wajib) — Daftar InstanceTypes untuk membatasi produk. Instance ini ditambahkan ke saat ini (atau jika tidak ada jenis instance yang ada, itu akan ditambahkan) ke restrictedInstanceTypes.

Sintaks Respon

Set perubahan dibuat untuk permintaan Anda. Respons terhadap permintaan ini memberi Anda ChangeSetId dan ChangeSetArn untuk set perubahan dan terlihat seperti berikut.

{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }

Permintaan perubahan ditambahkan ke antrian dan diproses. Ini termasuk memvalidasi informasi untuk memastikannya memenuhi AWS Marketplace pedoman. Proses validasi dapat berlangsung dari beberapa menit hingga beberapa jam.

Anda dapat memeriksa status permintaan melaluiPortal Manajemen AWS Marketplace, atau langsung melalui API Katalog menggunakan operasi DescribeChangeSet API.

Validasi sinkron

Validasi skema berikut khusus untuk RestrictInstanceTypes tindakan di. AWS Marketplace Catalog API Validasi ini dilakukan saat Anda menelepon. StartChangeSet Jika permintaan tidak memenuhi persyaratan berikut, itu akan gagal dengan respons HTTP.

Bidang masukan Aturan validasi HTTP
InstanceTypes Diperlukan 422
InstanceTypes Tidak boleh kosong 422
InstanceTypes Entri harus antara 1 hingga 24 karakter. Harus cocok ^ [A-Za-z0-9_.-] +$ 422
InstanceTypes Entri harus unik 422
InstanceTypes Tidak boleh lebih dari 1500 entri 422
Properti yang tidak diketahui Properti tambahan tidak diperbolehkan 422

Kesalahan Asinkron

Kesalahan berikut khusus untuk RestrictInstanceTypes tindakan diAWS 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.

Kode kesalahan Pesan kesalahan
INSTANCE_TYPES TIDAK VALID Jenis contoh berikut tidak valid: [x]
PRODUCT_TYPE TIDAK VALID Gunakan produk AMI tunggal yang ada.
DUPLIKATE_INSTANCE_TYPE Berikan tipe instance tanpa duplikat.
UNAVAILABLE_INSTANCE_TYPE Berikan jenis instance yang tersedia.
DIREKOMENDASIKAN_INSTANCE_TYPE_RESTRICTED Jenis contoh berikut tidak dapat dibatasi. Jenis instans yang disarankan harus diubah ke yang berbeda sebelum dibatasi. Pilihan Pengiriman Id [X] Jenis Instance [X]
DIMENSIONS_NOT_RESTICTED Batasi dimensi sebelum membatasi jenis instance yang diukur secara internal: [x]
REGION_NO_INSTANCES Jenis instans terbatas Anda akan menyebabkan kegagalan peluncuran produk di wilayah: X. Pertimbangkan untuk membatasi lebih sedikit instance.
INCOMPATIBLE_RESTRICTION Jenis instans terbatas Anda akan menyebabkan produk tanpa tipe instans berbasis FPGA untuk AFI. Produk perlu mendukung setidaknya satu jenis instans berbasis FPGA.