Buat produk Perbarui detail produk Tambahkan dimensi harga Perbarui dimensi harga Batasi dimensi harga Perbarui konfigurasi penargetan Perbarui visibilitas produk Publikasikan produk Temukan ID produk Anda Ubah status dan kesalahan yang disetel

Bekerja dengan produk penjual

Anda dapat menggunakan AWS Marketplace Catalog API untuk mengotomatiskan tugas untuk bekerja dengan produk penjual. Ini termasuk kemampuan untuk membuat, memperbarui, melihat, daftar, dan mengurutkan produk. Ini memungkinkan Anda untuk mengotomatiskan manajemen produk. Misalnya, Anda dapat memberikan kemampuan penerbitan swalayan di. Portal Manajemen AWS Marketplace

Produk adalah unit atau sumber daya yang ingin Anda jualAWS Marketplace, sering disebut sebagai produk dasar. Pembeli tidak dapat menggunakan produk dasar hingga Anda menambahkan informasi produk, atribut penerapan, dan informasi penagihan.

Produk menjelaskan informasi produk, atribut penyebaran perangkat lunak, dan mekanisme penagihan dari daftar yang ingin Anda jual. Produk harus dipasangkan dengan penawaran untuk menjadi unit transactable yang dapat Anda jual dan pembeli dapat menggunakannya. AWS Marketplace

Anda juga dapat menggunakan AWS Marketplace Catalog API untuk:

Setiap jenis produk memiliki entitas produk yang berbeda. Entitas dapat berupa produk atau penawaranAWS Marketplace. Jenis dan entitas produk berikut didukung:

Tipe produk	Entitas
Produk Gambar Mesin Amazon (AMI)	`AmiProduct@1.0`
Produk kontainer	`ContainerProduct@1.0`
Perangkat lunak sebagai layanan (SaaS) produk	`SaaSProduct@1.0`
Produk pembelajaran mesin (ML)	`MachineLearningProduct@1.0`

catatan

Single-AMI dengan jenis CloudFormation produk, produk AWS Data Exchange data, dan produk layanan profesional tidak didukung.

Topik berikut mengasumsikan Anda memiliki akses ke API dan telah menyelesaikan prasyarat penjual apa pun, seperti yang dijelaskan dalam. Kontrol akses untukAWS MarketplaceAPI Katalog

Lihat sumber daya berikut:

Untuk memahami dasar-dasar penggunaan API AWS Marketplace Katalog, lihatMenggunakan AWS Marketplace API Katalog.
Untuk lab ujung ke ujung dengan contoh kode kerja, lihat Mengelola produk dengan API di bengkel AWS Marketplacepenjual.
Untuk contoh kode permintaan API, lihat contoh Python dan Java di AWSSampel di. GitHub

Topik berikut menjelaskan cara menggunakan API Katalog untuk melakukan tindakan pada produk Single-AMI, produk berbasis container, atau produk SaaS Anda.

Topik

Buat produk

catatan

Jenis perubahan ini hanya diperlukan ketika Anda berniat untuk membuat entitas produk baru di AWS Marketplace katalog. Tidak diperlukan saat memperbarui produk yang ada.

Anda dapat menggunakan API Katalog untuk membuat dokumen produk AMI, container, machine learning, atau SaaS dengan pengenal (kode produk dan ID produk) di. AWS Marketplace

Anda membuat produk dalam Draft status dengan memanggil operasi StartChangeSet API dengan jenis CreateProduct perubahan.

Jika permintaan Anda berhasil diproses, maka AWS Marketplace Catalog API hasilkan produk dalam Draft status untuk Anda. Ini adalah produk yang tidak lengkap dan tidak terlihat oleh pembeli. AWS Marketplace

Anda kemudian menggunakan jenis Update perubahan untuk menyelesaikan proses pembuatan produk: UpdateInformation, UpdateDimensions, UpdateTargeting, dan UpdateVisibility.

Setelah produk selesai, Anda dapat menggunakan jenis ReleaseProductperubahan untuk menyelesaikan proses pembuatan produk, dan kemudian merilis penawaran. Proses ini memvalidasi seluruh produk dan memindahkan produk ke Limited keadaan.

catatan

Untuk informasi selengkapnya tentang membuat produk menggunakanPortal Manajemen AWS Marketplace, lihat topik berikut di Panduan AWS Marketplace Penjual:

Buat produk Single-AMI Anda

Anda tidak dapat memperbarui AMI untuk versi tersebut. Jika Anda perlu memperbarui AMI, buat versi baru sebagai gantinya.
Membuat produk kontainer
Membuat produk SaaS
Membuat produk pembelajaran mesin

Jika Anda menggunakan Portal Manajemen AWS Marketplace untuk membuat produk, produk akan berada di Staging negara bagian.

Untuk membuat produk dalam Draft status, panggil operasi StartChangeSet API dengan jenis CreateProduct perubahan, seperti yang ditunjukkan pada contoh berikut.

Permintaan Sintaks


POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
"Catalog": "AWSMarketplace",
"ChangeSet": [ 
  { 
    "ChangeType":"CreateProduct",
    "Entity":{
      "Type": "SaaSProduct@1.0" // choose from ["AmiProduct@1.0", "ContainerProduct@1.0", "SaaSProduct@1.0", "MachineLearningProduct@1.0"]
     },
     "DetailsDocument": {
        "ProductTitle": "Test product title set in CreateProduct"
     }
  }
]
}

Berikan informasi untuk bidang untuk menambahkan jenis CreateProduct perubahan. Jenis perubahan ini dapat mengambil ProductTitle atribut, tunduk pada batasan yang sama seperti yang dikirim ke jenis UpdateInformation perubahan.

Entity(object) (required) - Jenis bernama objek yang sedang dibuat.
- Type(string) (wajib) — Type Ini didasarkan pada metode pengiriman (jenis produk) yang akan digunakan produk Anda:AmiProduct@1.0,ContainerProduct@1.0, MachineLearningProduct@1.0 atauSaaSProduct@1.0. Untuk informasi selengkapnya, lihat Pengidentifikasi.
DetailsDocument(objek) (wajib) — Mungkin kosong.
- ProductTitle(opsional) - Judul untuk produk Anda, panjang maksimal adalah 72 karakter. Perhatikan bahwa Anda juga dapat mengatur atau memperbarui judul produk nanti melalui jenis UpdateInformation perubahan.

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.

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

Ketika permintaan selesai (jika Status adaSUCCEEDED), yang baru ProductId dihasilkan.

Validasi sinkron

Validasi skema berikut khusus untuk CreateProduct 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	Kode HTTP
ProductTitle (tali)	Panjang maks: 72	400

Kesalahan Asinkron

Kesalahan berikut khusus untuk CreateProduct tindakan diAWS Marketplace Catalog API. Kesalahan ini dikembalikan saat Anda memanggil DescribeChangeSet setelah set perubahan diproses. Untuk detail selengkapnya tentang penggunaan DescribeChangeSet untuk mendapatkan status permintaan perubahan, lihatBekerja dengan set perubahan.

Kode kesalahan	Pesan kesalahan
INVALID_INPUT	`Konten '{InappropriateContent}' yang tidak pantas ditemukan di ProductTitle bidang. Berikan ProductTitle tanpa konten yang tidak pantas.`

Perbarui detail produk

Jika Anda sudah memiliki produkAWS Marketplace, Anda dapat menggunakan Catalog API untuk memperbarui detail produk untuk produk AMI, container, ML, atau SaaS.

catatan

Untuk informasi selengkapnya tentang memperbarui detail produk menggunakanPortal Manajemen AWS Marketplace, lihat topik berikut di Panduan AWS Marketplace Penjual:

AMI-based produk: Perbarui informasi produk
Container-based produk: Membuat atau memperbarui informasi produk untuk produk kontainer Anda
SaaS-based produk: Perbarui informasi produk
Produk pembelajaran mesin: Memperbarui informasi produk

Untuk memperbarui detail produk, panggil operasi StartChangeSet API dengan jenis UpdateInformation perubahan dan detail yang ingin Anda ubah, seperti yang ditunjukkan pada contoh berikut.

Permintaan Sintaks


POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateInformation",
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "AmiProduct@1.0"
      },
      "DetailsDocument":
      {
        "ProductTitle": "My Product Title",
        "ShortDescription": "My product short description.",
        "LongDescription": "My product longer description.",
        "Sku": "123example456",
        "LogoUrl": "https://awsmp-logos.s3.amazonaws.com/ca60b754fe05a24257176cdbf31c4e0d",
        "VideoUrls":
        [
          "https://example.com/my-video"
        ],
        "Highlights":
        [
          "123example45"
        ],
        "AdditionalResources":
        [
          {
            "Text": "123example456",
            "Url": "https://example.com/some-link"
          }
        ],
        "SupportDescription": "Need help? Contact our experts at support@example.com \n\nYour purchase includes 24x7 support.",
        "Categories":
        [
          "Operating Systems",
          "Network Infrastructure",
          "Application Development"
        ],
        "SearchKeywords":
        [
          "123example456"
        ]
      }
    }
  ]
}

Berikan informasi untuk bidang untuk menambahkan jenis UpdateInformation perubahan:

Entity(object) (required) - Jenis entitas bernama yang sedang dibuat.
- 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,ContainerProduct@1.0,MachineLearningProduct@1.0, atauSaaSProduct@1.0.
DetailsDocument(objek) (wajib) — Rincian permintaan termasuk informasi yang ingin Anda perbarui untuk produk Anda. Setiap bidang bersifat opsional, tetapi Anda harus menyertakan setidaknya satu perubahan untuk memperbarui.
- ProductTitle(string) — Nama produk yang akan ditampilkan kepada pembeli.
- ShortDescription(string) — Deskripsi aspek-aspek kunci dari produk yang akan ditampilkan kepada pembeli. Ini biasanya 2-3 kalimat.
- LongDescription(string) — Deskripsi produk Anda yang lebih panjang untuk ditampilkan kepada pembeli. Ini biasanya 1-3 paragraf.
- Sku(string atau null) — String bentuk bebas yang Anda definisikan sebagai referensi untuk Anda gunakan sendiri. Gunakan null untuk menghapus bidang ini.
- LogoUrl(string) — URL ke gambar dalam bucket Amazon Simple Storage Service (Amazon S3) yang dapat diakses publik. Untuk informasi lebih lanjut, lihat Persyaratan logo perusahaan dan produk.
- VideoUrls(array string) - Daftar URL untuk video yang tersedia untuk umum dan dihosting secara eksternal untuk disediakan sebagai referensi kepada pembeli dalam informasi produk Anda.
  
  catatan
  Saat ini, AWS Marketplace mendukung satu URL dalam array.
- Highlights(array string) - Daftar callout singkat untuk fitur produk utama.
- AdditionalResources(array struktur) — Daftar referensi ke sumber daya tambahan untuk mempelajari tentang produk Anda. Setiap referensi terdiri dari nama teks dan URL:
  - Text(string) — Nama atau judul sumber daya.
  - Url(string) — URL ke sumber daya yang mungkin berguna bagi pembeli untuk memahami produk Anda.
- SupportDescription(string) - Detail tentang penawaran dukungan Anda untuk produk Anda.
- Categories(array string) — Daftar kategori produk yang AWS Marketplace ditentukan yang menggambarkan produk Anda. Untuk informasi selengkapnya, lihat Kategori produk di Panduan AWS Marketplace Pembeli.
- SearchKeywords(array string) — Daftar kata kunci untuk produk Anda untuk meningkatkan pengalaman pencarian. Nama penjual, nama produk, dan kategori produk secara otomatis disertakan dalam kata kunci pencarian dan tidak perlu diulang di sini.

catatan

Saat Anda awalnya mengisi informasi produk (metadata) untuk suatu Draft produk, Anda harus menyediakan semua hal berikut dalam DetailsDocument objek jenis UpdateInformation perubahan:ProductTitle,,,,ShortDescription,LongDescription,LogoUrl, Highlights AdditionalResourcesSupportDescription, Categories dan. SearchKeywords

ProductTitleDapat dihilangkan jika sudah disediakan selama jenis CreateProduct perubahan. Namun, saat Anda memperbarui bidang yang ada pada produk, Anda hanya dapat menyertakan atribut yang perlu diubah dalam DetailsDocument objek jenis UpdateInformation perubahan.

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.

Untuk memeriksa status permintaan, gunakan Portal Manajemen AWS Marketplace atau panggil DescribeChangeSet API.

Validasi sinkron

Validasi skema berikut khusus untuk UpdateInformation 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	Kode HTTP
String (umum)	Tidak ada karakter kontrol “\\ x00-\\ x08\\ x0b-\\ x1f”	400
ProductTitle (tali)	Panjang maks: 72 Diperlukan	400
ShortDescription (tali)	Panjang maks: 1000 Diperlukan	400
LongDescription (tali)	Panjang maks: 5000 Diperlukan	400
Sku (string)	Panjang maks: 100 Opsional	400
LogoUrl (tali)	Pola URL: ^ https://(www\.)? [-a-z A-Z0 - 9@.] {1,256}\. [a-z A-Z0-9 ()] {2,63}\ b ([-a-za- Z0-9 @+./] *) Diperlukan	400
VideoUrls (array string)	Pola URL: https://(www\\.)? [-a-z A-Z0 - 9@._] {1,256}\\. [a-z A-Z0-9 ()] {2,63}\\ b ([-a-z A-Z0-9 @_ +.\/] Opsional	400
Sorotan (array string)	Diperlukan: Min 1 - Maks 3	400
AdditionalResources (array struktur)	Panjang maks: 500 Opsional	400
SupportDescription (tali)	Panjang maks: 2000 Diperlukan	400
Kategori (array string)	Min 1 - Maks 3 Diperlukan	400
SearchKeywords (array string)	Min 1 - Maks 15 Maks 50 karakter untuk setiap item Diperlukan	400

Kesalahan Asinkron

Kesalahan berikut khusus untuk UpdateInformation 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
HILANG_DATA	`Tidak ada data yang disediakan untuk melakukan pembaruan. Berikan data untuk setidaknya 1 bidang produk.`
INVALID_INPUT	`Menyediakan LogoUrl.`
INVALID_INPUT	`Menyediakan ProductTitle.`
INVALID_INPUT	`Menyediakan ShortDescription.`
INVALID_INPUT	`Menyediakan LongDescription.`
INVALID_INPUT	`Menyediakan SupportDescription.`
INVALID_INPUT	`Berikan setidaknya satu kata kunci pencarian.`
INVALID_INPUT	`Berikan setidaknya satu sorotan.`
INVALID_INPUT	`Menyediakan antara 1 dan 3 kategori produk.`
INVALID_INPUT	`Konten '{InappropriateContent}' yang tidak pantas ditemukan di ProductTitle bidang. Berikan ProductTitle tanpa konten yang tidak pantas.`
INVALID_INPUT	`Konten '{InappropriateContent}' yang tidak pantas ditemukan di ShortDescription bidang. Berikan ShortDescription tanpa konten yang tidak pantas.`
INVALID_INPUT	`Konten '{InappropriateContent}' yang tidak pantas ditemukan di LongDescription bidang. Berikan LongDescription tanpa konten yang tidak pantas.`
INVALID_INPUT	`Konten '{InappropriateContent}' yang tidak pantas ditemukan di SupportDescription bidang. Berikan SupportDescription tanpa konten yang tidak pantas.`
INVALID_INPUT	`Bidang tidak valid ProductTitle . Hapus spasi sebelum simbol merek dagang.`
INVALID_INPUT	`Bidang tidak valid ShortDescription . Hapus spasi sebelum simbol merek dagang.`
INVALID_INPUT	`Bidang tidak valid LongDescription . Hapus spasi sebelum simbol merek dagang.`
INVALID_INPUT	`Bidang tidak valid SupportDescription . Hapus spasi sebelum simbol merek dagang.`
INVALID_INPUT	`Bidang tidak valid ProductTitle . Hapus karakter yang tidak didukung [UnsupportedCharacters].`
INVALID_INPUT	`Bidang tidak valid ShortDescription . Hapus karakter yang tidak didukung [UnsupportedCharacters].`
INVALID_INPUT	`Bidang tidak valid LongDescription . Hapus karakter yang tidak didukung [UnsupportedCharacters].`
INVALID_INPUT	`Bidang tidak valid SupportDescription . Hapus karakter yang tidak didukung [UnsupportedCharacters].`
INVALID_INPUT	`Kata kunci pencarian harus tidak lebih dari 250 karakter gabungan.`
INVALID_INPUT	`Masukan untuk jenis perubahan ini tidak dapat dibaca. Kirim input yang diformat dengan benar.`
INVALID_ADDITIONAL_RESOURCES	`URL tidak valid di AdditionalResources: [InvalidAdditionalResourcesUrls] Berikan URL yang valid.`
INVALID_CATEGORY_NAMES	`Berikan nama kategori valid yang didukung olehAWS Marketplace.`
InvalidImageProperties	`Kesalahan validasi ditemukan: File ini bukan tipe gambar. Jenis gambar yang didukung: [png\|jpg\|gif].`
KONTEN EKSPLISIT	`Konten eksplisit: '{ExplicitContent}' terdeteksi. Menyediakan media tanpa konten eksplisit.`
INVALID_MEDIA	`URL tidak valid: {MediaUrl} Berikan URL baru untuk media yang disimpan di S3.`
INVALID_MEDIA	`URL tidak valid: {MediaUrl} Berikan URL valid yang tidak melebihi 2048 karakter.`
INVALID_MEDIA	`Lokasi yang disediakan tidak dapat diakses: {MediaUrl} Berikan URL yang dapat diakses untuk media yang disimpan di S3.`
INVALID_MEDIA	`Ada masalah menyalin media dari S3. Ukuran gambar melebihi 5 MB. Berikan gambar yang di bawah 5 MB.`
INVALID_MEDIA	`Malware terdeteksi di media. Silakan kirim ulang media tanpa malware.`
JUGA_BANYAK_MEDIA	`Berikan tidak lebih dari 15 item media.`
DUPLIKAT_MEDIA	`Media duplikat tidak diperbolehkan untuk suatu produk. Harap berikan media tanpa duplikat.`

Tambahkan dimensi harga

Anda dapat menggunakan Tindakan Layanan Katalog AWS Marketplace untuk menambahkan dimensi harga yang dapat ditagih yang memungkinkan Anda menagih pengguna untuk produk AMI, kontainer, atau SaaS.

Dimensi harga adalah satuan ukuran yang ditentukan penjual untuk menagih pembeli. Penjual harus mengatur informasi ini untuk menagih pembeli untuk menggunakan produk, apakah itu model penetapan harga berbasis penggunaan atau berbasis kontrak. Jenis dimensi tergantung pada model harga produk.

catatan

Untuk produk SaaS dengan model harga Gratis, Anda harus membuat setidaknya satu dimensi dengan UsageBasedPricingTerm atau ConfigurableUpfrontPricingTerm, dan semua dimensi harus dihargai $0,00. Persyaratan ini unik untuk produk SaaS dan tidak berlaku untuk produk AMI, kontainer, atau pembelajaran mesin.

catatan

Dimensi harga baru memiliki dampak berikut pada pembeli SaaS:

Untuk pembeli dengan perjanjian yang dibuat dari penawaran publik, Anda dapat melaporkan konsumsi pada dimensi baru meskipun mereka tidak ada dalam penawaran ketika perjanjian dibuat.
Untuk pembeli dengan perjanjian yang dibuat dari penawaran pribadi, Anda tidak dapat melaporkan konsumsi pada dimensi baru karena mereka tidak ada dalam penawaran pribadi ketika perjanjian dibuat. Panggilan ke BatchMeterUsageAPI akan berhasil, tetapi pembeli tidak akan ditagih, jadi Anda harus melacak pembeli mana yang dapat dan tidak dapat ditagih untuk dimensi baru apa pun. Anda juga dapat menggunakan GetAgreementTermsAPI untuk melihat dimensi yang disertakan dalam setiap perjanjian pembeli.

Untuk melaporkan konsumsi pada dimensi baru dan menagih pembeli, Anda harus memperpanjang penawaran pengganti yang mencakup dimensi, dan pembeli harus menerima penawaran tersebut.

Untuk informasi selengkapnya tentang harga produk, lihat topik berikut di Panduan AWS Marketplace Penjual:

Untuk informasi selengkapnya tentang menambahkan dimensi harga menggunakanPortal Manajemen AWS Marketplace, lihat topik berikut di Panduan AWS Marketplace Penjual:

AMI-based produk: Perbarui harga.
Container-based produk: Menambahkan dimensi harga.
SaaS-based produk: Tambahkan dimensi harga.
Produk ML: Tidak didukung. Produk pembelajaran mesin memiliki dimensi harga tetap. Namun, Anda dapat memperbarui harga.

Untuk menambahkan dimensi harga, panggil StartChangeSet API dengan tipe AddDimensions perubahan, seperti yang ditunjukkan pada contoh berikut.

catatan

Setelah mengirimkan jenis AddDimensions perubahan pertama dengan dimensi yang menentukan jenis model penetapan harga — penggunaan, kontrak, atau kontrak dengan konsumsi — Anda harus bekerja sama dengan tim Operasi Penjual. AWS Marketplace Mereka membantu Anda menambahkan dimensi dengan tipe yang berada di luar model harga asli.

Permintaan Sintaks


POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "AddDimensions",
      "DetailsDocument":
      [
        {
          "Description": "Description of the dimension",
          "Key": "UniqueApiKey",
          "Unit": "HostHrs",
          "Name": "First Dimension",
          "Types":
          [
            "ExternallyMetered"
          ]
        }
      ],
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "SaaSProduct@1.0"
      }
    }
  ]
}

Berikan bidang berikut untuk jenis AddDimensions perubahan.

DetailsDocument(array objek) (wajib) — Detail permintaan.

Description(string) (wajib) - Detail lengkap dimensi yang akan menjadi deskripsi panjang pada halaman tampilan pembeli.
Key(string) (wajib) — Masukkan aspek yang akan digunakan untuk menentukan tarif dalam penawaran. Juga, masukkan dimensi yang dipublikasikan ke AWS Marketplace Metering Service (MMS) jika dimensi tidak dapat diukur secara eksternal. Setelah dimensi dibuat, ini tidak dapat diubah.
Units(string) (wajib) - Jenis unit untuk dimensi. Unit yang memungkinkan adalah Pengguna, Host, GB, MB, TB, Gbps, Mbps, Permintaan, Unit, UserHrs, UnitHrs, Unit,, HostHrs TierHrs, dan. TaskHrs

Name(string) (wajib) - Nama tampilan untuk dimensi di situs web dan tagihan pelanggan.

Types(array string) (wajib) (juga dikenal sebagai Tag) - Ini menunjukkan apakah dimensi mencakup pengukuran, hak, atau dukungan untuk pengukuran eksternal. Ini tidak dapat diubah setelah dimensi dibuat.

Metered— Menunjukkan bahwa jenis penggunaan Platform Perdagangan harus dibuat untuk memungkinkan pengukuran terjadi untuk dimensi ini.
ExternallyMetered— Menunjukkan bahwa dimensi AWS Marketplace Metering Service (MMS) harus dibuat selama penerbitan untuk memungkinkan penjual mengukur melalui SDKAWS.

Entitled— Menunjukkan bahwa hak dapat diberikan untuk dimensi selama penerbitan produk atau penawaran.

Tabel berikut mencantumkan kombinasi dimensi harga dan produk yang didukung.

Jenis dimensi harga	Tipe produk
[`Metered`]	AMI
[`Metered, ExternallyMetered`]	SaaS, Harga AMI/Flexible Konsumsi (FCP) Ketika `ExternallyMetered` muncul, `Metered` adalah masked/inferred.
[`Entitled`]	Kontrak SaaS, Produk ProServ `Entitled`Tag memberikan hak untuk menggunakan tanggal software/service mulai dan berakhir untuk penggunaan. Juga, untuk memberikan hak untuk memiliki diskon penggunaan untuk produk tahunan AMI. Setiap hak diidentifikasi oleh `Dimension Key` in AWS Marketplace Entitlement Service untuk membuat atau memperbarui hak.
[`Metered, ExternallyMetered, Entitled`]	Kontrak dengan harga konsumsi, di mana dimensi dapat dibayar di muka atau diukur, adalah kombinasi dari [`ExternallyMetered`] dan [`Entitled`].

Entity(object) (required) - Jenis entitas bernama yang sedang dibuat.
- 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 atauSaaSProduct@1.0.

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 AddDimensions 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	Kode HTTP
Deskripsi	Panjang maks: 1000 Diperlukan	400
Key	Panjang maks: 100 Pola: [A-Za-z0-9_.-] +$ Diperlukan	400
Unit Dimensi	Panjang maks: 20 Diperlukan	400
Nama	Panjang maks: 500 Diperlukan	400
Jenis (tag)	Diperlukan: Min 1 - Maks 3 Masukan: Berjudul, Terukur, ExternallyMetered Diperlukan	400

Kesalahan Asinkron

Kesalahan berikut khusus untuk AddDimensions 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
HILANG_DATA	`Tidak ada data yang disediakan untuk melakukan pembaruan. Berikan data untuk setidaknya 1 dimensi.`
INVALID_DIMENSION	`Berikan tidak lebih dari 200 dimensi.`
INVALID_DIMENSION	`Tidak dapat menambahkan dimensi duplikat.`
INVALID_DIMENSION	`Dimensi tidak dapat ditambahkan dalam keadaan '%s' saat ini. Status yang mendukung pemutakhiran dimensi adalah %s.`
INVALID_DIMENSION	`Tidak dapat menambahkan dimensi. Bidang '%s' memiliki nilai duplikat '%s' di dimensi lain.`
INVALID_DIMENSION	`Berikan bidang yang tidak kosong (Kunci, Unit, Nama, Jenis) untuk setiap dimensi.`
IINVALID_TYPE	`Hapus tipe '%s' tidak valid. Jenis yang valid adalah ["Metered”, “Judul”, "ExternallyMetered“].`
INVALID_UNIT	`Hapus Unit '%s' tidak valid. Unit yang valid adalah ["GB”, “Gbps”, "HostHrs“, “Host”, “MB”, “Mbps”, “Permintaan”, "TaskHrs“, “TB”, "TierHrs“," UnitHrs “, “Unit”, "UserHrs“, “Pengguna"].`
INVALID_INPUT	`Konten '%s' yang tidak pantas ditemukan di kolom %s. Berikan %s tanpa konten yang tidak pantas.`
INVALID_INPUT	`Kolom '%s' tidak valid. Hapus spasi sebelum simbol merek dagang.`
INVALID_INPUT	`Kolom '%s' tidak valid. Hapus karakter %s yang tidak didukung.`
INVALID_DIMENSION	`Hapus kombinasi tipe dimensi %s yang tidak valid. Nilai yang diizinkan adalah %s.`
INVALID_DIMENSION	`Hapus kunci dimensi '%s' tidak valid untuk dimensi Terukur.`
INVALID_DIMENSION	`Dimensi bernama '%s' untuk ProductCode '%s' tidak AWS Marketplace melewati validasi Metering Service %s.`
INVALID_DIMENSION	`Dimensi bernama '%s' untuk ProductCode '%s' tidak memiliki catatan pengukuran di Metering Service. Produk tidak pernah diluncurkan untuk pengujian atau salah konfigurasi dan tidak melakukan panggilan yang sesuai ke Layanan AWS Marketplace Pengukuran.`

Perbarui dimensi harga

Anda dapat menggunakan API Katalog untuk memperbarui dimensi harga yang ada dari produk AMI, container, atau SaaS. AWS Marketplace

Setiap dimensi diidentifikasi secara unik oleh kunci dimensi dan tipe dimensi untuk melakukan pembaruan. Memperbarui dimensi tidak memengaruhi penawaran aktif atau pelanggan apa pun yang dibuat oleh dimensi asli.

catatan

Untuk informasi selengkapnya tentang memperbarui dimensi harga menggunakanPortal Manajemen AWS Marketplace, lihat topik berikut di Panduan AWS Marketplace Penjual:

AMI-based produk: Perbarui harga
Container-based produk: Memperbarui informasi dimensi
SaaS-based produk: Memperbarui dimensi harga
Produk pembelajaran mesin: Perbarui harga produk

Untuk memperbarui dimensi harga, panggil operasi StartChangeSet API dengan jenis UpdateDimensions perubahan, seperti yang ditunjukkan pada contoh berikut.

Permintaan Sintaks


POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateDimensions",
      "DetailsDocument":
      [
        {
          "Key": "UniqueApiKey",
          "Types":
          [
            "ExternallyMetered"
          ],
          "Name": "First Dimension",
          "Description": "Description of the dimension"
        }
      ],
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "SaaSProduct@1.0"
      }
    }
  ]
}

Gunakan bidang berikut dengan jenis UpdateDimensions perubahan:

DetailsDocument(array objek) (wajib) — Detail permintaan.

Key(string) (wajib) - Berikan kunci dimensi yang ada dari produk untuk mengubah deskripsi dan nama. SebabUpdateDimension, bidang ini hanya untuk mengidentifikasi dimensi yang akan diubah.

Types(array string) (wajib) (juga dikenal sebagai Tag) - Ini menunjukkan apakah dimensi mencakup pengukuran, hak, atau dukungan untuk pengukuran eksternal. Ini tidak dapat diubah setelah dimensi dibuat.

Metered— Menunjukkan bahwa jenis penggunaan Platform Perdagangan harus dibuat untuk memungkinkan pengukuran terjadi untuk dimensi ini.
ExternallyMetered— Menunjukkan bahwa dimensi AWS Marketplace Metering Service (MMS) harus dibuat selama penerbitan untuk memungkinkan penjual mengukur melalui AWS SDK.

Entitled— Menunjukkan bahwa hak dapat diberikan untuk dimensi selama product/offer penerbitan.

Kombinasi Jenis Dimensi Harga yang Valid
Jenis Dimensi Harga	Produk
[`Metered`]	AMI
[`ExternallyMetered`]	SaaS, Harga AMI/Flexible Konsumsi (FCP) Saat `ExternallyMetered` muncul, Metered adalah masked/inferred.
[`Entitled`]	Kontrak SaaS, Produk ProServe `Entitled`Tag memberikan hak untuk menggunakan tanggal mulai dan akhir yang software/service ditetapkan untuk penggunaan. Juga, untuk memberikan hak untuk memiliki diskon penggunaan untuk produk tahunan AMI. Setiap hak diidentifikasi oleh Kunci Dimensi AWS Marketplace Entitlement Service untuk membuat atau memperbarui hak.
[`ExternallyMetered, Entitled`]	Kontrak dengan Harga Konsumsi, di mana dimensi dapat dibayar di muka atau diukur adalah kombinasi dari [`ExternallyMetered`] dan [`Entitled`].

Description(string) (opsional — Deskripsi lengkap tentang dimensi yang akan menjadi deskripsi panjang pada halaman tampilan pembeli.
Name(string) opsional - Nama tampilan untuk dimensi di situs web dan tagihan pelanggan.

Entity(object) (required) - Jenis entitas bernama yang sedang dibuat.
- 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 atauSaaSProduct@1.0.

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

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 UpdateDimensions 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	Kode HTTP
Deskripsi	Panjang maks: 1000 Diperlukan	400
Key	Panjang maks: 100 Pola: [A-Za-z0-9_.-] +$ Diperlukan	400
Nama	Panjang maks: 5 Diperlukan	400
Jenis (tag)	Diperlukan: Min 1 - Maks 3 Masukan:`Entitled`,, `Metered` `ExternallyMetered` Diperlukan	422

Kesalahan Asinkron

Kesalahan berikut khusus untuk UpdateDimensions 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_INPUT	`Kolom '%s' tidak valid. Hapus spasi sebelum simbol merek dagang.`
INVALID_INPUT	`Kolom '%s' tidak valid. Hapus karakter %s yang tidak didukung.`
INVALID_DIMENSION	`Berikan bidang yang tidak kosong (Key,Types, Name and/orDescription) untuk setiap dimensi.`
INVALID_DIMENSION	`Tidak dapat memperbarui dimensi. Bidang Name memiliki nilai duplikat '%s' di dimensi lain.`
INVALID_DIMENSION	`Tidak dapat memperbarui dimensi yang sama dengan kunci '%s' dan tipe '%s' beberapa kali dalam permintaan yang sama.`
INVALID_DIMENSION	`Tidak dapat membatasi dimensi. Kunci dimensi '%s' dengan tipe '%s' tidak ada.`
INVALID_DIMENSION	`Tidak dapat memperbarui dimensi. Kunci dimensi '%s' adalahMetered.`
INVALID_DIMENSION	`Dimensi tidak dapat diperbarui untuk dimensi yang sudah dibatasi.`

Batasi dimensi harga

Anda dapat menggunakan API Katalog untuk membatasi dimensi harga produk AMI atau SaaS yang ada. AWS Marketplace

Setiap dimensi diidentifikasi secara unik oleh kunci dimensi dan tipe dimensi untuk melakukan pembaruan. Membatasi dimensi tidak memengaruhi penawaran aktif atau pelanggan apa pun yang dibuat oleh dimensi asli.

Untuk membatasi dimensi harga, panggil StartChangeSet API dengan tipe RestrictDimensions perubahan.

catatan

Pembatasan dimensi harga hanya tersedia saat produk dalam keadaan draft. Perubahan tidak diizinkan setelah produk pindah ke negara terbatas atau publik.

Contoh berikut menunjukkan cara membatasi Entitled dimensi untuk produk SaaS.

Permintaan Sintaks


POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "RestrictDimensions",
      "DetailsDocument":
      [
        {
          "Key": "UniqueApiKey",
          "Types": ["Entitled"]
        }
      ],
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "SaaSProduct@1.0"
      }
    }
  ]
}

Gunakan bidang berikut dengan jenis RestrictDimensions perubahan:

DetailsDocument(array objek) (wajib) — Detail permintaan.
- Key(string) (wajib) - Berikan kunci dimensi yang ada dari produk untuk mengubah deskripsi dan nama. SebabRestrictDimensions, bidang ini hanya untuk mengidentifikasi dimensi yang akan diubah.
- Types(array string) (wajib) (juga dikenal sebagai Tag) - Ini menunjukkan apakah dimensi mencakup pengukuran, hak, atau dukungan untuk pengukuran eksternal. Ini tidak dapat diubah setelah dimensi dibuat.
  - ["ExternallyMetered", "Entitled"]— Anda hanya dapat menggabungkan jenis ini untuk Kontrak SaaS dengan harga Konsumsi di mana dimensi dapat dibayar di muka atau diukur.
  - ["Metered"]— Untuk dimensi harga per jam produk AMI. Menunjukkan bahwa jenis penggunaan Platform Perdagangan harus dibuat untuk memungkinkan pengukuran dilakukan untuk dimensi ini.
  - ["ExternallyMetered"]— Untuk dimensi harga konsumsi yang fleksibel (juga dikenal sebagai pengukuran khusus) produk AMI, kontainer, dan SaaS. Menunjukkan bahwa dimensi AWS Marketplace Metering Service (MMS) harus dibuat selama penerbitan untuk memungkinkan penjual mengukur melalui SDKAWS.
  - ["Entitled"]— Untuk dimensi penetapan harga kontrak Kontrak SaaS dan produk layanan profesional. Tag ini memberikan hak untuk menggunakan perangkat lunak atau layanan, menetapkan tanggal mulai dan berakhir untuk penggunaan, dan memberikan hak diskon penggunaan untuk produk tahunan AMI. Setiap hak diidentifikasi oleh Kunci Dimensi AWS Marketplace Entitlement Service untuk membuat dan memperbarui hak. Kuncinya menunjukkan bahwa hak dapat diberikan untuk dimensi selama penerbitan produk dan penawaran.
Entity(object) (required) - Jenis entitas bernama yang sedang dibuat.
- Identifier(string) (wajib) — ID produk Anda. Untuk informasi selengkapnya, lihat Pengidentifikasi.
- Type(string) (wajib) — Type Ini didasarkan pada metode pengiriman produk Anda (jenis produk): AmiProduct@1.0 atauSaaSProduct@1.0.

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

Anda dapat memeriksa status permintaan melaluiPortal Manajemen AWS Marketplace, atau dengan memanggil DescribeChangeSet API.

Validasi sinkron

Validasi skema berikut khusus untuk RestrictDimensions 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	Kode HTTP
Deskripsi	Panjang maks: 1000 Diperlukan	400
Key	Panjang maks: 100 Pola: [A-Za-z0-9_.-] +$ Diperlukan	400
Nama	Panjang maks: 5 Diperlukan	400
Jenis (tag)	Diperlukan: Min 1 - Maks 3 Masukan:`Entitled`,, `Metered` `ExternallyMetered` Diperlukan	400

Kesalahan Asinkron

Kesalahan berikut khusus untuk RestrictDimensions tindakan diAWS Marketplace Catalog API. Kesalahan ini dikembalikan saat Anda memanggil DescribeChangeSet saat set perubahan sedang diproses. Untuk informasi selengkapnya tentang penggunaan DescribeChangeSet untuk mendapatkan status permintaan perubahan, lihatBekerja dengan set perubahan.

Kode kesalahan	Pesan kesalahan
INVALID_INPUT	`Kolom '%s' tidak valid. Hapus spasi sebelum simbol merek dagang.`
INVALID_INPUT	`Kolom '%s' tidak valid. Hapus karakter %s yang tidak didukung.`
INVALID_DIMENSION	`Kunci dimensi '%s' dengan tipe '%s' sudah dibatasi`
INVALID_DIMENSION	`Tidak dapat membatasi dimensi. Kunci dimensi '%s' dengan tipe '%s' tidak ada`
INVALID_DIMENSION	`Tidak dapat membatasi dimensi duplikat.`
INVALID_DIMENSION	`Semua dimensi Berhak tidak dapat dibatasi. Setidaknya harus ada satu dimensi berjudul aktif.`
INVALID_DIMENSION	`Kunci dimensi '%s' dengan tipe '%s' dikaitkan dengan dimensi lain dari tipe yang berbeda '%s'. Kedua dimensi kunci yang sama harus dibatasi pada saat yang sama agar valid.`

Perbarui konfigurasi penargetan

Anda dapat menggunakan API Katalog untuk menambahkan Akun AWS ID yang diizinkan untuk melihat produk AMI, container, ML, atau SaaS AWS Marketplace sebelum dipindahkan ke Public status dengan memanggil jenis UpdateTargeting perubahan.

Akun Operasi Katalog Terkelola (MCO) secara otomatis ditambahkan ke daftar akun yang diizinkan saat produk baru dibuat. Akun MCO ini dapat dilihat oleh penjual di Portal AWS Marketplace Manajemen (AMMP) saat melihat akun yang diizinkan, dan di Targeting bagian respons DescribeEntity API.

catatan

Untuk informasi selengkapnya tentang menambahkan Akun AWS ID menggunakanPortal Manajemen AWS Marketplace, lihat topik berikut di Panduan AWS Marketplace Penjual:

AMI-based produk: Perbarui daftar yang diizinkan (akun pratinjau)
Container-based produk: Memperbarui daftar izin ID akun AWS
SaaS-based produk: Memperbarui daftar izin ID akun AWS
Produk pembelajaran mesin: Memperbarui daftar yang diizinkan

Untuk menambahkan Akun AWS ID yang diizinkan untuk melihat produk AMI, container, ML, atau SaaS, panggil operasi StartChangeSet API dengan tipe UpdateTargeting perubahan, seperti yang ditunjukkan pada contoh berikut.

Permintaan Sintaks


POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateTargeting",
      "Entity":
      {
        "Type": "SaaSProduct@1.0",
        "Identifier": "prod-example12345"
      },
      "DetailsDocument":
      {
        "PositiveTargeting":
        {
          "BuyerAccounts":
          [
            "1112223334444"
          ]
        }
      }
    }
  ]
}

Gunakan bidang berikut dengan jenis UpdateTargeting perubahan.

Entity(object) (required) - Jenis entitas bernama yang sedang dibuat.
- 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,MachineLearningProduct@1.0, atauSaaSProduct@1.0.
DetailsDocument(objek) (wajib) - Detail yang diperlukan untuk menjalankan ChangeSet.
- PositiveTargeting(objek) (opsional) — Penargetan positif mendefinisikan kriteria yang harus dipenuhi oleh profil pembeli mana pun agar diizinkan mengakses penawaran. Bidang ini bersifat opsional, tetapi setidaknya satu opsi penargetan harus disediakan saat bidang ini ada.
  - BuyerAccounts(array string) (opsional) — Daftar sebagai opsi untuk mengizinkan penargetan berdasarkan akun AWS (juga dikenal sebagai, Penawaran Pribadi). Jika tujuannya adalah untuk tidak menargetkan penawaran ke akun AWS, bidang ini harus dihilangkan.

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

Untuk memeriksa status permintaan, gunakan Portal Manajemen AWS Marketplace atau panggil DescribeChangeSet API.

Ketika permintaan selesai (jika Status adaSUCCEEDED), yang baru ProductId dihasilkan.

Validasi sinkron

Validasi skema berikut khusus untuk UpdateTargeting 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.

Jenis penargetan Status visibilitas saat ini yang valid BuyerAccounts (masukan) Memeriksa

Positif

Jenis penargetan	Status visibilitas saat ini yang valid	BuyerAccounts (masukan)	Memeriksa
Positif	Publik,`Limited`, atau `Draft`	Array string Akun AWS ID 12 digit. Ukuran min: 0. Ukuran maks: 5000.	Input harus berbeda dari akun yang ditargetkan dokumen saat ini. Masukan harus validAkun AWS.

Publik,Limited, atau Draft

Array string Akun AWS ID 12 digit.

Ukuran min: 0.

Ukuran maks: 5000.

Input harus berbeda dari akun yang ditargetkan dokumen saat ini.

Masukan harus validAkun AWS.

Kesalahan Asinkron

Kesalahan berikut khusus untuk DescribeChangeSet 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_VISIBILITY	`Gunakan Publik Limited atau Draft produk yang sudah ada.`
TIDAK AWS_ACCOUNT_ID VALID_ S	`Berikan Akun AWS ID yang valid. Akun AWStidak ditemukan: [x, y, z].`
ValidationException	`Produk layanan profesional tidak memiliki daftar izin. Tidak seperti jenis produk lainnya, produk layanan profesional dalam keadaan terbatas dapat diperluas ke pembeli mana pun tanpa memerlukan daftar yang diizinkan.`

Perbarui visibilitas produk

Anda dapat menggunakan API Katalog untuk memperbarui visibilitas (juga dikenal sebagai status siklus hidup) produk AMI, container, ML, atau SaaS di. AWS Marketplace

catatan

Untuk informasi selengkapnya memperbarui visibilitas produk menggunakanPortal Manajemen AWS Marketplace, lihat topik berikut di Panduan AWS Marketplace Penjual:

AMI-based produk: Perbarui visibilitas produk
Container-based produk: Memperbarui visibilitas produk
SaaS-based produk: Perbarui visibilitas produk
Produk pembelajaran mesin: Memperbarui visibilitas produk

Status siklus hidup target yang diizinkan adalahLimited,Public, atau. Restricted

Limited: Produk lengkap dan telah berhasil menyelesaikan ReleaseProductChangeType. Penjual dapat melihat detail produk di negara bagian ini. Produk ini tidak publik. Namun, penjual dapat menargetkan pembeli tertentu untuk memungkinkan pratinjau produk.
Public: Produk terlihat diAWS Marketplace. Pembeli dapat melihat dan berlangganan produk.
Restricted: Produk tidak lagi terlihat oleh publik dan tidak menerima pelanggan baru. Pelanggan yang ada dapat terus menggunakan produk ini hingga langganan mereka berakhir.

catatan

Jenis UpdateVisibility perubahan memerlukan tinjauan manual dari tim Operasi AWS Marketplace Penjual, yang menghasilkan waktu eksekusi yang lebih lama. Gunakan UpdateVisibility secara terpisah dalam set perubahannya sendiri.

Untuk memperbarui visibilitas produk Anda, panggil operasi StartChangeSet API dengan jenis UpdateVisibility perubahan, seperti yang ditunjukkan pada contoh berikut.

Permintaan Sintaks

Untuk kapan TargetVisibility Public atauLimited.


POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateVisibility",
      "Entity":
      {
        "Type": "SaaSProduct@1.0",
        "Identifier": "prod-example12345"
      },
      "DetailsDocument":
      {
        "TargetVisibility": "Public"
      }
    }
  ]
}

Untuk kapan TargetVisibilityRestricted.


POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateVisibility",
      "Entity":
      {
        "Type": "SaaSProduct@1.0",
        "Identifier": "prod-example12345"
      },
      "DetailsDocument":
      {
        "TargetVisibility": "Restricted",
        "ReplacementProductId": "prod-example54321"
      }
    }
  ]
}

Berikan informasi untuk bidang untuk menambahkan jenis UpdateVisibility perubahan.

Entity(object) (required) - Jenis entitas bernama yang sedang dibuat.
- 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,SaaSProduct@1.0,ContainerProduct@1.0,MachineLearningProduct@1.0. Untuk informasi selengkapnya, lihat Pengidentifikasi.
DetailsDocument(objek) (wajib) - Detail yang diperlukan untuk menjalankanChangeSet.
- - TargetVisibility— Visibilitas baru yang dimaksudkan dari produk.
    
    Nilai yang mungkin:Public,Limited, dan Restricted
  - ReplacementProductId(string) (opsional) - ID produk pengganti untuk produk yang akan menjadiRestricted. Digunakan untuk memberi tahu pelanggan saat ini tentang pembatasan produk.
    
    Hanya menerima Restricted untukTargetVisibility.

Validasi sinkron

Validasi skema berikut khusus untuk UpdateVisibility 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.

Jenis penargetan	Status saat ini yang valid	ReplacementProductId (masukan)	Pemeriksaan validasi
Publik	`Limited` dan `Restricted`	Tidak diizinkan	Status saat ini yang valid
`Limited`	Publik dan `Restricted`	Tidak diizinkan	Status saat ini yang valid
`Restricted`	Publik dan `Limited`	String (Opsional)	ReplacementProductId harus milik produk yang sudah ada `Limited` atau Publik.

Setelah memicu jenis perubahan ini, dibutuhkan waktu hingga 37 hari untuk menyelesaikannya. Ini termasuk waktu yang dibutuhkan Tim Operasi AWS Marketplace Penjual untuk meninjau, mengaudit, dan menyetujui. Saat membatasi suatu produk, Anda memiliki waktu 24 jam untuk berubah pikiran, dengan meneleponCancelChangeSet, sebelum Tim Operasi AWS Marketplace Penjual mulai mengaudit. Untuk informasi selengkapnya, lihat CancelChangeSet.

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

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

Ketika permintaan selesai (jika Status adaSUCCEEDED), yang baru ProductId dihasilkan.

Kesalahan Asinkron

Kesalahan berikut khusus untuk UpdateVisibility 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_STATE	`Gunakan Restricted produk atau produk Limited yang sudah adaPublic.`
INVALID_TARGET_VISIBILITY	`Berikan status visibilitas target yang valid:Public,Limited, atauRestricted.`
EMPTY_TARGET_VISIBILITY	`Berikan status visibilitas target yang valid:Public,Limited, atauRestricted.`
INVALID_REPLACEMENT_PRODUCT_ID	`Gunakan Limited produk Public atau produk yang sudah ada sebagai pengganti.`
INVALID_REPLACEMENT_PRODUCT_ID	`ID produk pengganti hanya berlaku ketika membatasi suatu produk.`
AUDIT_ERROR	`Bervariasi berdasarkan tinjauan manual PKP.`
MISSING_SELLER_PROFILE_INFORMATION	Sebelum Anda dapat memperbarui produk Anda ke Publik, Anda harus menambahkan profil publik ke akun penjual Anda.

Publikasikan produk

Anda dapat menggunakan API Katalog untuk memublikasikan produk Draft AMI, container, ML, atau SaaS ke Limited status di. AWS Marketplace

catatan

Untuk AmiProduct@1.0 danSaaSProduct@1.0, jenis ReleaseProduct perubahan harus disertai dengan jenis ReleaseOffer perubahan pada draft Offer@1.0 entitas publik terkait yang dibuat untuk produk ini.

Untuk memublikasikan produk, panggil operasi StartChangeSet API dengan jenis ReleaseProduct perubahan, seperti yang ditunjukkan pada contoh berikut.

Permintaan Sintaks


POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "ReleaseProduct",
      "Entity":
      {
        "Type": "SaaSProduct@1.0",
        "Identifier": "prod-example12345"
      },
      "DetailsDocument": {}
    }
  ]
}

Berikan informasi untuk bidang yang akan ditambahkan ke jenis ReleaseProduct perubahan. Jenis perubahan ini tidak mengambil payload parameter apa pun.

Entity(object) (required) - Jenis entitas bernama yang sedang dibuat.
- 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,SaaSProduct@1.0,ContainerProduct@1.0,MachineLearningProduct@1.0. Untuk informasi selengkapnya, lihat Pengidentifikasi.
DetailsDocument(object) (required) - Harus berupa objek kosong. Jenis perubahan ReleaseProduct tidak menerima detail apa pun.

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

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

Ketika permintaan selesai (jika Status adaSUCCEEDED), yang baru ProductId dihasilkan.

Kesalahan Asinkron

Kesalahan berikut khusus untuk ReleaseProduct 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
VALIDATION_FAILED	`Berikan informasi Deskripsi.`
VALIDATION_FAILED	`Berikan informasi Versi.`
VALIDATION_FAILED	`Berikan informasi Dimensi.`
VALIDATION_FAILED	`Berikan Deskripsi\| PromotionalResources \| SupportInformation informasi.`

Temukan ID produk Anda

Anda harus mendapatkan ID produk untuk produk Anda sebelum dapat memodifikasinya dengan API AWS Marketplace Katalog. Ada dua cara untuk menemukan ID produk untuk produk server:

Buka Portal Manajemen AWS Marketplace dan masuk dengan akun penjual Anda. Dari menu Produk, pilih produk Server, lalu pilih produk yang Anda minati. ID produk tercantum di bagian Ringkasan Produk.
Gunakan ListEntitiestindakan dengan EntityType AmiProduct atauContainerProduct,, SaaSProductMachineLearningProduct, atau DataProduct untuk mendapatkan daftar produk, termasuk ID produk mereka, melalui API Katalog. ListEntitiesmengharuskan Anda tidak menyertakan versi tipe entitas (misalnya,AmiProduct@1.0).

catatan

ID produk hanya tersedia setelah produk Anda dipublikasikan dan setidaknya dapat dilihat oleh Anda sendiriAWS Marketplace. Ketika Anda pertama kali membuat produk Anda, perlu beberapa hari untuk ditinjau dan dibuat sepenuhnya. Selama waktu ini, itu tidak akan memiliki ID produk yang tersedia.

Topik berikut menjelaskan cara menemukan produk dengan memfilter pada id entitas, judul produk, tanggal modifikasi terakhir, atau visibilitas.

Topik

Temukan produk berdasarkan judul produk
Temukan produk berdasarkan tanggal modifikasi terakhir
Temukan produk berdasarkan visibilitas produk
Temukan produk berdasarkan judul produk, tanggal modifikasi terakhir, dan visibilitas produk
Dapatkan detail tambahan tentang suatu produk

Temukan produk berdasarkan judul produk

Permintaan


POST /ListEntities HTTP/1.1
Content-Type: application/json
      
{
    "Catalog": "AWSMarketplace",
    "EntityType": "AmiProduct",
    "MaxResults": 10,
    "EntityTypeFilters": {
        "AmiProductFilters": {
            "ProductTitle": {
                "WildCardValue": "XYZ"
            }
        }
    }
}

Respons



HTTP/1.1 200
Content-type: application/json

{ 
  "EntitySummaryList": [ 
    { 
      "EntityArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/AmiProduct/example-abcd-1234",
      "EntityId": "example1-abcd-1234-5ef6-7890abcdef12@1",
      "EntityType": "AmiProduct",
      "LastModifiedDate": "2018-02-27T13:45:22Z",
       "AmiProductSummary": {
            "ProductTitle": "ABC-XYZ-123",
            "Visibility": "Public"
       }
    } 
  ],
  "NextToken": "" 
}

Temukan produk berdasarkan tanggal modifikasi terakhir

Permintaan


POST /ListEntities HTTP/1.1
Content-Type: application/json
      
{
    "Catalog": "AWSMarketplace",
    "EntityType": "AmiProduct",
    "MaxResults": 10,
    "EntityTypeFilters": {
        "AmiProductFilters": {
            "LastModifiedDate": {
                "DateRange": {
                    "BeforeValue": "2018-03-27T13:45:22Z",
                    "AfterValue": "2018-01-27T13:45:22Z"
                }
            }
        }
    }
}

Respons



HTTP/1.1 200
Content-type: application/json

{ 
  "EntitySummaryList": [ 
    { 
      "EntityArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/AmiProduct/example-abcd-1234",
      "EntityId": "example1-abcd-1234-5ef6-7890abcdef12@1",
      "EntityType": "AmiProduct",
      "LastModifiedDate": "2018-02-27T13:45:22Z",
       "AmiProductSummary": {
            "ProductTitle": "ABC-XYZ-123",
            "Visibility": "Public"
       }
    } 
  ],
  "NextToken": "" 
}

Temukan produk berdasarkan visibilitas produk

Permintaan


POST /ListEntities HTTP/1.1
Content-Type: application/json
      
{
    "Catalog": "AWSMarketplace",
    "EntityType": "AmiProduct",
    "MaxResults": 10,
    "EntityTypeFilters": {
        "AmiProductFilters": {
            "Visibility": {
                "ValueList": [
                    "Public"
                ]
            }
        }
    }
}

Respons



HTTP/1.1 200
Content-type: application/json

{ 
  "EntitySummaryList": [ 
    { 
      "EntityArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/AmiProduct/example-abcd-1234",
      "EntityId": "example1-abcd-1234-5ef6-7890abcdef12@1",
      "EntityType": "AmiProduct",
      "LastModifiedDate": "2018-02-27T13:45:22Z",
       "AmiProductSummary": {
            "ProductTitle": "ABC-XYZ-123",
            "Visibility": "Public"
       }
    } 
  ],
  "NextToken": "" 
}

Temukan produk berdasarkan judul produk, tanggal modifikasi terakhir, dan visibilitas produk

Permintaan


POST /ListEntities HTTP/1.1
Content-Type: application/json
      
{
    "Catalog": "AWSMarketplace",
    "EntityType": "AmiProduct",
    "MaxResults": 10,
    "EntityTypeFilters": {
        "AmiProductFilters": {
            "LastModifiedDate": {
                "DateRange": {
                    "BeforeValue": "2018-03-27T13:45:22Z",
                    "AfterValue": "2018-01-27T13:45:22Z"
                }
            },
            "Visibility": {
                "ValueList": [
                    "Public"
                ]
            },
            "ProductTitle": {
                "ValueList": [
                    "ABC-XYZ-123"
                ]
            }
        }
    }
}

Respons



HTTP/1.1 200
Content-type: application/json

{ 
  "EntitySummaryList": [ 
    { 
      "EntityArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/AmiProduct/example-abcd-1234",
      "EntityId": "example1-abcd-1234-5ef6-7890abcdef12@1",
      "EntityType": "AmiProduct",
      "LastModifiedDate": "2018-02-27T13:45:22Z",
       "AmiProductSummary": {
            "ProductTitle": "ABC-XYZ-123",
            "Visibility": "Public"
       }
    } 
  ],
  "NextToken": "" 
}

Dapatkan detail tambahan tentang suatu produk

Anda bisa mendapatkan detail tambahan tentang produk menggunakan id entitas dengan DescribeEntity tindakan.

Permintaan


GET /DescribeEntity?catalog=AWSMarketplace&entityId=example-abcd-1234 HTTP/1.1

Respons


HTTP/1.1 200
Content-type: application/json

{
   "DetailsDocument": {
        "ProductTitle": "ABC-XYZ-123",
        "ShortDescription": "My product short description.", 
        "LongDescription": "My product longer description.", 
        "Sku": "123example456", 
        "SupportDescription": "Need help? Contact our experts at support@example.com \n\nYour purchase includes 24x7 support.", 
        "Categories": [ 
            "Operating Systems", 
            "Network Infrastructure", 
            "Application Development" 
            ] 
   }
    "EntityArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/AmiProduct/example-abcd-1234",
    "EntityId": "example1-abcd-1234-5ef6-7890abcdef12@1",
    "EntityType": "AmiProduct",
    "LastModifiedDate": "2018-02-27T13:45:22Z",
}

Ubah status dan kesalahan yang disetel

Membuat perubahan pada produk penjual di API AWS Marketplace Katalog melibatkan pembuatan set perubahan yang menjelaskan perubahan yang ingin Anda buat, lalu menggunakan StartChangeSet tindakan untuk memulai perubahan. Perubahan dari permintaan dapat memakan waktu beberapa menit hingga berjam-jam atau lebih lama untuk diselesaikan, tergantung pada permintaan. Respons terhadap permintaan ini terlihat seperti berikut.


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

Permintaan perubahan ditambahkan ke antrian dan diproses, termasuk memindai file dan informasi untuk memastikan bahwa itu memenuhi AWS Marketplace pedoman untuk produk. Tergantung pada permintaan perubahan, proses ini dapat memakan waktu beberapa menit hingga berhari-hari. Anda dapat memeriksa status permintaan melaluiPortal Manajemen AWS Marketplace, atau di API Katalog dengan DescribeChangeSet tindakan. Untuk informasi selengkapnya tentang set perubahan, lihatBekerja dengan set perubahan.

Untuk memeriksa status permintaan Anda, gunakan DescribeChangeSet tindakan.


POST /DescribeChangeSet HTTP/1.1
Content-type: application/json

{
   "Catalog": "AWSMarketplace",
   "ChangeSetID": "example123456789012abcdef"
}

Hasil panggilan ini terlihat seperti berikut (dalam hal ini, untuk menambahkan versi baru ke produk kontainer).


{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef",
  "ChangeSetName": "Submitted by 123456789012",
  "StartTime": "2020-10-27T22:21:26Z",
  "EndTime": "2020-10-27T22:32:19Z",
  "Status": "SUCCEEDED",
  "ChangeSet":
  [
    {
      "ChangeType": "AddDeliveryOptions",
      "Entity":
      {
        "Type": "ContainerProduct@1.0",
        "Identifier": "example-1234-abcd-56ef-abcdef12345678@4"
      },
      "Details": "{\"Version\": {\"VersionTitle\": \"1.1\",\"ReleaseNotes\": \"Minor bug fix\"},\"DeliveryOptions\": [{\"DeliveryOptionTitle\": \"EKSDelivery\",\"Details\": {\"EcrDeliveryOptionDetails\" : {\"ContainerImages\": [\"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1\"],\"DeploymentResources\": [{\"Name\": \"HelmDeploymentTemplate\",\"Url\": \"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1\"}],\"CompatibleServices\": [\"EKS\"],\"Description\": \"Sample Description\",\"UsageInstructions\":\"helm pull 111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1\"}}},{\"DeliveryOptionTitle\": \"HelmChartDeliveryOption\",\"Details\": {\"HelmDeliveryOptionDetails\": {\"CompatibleServices\": [\"EKS\", \"EKS-Anywhere\"],\"ContainerImages\": [\"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1\"],\"HelmChartUri\": \"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:helmchart1.1\",\"Description\": \"Helm chart description\",\"UsageInstructions\": \"Usage instructions\",\"MarketplaceServiceAccountName\": \"Service account name\",\"ReleaseName\": \"Optional release name\",\"Namespace\": \"Optional Kubernetes namespace\",\"OverrideParameters\": [{\"Key\": \"HelmKeyName1\",\"DefaultValue\": \"${AWSMP_LICENSE_SECRET}\"},{\"Key\": \"HelmKeyName2\",\"DefaultValue\": \"${AWSMP_SERVICE_ACCOUNT}\"}]}}}]}",
      "DetailsDocument":
      {
        "Version":
        {
          "VersionTitle": "1.1",
          "ReleaseNotes": "Minor bug fix"
        },
        "DeliveryOptions":
        [
          {
            "DeliveryOptionTitle": "EKSDelivery",
            "Details":
            {
              "EcrDeliveryOptionDetails":
              {
                "ContainerImages":
                [
                  "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1"
                ],
                "DeploymentResources":
                [
                  {
                    "Name": "HelmDeploymentTemplate",
                    "Url": "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1"
                  }
                ],
                "CompatibleServices":
                [
                  "EKS"
                ],
                "Description": "Sample Description",
                "UsageInstructions": "helm pull 111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1"
              }
            }
          },
          {
            "DeliveryOptionTitle": "HelmChartDeliveryOption",
            "Details":
            {
              "HelmDeliveryOptionDetails":
              {
                "CompatibleServices":
                [
                  "EKS",
                  "EKS-Anywhere"
                ],
                "ContainerImages":
                [
                  "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1"
                ],
                "HelmChartUri": "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:helmchart1.1",
                "Description": "Helm chart description",
                "UsageInstructions": "Usage instructions",
                "MarketplaceServiceAccountName": "Service account name",
                "ReleaseName": "Optional release name",
                "Namespace": "Optional Kubernetes namespace",
                "OverrideParameters":
                [
                  {
                    "Key": "HelmKeyName1",
                    "DefaultValue": "${AWSMP_LICENSE_SECRET}"
                  },
                  {
                    "Key": "HelmKeyName2",
                    "DefaultValue": "${AWSMP_SERVICE_ACCOUNT}"
                  }
                ]
              }
            }
          }
        ]
      },
      "ErrorDetailList":
      []
    }
  ]
}

StatusBidang menunjukkan status permintaan saat ini, dalam hal ini,SUCCEEDED.

Jika ada kegagalan, hasilnya dapat mencakup dua jenis kesalahan. Untuk sebagian besar kesalahan, pesan kesalahan disertakan secara langsung. Namun, kesalahan yang ditemukan saat memindai produk untuk kerentanan keamanan malah menyertakan URL ke file yang mencantumkan semua kesalahan yang ditemukan, di ErrorMessage bidang. Kesalahan yang ditemukan saat pemindaian memiliki ErrorCode "SCAN_ERROR”.


{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef",
  "ChangeSetName": "Submitted by 123456789012",
  "StartTime": "2020-10-27T22:21:26Z",
  "EndTime": "2020-10-27T22:32:19Z",
  "Status": "FAILED",
  "FailureDescription": "Change set preparation has failed. For details see 'ErrorDetailList'.",
  "ChangeSet":
  [
    {
      "ChangeType": "AddDeliveryOptions",
      "Entity":
      {
        "Type": "ContainerProduct@1.0",
        "Identifier": "example-1234-abcd-56ef-abcdef12345678@4"
      },
      "Details": "{\"Version\": {\"VersionTitle\": \"1.1\",\"ReleaseNotes\": \"Minor bug fix\"},\"DeliveryOptions\": [{\"DeliveryOptionTitle\": \"EKSDelivery\",\"Details\": {\"EcrDeliveryOptionDetails\" : {\"ContainerImages\": [\"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1\"],\"DeploymentResources\": [{\"Name\": \"HelmDeploymentTemplate\",\"Url\": \"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1\"}],\"CompatibleServices\": [\"EKS\"],\"Description\": \"Sample Description\",\"UsageInstructions\":\"helm pull 111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1\"}}},{\"DeliveryOptionTitle\": \"HelmChartDeliveryOption\",\"Details\": {\"HelmDeliveryOptionDetails\": {\"CompatibleServices\": [\"EKS\", \"EKS-Anywhere\"],\"ContainerImages\": [\"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1\"],\"HelmChartUri\": \"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:helmchart1.1\",\"Description\": \"Helm chart description\",\"UsageInstructions\": \"Usage instructions\",\"MarketplaceServiceAccountName\": \"Service account name\",\"ReleaseName\": \"Optional release name\",\"Namespace\": \"Optional Kubernetes namespace\",\"OverrideParameters\": [{\"Key\": \"HelmKeyName1\",\"DefaultValue\": \"${AWSMP_LICENSE_SECRET}\"},{\"Key\": \"HelmKeyName2\",\"DefaultValue\": \"${AWSMP_SERVICE_ACCOUNT}\"}]}}}]}",
      "DetailsDocument":
      {
        "Version":
        {
          "VersionTitle": "1.1",
          "ReleaseNotes": "Minor bug fix"
        },
        "DeliveryOptions":
        [
          {
            "DeliveryOptionTitle": "EKSDelivery",
            "Details":
            {
              "EcrDeliveryOptionDetails":
              {
                "ContainerImages":
                [
                  "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1"
                ],
                "DeploymentResources":
                [
                  {
                    "Name": "HelmDeploymentTemplate",
                    "Url": "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1"
                  }
                ],
                "CompatibleServices":
                [
                  "EKS"
                ],
                "Description": "Sample Description",
                "UsageInstructions": "helm pull 111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1"
              }
            }
          },
          {
            "DeliveryOptionTitle": "HelmChartDeliveryOption",
            "Details":
            {
              "HelmDeliveryOptionDetails":
              {
                "CompatibleServices":
                [
                  "EKS",
                  "EKS-Anywhere"
                ],
                "ContainerImages":
                [
                  "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1"
                ],
                "HelmChartUri": "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:helmchart1.1",
                "Description": "Helm chart description",
                "UsageInstructions": "Usage instructions",
                "MarketplaceServiceAccountName": "Service account name",
                "ReleaseName": "Optional release name",
                "Namespace": "Optional Kubernetes namespace",
                "OverrideParameters":
                [
                  {
                    "Key": "HelmKeyName1",
                    "DefaultValue": "${AWSMP_LICENSE_SECRET}"
                  },
                  {
                    "Key": "HelmKeyName2",
                    "DefaultValue": "${AWSMP_SERVICE_ACCOUNT}"
                  }
                ]
              }
            }
          }
        ]
      },
      "ErrorDetailList":
      [
        {
          "ErrorCode": "DUPLICATE_VERSION_TITLE",
          "ErrorMessage": "The version title must be different from any other version titles of this product."
        },
        {
          "ErrorCode": "SCAN_ERROR",
          "ErrorMessage": "https://123sample456.cloudfront.net/example-1234-abcd-5678-abcdef12345678/1234abcdef567890"
        }
      ]
    }
  ]
}

Dalam contoh ini, ada satu kesalahan langsung dilaporkan (DUPLICATE_VERSION_TITLE). Kesalahan lainnya memiliki file dengan pesan kesalahan (satu SCAN_ERROR dapat memiliki beberapa kesalahan yang ditemukan dalam file yang ditautkan).

catatan

Tautan yang ErrorMessage dikembalikan berlaku selama 60 hari.

Awas Javascript dinonaktifkan atau tidak tersedia di browser Anda.

Untuk menggunakan Dokumentasi AWS, Javascript harus diaktifkan. Lihat halaman Bantuan browser Anda untuk petunjuk.

Konvensi Dokumen

Menggunakan API sebagai penjual

Bekerja dengan AMI-based produk