Tambahkan versi baru Perbarui visibilitas untuk add-on Amazon EKS Buat repositori dan sumber daya Perbarui informasi versi Batasi versi

Bekerja dengan produk berbasis kontainer menggunakanAWS MarketplaceAPI

Anda dapat menggunakan API AWS Marketplace Katalog untuk mengotomatiskan tugas untuk bekerja dengan produk berbasis container.

Untuk informasi tentang membuat produk berbasis container menggunakan Catalog API, lihat. Buat produk

Topik berikut menjelaskan cara menggunakan API Katalog untuk melakukan tindakan pada produk berbasis container Anda:

Topik

Tambahkan versi baru
Perbarui visibilitas untuk add-on Amazon EKS
Buat repositori dan sumber daya
Perbarui informasi versi
Batasi versi

Tambahkan versi baru

Jika Anda sudah memiliki produk berbasis kontainerAWS Marketplace, Anda dapat menggunakan AWS Marketplace Catalog API untuk menambahkan versi baru. Ini mengharuskan Anda telah membuat repositori AWS Marketplace untuk setiap gambar kontainer atau artefak yang merupakan bagian dari produk Anda, dan Anda dapat menyalinnya dari lokal Docker dan file Anda. Helm

catatan

Untuk detail tentang membuat produk berbasis kontainer menggunakanPortal Manajemen AWS Marketplace, lihat Memulai produk kontainer di Panduan AWS MarketplacePenjual.

Untuk detail tentang menambahkan versi baru, termasuk membuat repositori dan membangun Docker dan Helm file ke dalam repositori tersebut, dengan menggunakanPortal Manajemen AWS Marketplace, lihat Menambahkan versi baru produk Anda di Panduan Penjual. AWS Marketplace

Jika Anda belum membuat repositori baru, Anda dapat membuatnya menggunakan API Katalog, lihat. Buat repositori dan sumber daya

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

catatan

Versi produk berbasis kontainer terdiri dari satu atau lebih opsi pengiriman. Misalnya, Anda mungkin memiliki dua opsi pengiriman, satu yang bekerja dengan database NoSQL, dan satu lagi yang bekerja dengan MySQL, sehingga pengguna Anda dapat memilih bagaimana mereka ingin bekerja dengan produk Anda. Anda membuat versi produk Anda dan menambahkan beberapa opsi pengiriman dalam satu permintaan denganAddDeliveryOptions.

Sintaks Permintaan Pengiriman Gambar Kontainer


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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "AddDeliveryOptions",
      "Entity":
      {
        "Identifier": "example1-abcd-1234-5ef6-7890abcdef12",
        "Type": "ContainerProduct@1.0"
      },
      "DetailsDocument":
      {
        "Version":
        {
          "VersionTitle": "1.1",
          "ReleaseNotes": "Minor bug fix"
        },
        "DeliveryOptions":
        [
          {
            "DeliveryOptionTitle": "EKS Container image only delivery option",
            "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"
              }
            }
          }      
        ]
      }
    }
  ]
}

Sintaks permintaan pengiriman Amazon Bedrock AgentCore Runtime


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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "AddDeliveryOptions",
      "Entity":
      {
        "Identifier": "example1-abcd-1234-5ef6-7890abcdef12",
        "Type": "ContainerProduct@1.0"
      },
      "DetailsDocument":
      {
        "Version":
        {
          "VersionTitle": "1.1",
          "ReleaseNotes": "Minor bug fix"
        },
        "DeliveryOptions":
        [
          {
            "DeliveryOptionTitle": "Amazon Bedrock AgentCore Runtime Delivery Option",
            "Details":
            {
              "EcrDeliveryOptionDetails":
              {
                "ContainerImages":
                [
                  "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1"
                ],
                "CompatibleServices":
                [
                  "Bedrock-AgentCore"
                ],
                "AgenticType":
                [
                  "AGENT" 
                ], 
                "Description": "Sample Description",
                "UsageInstructions": "To launch and invoke this agent on Amazon Bedrock AgentCore Runtime",
                "EnvironmentVariables":
                [
                  {
                    "Name": "HTTP_PORT",
                    "Description": "Port of the server",
                    "DefaultValue": "8080"
                  },
                  {
                    "Name": "API_KEY",
                    "Description": "Provide your unique API key here."
                  }
                ]
              }
            }
          }      
        ]
      }
    }
  ]
}

HelmSintaks Permintaan Pengiriman Bagan


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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "AddDeliveryOptions",
      "Entity":
      {
        "Identifier": "example1-abcd-1234-5ef6-7890abcdef12",
        "Type": "ContainerProduct@1.0"
      },
      "DetailsDocument":
      {
        "Version":
        {
          "VersionTitle": "1.1",
          "ReleaseNotes": "Minor bug fix"
        },
        "DeliveryOptions":
        [
          {
            "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}"
                  }
                ]
              }
            }
          }
        ]
      }
    }
  ]
}

Sintaks Permintaan Add-On Pengiriman Amazon EKS


POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "AddDeliveryOptions",
      "Entity": {
        "Type": "ContainerProduct@1.0",
        "Identifier": "$CreateProductChange.Entity.Identifier"
      },
      "DetailsDocument": {
        "Version": {
          "VersionTitle": "1.1",
          "ReleaseNotes": "New Add-on Release"
        },
        "DeliveryOptions": [
          {
            "DeliveryOptionTitle": "AWS Marketplace Test AddOn from CAPI 1",
            "Visibility": "Limited",
            "Details": {
              "EksAddOnDeliveryOptionDetails": {
                "ContainerImages": [
                  "111122223333.dkr.ecr.us-east-1.amazonaws.com/test-seller/canary-test-repo-product-6:mongo"
                ],
                "HelmChartUri": "111122223333.dkr.ecr.us-east-1.amazonaws.com/rocket/rocket-product-helm:1.0",
                "Description": "Description for delivery option provided by ISV",
                "UsageInstructions": "Usage instructions with launch instructions",
                "AddOnName": "aws-mp-test",
                "AddOnVersion": "1.2.1",
                "AddOnType": "networking",
                "CompatibleKubernetesVersions": [
                  "1.25",
                  "1.26"
                ],
                "SupportedArchitectures": [
                  "amd64",
                  "arm64"
                ],
                "Namespace": "my-test-namespace",
                "EnvironmentOverrideParameters": [
                  {
                    "Key": "cluster-name",
                    "Value": "${AWS_EKS_CLUSTER_NAME}"
                  },
                  {
                    "Key": "region-name",
                    "Value": "${AWS_REGION}"
                  }
                ]
              }
            }
          }
        ]
      },
      "ChangeName": "PublishAddonNew"
    }
  ]
}

Berikan informasi untuk bidang untuk menambahkan jenis AddDeliveryOptions perubahan:

Entity(objek) (wajib) - Produk berbasis wadah 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:ContainerProduct@1.0.
DetailsDocument(objek) (wajib) — Detail permintaan. Ini mencakup semua informasi tentang versi yang Anda tambahkan. Bidang ini adalah bidang string.
- Version(objek) — Detail tentang versi yang Anda tambahkan ke produk Anda.
  - VersionTitle(string) - Judul versi yang Anda buat. Biasanya ini adalah deskripsi versi, suka Version 1.1 atau sederhana1.1. Pembeli Anda akan dapat memilih versi yang akan digunakan dari daftar judul versi.
  - ReleaseNotes(string) — Catatan rinci tentang versi ini. Harus kurang dari 30.000 karakter.
- DeliveryOptions(array objek) — Sebuah array pilihan pengiriman, di mana masing-masing adalah metode pengiriman untuk versi produk Anda. Misalnya, jika Anda memiliki satu opsi pengiriman untuk Amazon Elastic Container Service (Amazon ECS) dan satu lagi untuk Amazon Elastic Kubernetes Service (Amazon EKS), Anda harus memiliki dua opsi pengiriman.
  - DeliveryOptionTitle(string) — Deskripsi singkat yang membantu pembeli Anda memilih di antara opsi pengiriman Anda.
  - Details(objek) — Sumber daya yang digunakan untuk opsi pengiriman ini. Ini adalah bidang detail dalam bidang detail. Anda tidak perlu dua kali lipat melarikan diri dari karakter di bidang ini.
    
    AddOnName – Nama add-on unik yang akan dilihat pembeli di katalog Amazon EKS. Nama ini akan menambahkan awalan nanti menggunakanSellerAlias. Misalnya, di mana isv-alias_ nama add-on yang disediakan ISV.
    
    AddOnType – Jenis add-on yang dipilih dari daftar nilai yang didukung dari Amazon EKS: Gitops | monitoring | logging | manajemen sertifikat | manajemen kebijakan | manajemen biaya | autoscaling | penyimpanan | kubernetes-management | service-mesh | etcd-backup | ingress-service-type | load-balancer | registr-lokal| jaringan | Keamanan | backup | ingress-controller | observability
    
    AddOnVersion – Versi semantik sehingga pembeli dapat memilih versi tertentu yang perlu AddOn mereka instal atau tingkatkan.
    
    CompatibleKubernetesVersions- Versi Amazon EKS Kubernetes yang kompatibel dengan perangkat lunak ini.
    
    CompatibleServices(array string) — Sebuah array layanan yang rilis kompatibel dengan. Opsi yang valid:ECS,EKS,ECS-Anywhere,EKS-Anywhere, danBedrock-AgentCore.
    
    ContainerImages(array string) - Sebuah array URL gambar kontainer yang digunakan oleh versi ini. Jalur akan menjadi repositori tempat Anda mengunggah gambar, dengan tag untuk gambar yang digunakan oleh versi ini. Daftar harus mencakup semua gambar yang diperlukan, bahkan gambar yang belum berubah dari versi sebelumnya. Lihat bagian selanjutnya untuk informasi tentang membuat repositori menggunakan API Katalog.
    
    Description(string) — Deskripsi yang lebih panjang tentang opsi pengiriman untuk memberikan detail kepada pembeli Anda. Anda juga dapat menyertakan tautan ke lebih banyak instruksi yang disediakan di tempat lain.
    
    EcrDeliveryOptionDetails— AgenticType — Jenis agen runtime. Opsi yang valid:AGENT,MCP_SERVER, atauA2A_SERVER.
    
    EcrDeliveryOptionDetails— EnvironmentVariables — Daftar variabel lingkungan yang diperlukan oleh kontainer AgentCore Runtime dan yang akan diisi sebelumnya untuk pembeli saat penerapan. Untuk setiap variabel, berikan objek dengan nama seperti yang diharapkan oleh container Anda, deskripsi, dan defaultValue opsional. Untuk variabel seperti kredensyal atau kunci API yang unik, jangan berikan nilai default. Anda dapat menggunakan deskripsi untuk menentukan rincian tentang variabel serta nilai yang mungkin. Semua variabel yang disediakan dengan nilai defaultnya akan diisi sebelumnya saat pembeli meluncurkan produk Anda.
    
    EcrDeliveryOptionDetails –DeploymentResources (array of objects)— Array sumber daya lain yang diperlukan untuk versi, seperti Helm grafik. Setiap sumber daya mencakup a Name untuk menggambarkannya, dan URL yang menunjuk pada sumber daya.
    
    EnvironmentOverrideParameters –Daftar parameter sistem yang akan digunakan oleh add-on. Beberapa ISV provided AddOn (HelmChart) mungkin memerlukan konfigurasi dengan informasi yang berasal dari status lingkungan eksekusi Amazon EKS (/informasi sistem). Misalnya,, EksClusterRegionEKSClusterName, dan lain-lain. Anda dapat menghindari tindakan tambahan dari Pembeli dengan mengganti nilai-nilai ini secara dinamis pada peluncuran Amazon EKS AddOn . Amazon EKS System sudah mendukung substitusi otomatis param sistem untuk add-on. AWS MarketplacePengalaman ISV dapat diperluas untuk mengumpulkan parameter ini yang membutuhkan substitusi.
    
    Informasi sistem generik yang akan diganti dapat ditunjukkan dengan memberikan konstanta AWS Marketplace tertentu mengikuti konvensi yang mirip Helm dengan substitusi. Nilai yang di-support adalah ${AWS_REGION} dan ${AWS_EKS_CLUSTER_NAME}.
    
    "EnvironmentOverrideParameters" : [ { "Key" : "my-field.region" "Value" : "${AWS_REGION}" }, { "Key" : "my-second-field" "Value" : "${AWS_EKS_CLUSTER_NAME}" },
    
    HelmDeliveryOptionDetails— HelmChartUri (string) — URL ke Helm bagan yang dihosting di Amazon ECR yang akan diinstal pembeli untuk meluncurkan perangkat lunak.
    
    HelmDeliveryOptionDetails –MarketplaceServiceAccountName (string)— Opsional — Nama akun layanan Kubernetes. Akun layanan akan digunakan untuk terhubung ke AWS Identity and Access Management (IAM) untuk izin untuk menelepon. Layanan AWS
    
    HelmDeliveryOptionDetails –ReleaseName (string)— Opsional — Nama untuk Helm rilis yang diberikan untuk helm install perintah yang digunakan pembeli untuk meluncurkan perangkat lunak. Jika tidak disertakan, Helm akan memberikan nama rilis yang dibuat secara otomatis untuk Anda.
    
    HelmDeliveryOptionDetails –Namespace (string)— Opsional — Kubernetes Namespace tempat Helm bagan akan dipasang.
    
    HelmDeliveryOptionDetails –OverrideParameters (array of objects)— Parameter yang akan digunakan dalam Helm perintah yang meluncurkan aplikasi. Pembeli dapat mengganti nilai default.
    
    catatan
    Untuk produk Amazon EKS Anywhere, berikan setidaknya 1 parameter penggantian untuk rahasia lisensi. Menyediakan DefaultValue dari"${AWSMP_LICENSE_SECRET}".
    Untuk produk berbayar, berikan setidaknya 1 parameter penggantian untuk konfigurasi akun layanan. Menyediakan DefaultValue dari"${AWSMP_SERVICE_ACCOUNT}".
    
    Key(string) — Kunci untuk parameter dalam notasi titik (override.example.key).
    
    DefaultValue(string) — Nilai default untuk parameter override ini.
    
    Namespace – ISV menyediakan namespace untuk instalasi add-on.
    
    SupportedArchitectures – Daftar arsitektur yang didukung, seperti amd64 dan arm64.
    
    UsageInstructions(string) — Berikan instruksi tentang penggunaan untuk opsi pengiriman ini. Bisa sampai 4.000 karakter.

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, termasuk memindai gambar kontainer dan informasi lainnya untuk memastikan bahwa itu memenuhi AWS Marketplacepedoman untuk produk kontainer. Proses ini dapat memakan waktu beberapa menit hingga berjam-jam, tergantung pada jumlah dan ukuran wadah Anda.

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 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
INCOMPATIBLE_PRODUCT_STATUS	Gunakan produk terbatas atau publik yang ada.
INCOMPATIBLE_SERVICES	Daftar layanan berisi layanan yang tidak kompatibel. [incompatible_services] Berikan daftar layanan kompatibel yang valid.
NO_SERVICE_SPECIFIED	Berikan setidaknya 1 layanan yang kompatibel.
AWSDUPLIKATE_COMPATIBLE_ _LAYANAN	Daftar layanan berisi entri duplikat. Hapus mereka. Setiap entri harus unik.
INVALID_VERSION_TITLE	Hapus spasi sebelum simbol merek dagang.
INVALID_VERSION_TITLE	Hapus karakter yang tidak didukung berikut: [x, y, z]
INVALID_VERSION_TITLE	Hapus spasi dari awal judul versi.
INVALID_VERSION_TITLE	Berikan judul versi dengan karakter kurang dari [x].
DUPLIKATE_VERSION_TITLE	Judul versi [duplicate_version_title] adalah duplikat. Hapus atau ubah judul.
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	Berikan petunjuk penggunaan dengan karakter kurang dari (x).
INVALID_USAGE_INSTRUCTIONS	Berikan instruksi penggunaan.
MISSING_CONTAINER_IMAGES	Berikan setidaknya 1 gambar kontainer.
NO_LICENSE_SECRET_KEYS	Untuk produk Amazon EKS Anywhere, berikan 1 parameter penggantian untuk rahasia lisensi. `DefaultValue`Kebutuhan`"${AWSMP_LICENSE_SECRET}"`, lihat contoh di bagian.
TOO_MANY_CONTAINER_IMAGES	Berikan kurang dari 50 gambar kontainer.
DUPLIKATE_CONTAINER_IMAGES	Daftar gambar kontainer berisi gambar duplikat: [duplicate_images]. Berikan daftar dengan gambar unik.
INVALID_CONTAINER_IMAGES	Berikan URI yang valid untuk gambar kontainer.
INVALID_CONTAINER_IMAGE_URI	Gambar [invalid_image_uri] tidak memiliki akses ke produk ini. Unggah gambar ke repositori produk yang sesuai. Untuk informasi tentang mengunggah, lihat Memulai produk kontainer.
INVALID_CONTAINER_IMAGE_TAG	Hindari menggunakan tag 'terbaru'.
DUPLIKATE_DELIVERY_OPTION_TITLES	Judul opsi pengiriman duplikat: [duplicate_titles]. Hapus duplikat
INVALID_DELIVERY_OPTION_TITLES	Judul opsi pengiriman [existing_titles] sudah ada. Berikan judul yang berbeda.
INVALID_FULFILLMENT_OPTION_TITLE	Berikan judul opsi pengiriman dengan karakter kurang dari (x).
NO_SERVICE_ACCOUNT_CONFIGURATION	Untuk produk berbayar, berikan 1 parameter penggantian untuk konfigurasi akun layanan. `DefaultValue`Kebutuhan`"${AWSMP_SERVICE_ACCOUNT}"`, lihat contoh di bagian.
INVALID_DETAILS	Detail yang disediakan tidak valid.
EMPTY_RESOURCE_NAME	Berikan nama sumber daya.
EMPTY_RESOURCE_URL	Berikan URL sumber daya.
INVALID_RESOURCE_NAME	Berikan nama sumber daya dengan kurang dari 256 karakter.
INVALID_RESOURCE_URL	Berikan URL sumber daya dengan kurang dari 256 karakter.
INVALID_SHORT_DESCRIPTION	Berikan deskripsi singkat dengan kurang dari 1.000 karakter.
INVALID_SHORT_DESCRIPTION	Berikan deskripsi singkat.
SCAN_ERROR	Perbaiki kerentanan keamanan “" [y] "” pada Gambar “" [x] "”.
IMAGE_NOT_FOUND	URI citra publik [invalid_image_uri] tidak valid. Berikan URI yang valid.
INVALID_ARN	Berikan ARN yang valid untuk akses gambar.
IMAGE_TIDAK DAPAT DIAKSES	Berikan ARN yang valid untuk akses gambar.
DUPLIKATE_ADDON_NAME	AddOn Nama yang Anda berikan sudah digunakan oleh produk yang berbeda. Berikan nama yang berbeda.
DUPLIKATE_ADDON_VERSION	Judul versi add-on [duplicate_version_title] sudah digunakan. Berikan judul yang berbeda.
INVALID_ADDON_TYPE	Jenis add-on [invalid_types] tidak valid. Berikan tipe dari daftar yang didukung: [eks_addon_do_supported_types].
INVALID_KUBERNETES_VERSION	Versi Kubernetes [invalid_versions] tidak valid. Berikan versi dari daftar yang didukung: [eks_addon_do_supported_kubernetes_versions].
DUPLIKATE_KUBERNETES_VERSIONS	Duplikat versi Kubernetes: [duplicate_versions]. Berikan daftar dengan versi unik.
INVALID_ARCHITECTURE	Arsitektur [invalid_architectures] tidak valid. Menyediakan arsitektur dari arsitektur yang didukung Amazon EKS: [eks_addon_do_supported_architectures].
DUPLICATE_SUPPORTED_ARCHITECTURES	Arsitektur duplikat: [duplicate_architectures]. Berikan daftar arsitektur yang unik dan didukung.
INVALID_VISIBILITY_STATE	Status [invalid_states] tidak valid untuk opsi pengiriman {EKS_DO}. Berikan status visibilitas yang valid dari nilai yang diizinkan berikut: Terbatas.
INVALID_ENVIRONMENT_OVERRIDE_PARAMETER_VALUE	Nilai parameter override [invalid_values] tidak valid. Berikan nilai yang valid dari daftar berikut: [eks_addon_do_environment_override_parameter_values].
DUPLICATE_ENVIRONMENT_OVERRIDE_PARAMETER_KEY	Parameter penggantian lingkungan berisi kunci duplikat: [duplicate_keys]. Hapus mereka.
TOO_MANY_EKS_ADDON_DELIVERY_OPTIONS	Berikan hanya satu opsi pengiriman add-on Amazon EKS untuk versi tersebut.
INCOMPATIBLE_ADDON_NAME	Nama add-on [provided_name] tidak cocok dengan nama yang ada. Gunakan kembali nama yang ada dari versi publik, atau versi sebelumnya, dari add-on ini. Anda hanya dapat menggunakan satu nama add-on untuk setiap produk.
INCOMPATIBLE_ADDON_TYPE	Jenis add-on [provided_type] tidak cocok dengan tipe yang ada. Gunakan kembali jenis yang ada dari versi publik, atau versi sebelumnya, dari add-on ini. Anda hanya dapat menggunakan satu jenis add-on untuk setiap produk.
INCOMPATIBLE_ADDON_NAMESPACE	Namespace add-on [provided_namespace] tidak cocok dengan namespace yang ada. Gunakan kembali namespace yang ada dari versi publik, atau versi sebelumnya, dari add-on ini. Anda hanya dapat menggunakan satu add-on namespace untuk setiap produk.
INVALID_HELM_CHART_URI	URI bagan Helm [invalid_uri] tidak valid. Berikan URI dalam format SemVer 2.
INCOMPATIBLE_HELM_OBJECTS (INVALID_HELM_OBJECTS)	<unsupported-objects>Berikan Helm bagan tanpa menggunakan Helm Objek yang tidak didukung berikut:.
INVALID_DEPENDENT_HELM_CHARTS	<invalid-subcharts>Berikan bagan Helm yang berisi bagan dependen berikut secara langsung di direktori bagan induk dan tidak bersumber dari luar:.
INVALID_HELM_SENSITIVE_CONFIG	Menyediakan skema konfigurasi lanjutan tanpa informasi sensitif atau rahasia. Kata kunci: <sensitive-parameters-identified>
INVALID_HELM_UNDECLARED_IMAGES	<list-of-images>Berikan gambar bagan Helm berikut dalam opsi pengiriman permintaan:.
INVALID_HELM_CHART_IMAGES	Berikan bagan Helm yang berisi gambar dalam repositori yang dibuat melalui jenis perubahan. AddRepositories Gambar eksternal:<images-identified>.
INVALID_HELM_LINT	Berikan bagan Helm yang berhasil melewati serat Helm.
INVALID_HELM_TEMPLATE	Berikan bagan Helm yang berhasil melewati template Helm.
INVALID_HELM_CHART	Berikan bagan Helm yang mematuhi AWS Marketplace panduan yang diidentifikasi dalam daftar poin Bagan Helm di Panduan Penjual. AWS Marketplace
INVALID_ADDON_NAME	Berikan AddOn nama yang mengikuti pola regex berikut: xx
INVALID_ADDON_NAMESPACE	Nilai namespace [invalid_namespaces] tidak valid. Namespace harus mengikuti ekspresi reguler {EKS_ADD_ON_NAMESPACE_REGEX}. Misalnya, namespace, namespace-test.
INVALID_ADDON_NAME_PATTERN	Berikan nama tambahan yang dimulai dengan huruf atau digit, dan kemudian kombinasi huruf, digit, dan tanda hubung. Misalnya, test-addon, eksaddon
INVALID_ADDON_VERSION_PATTERN	<major>Berikan versi add-on menggunakan pola berikut: ". <minor>. <patch>"(misalnya, 1.2.3, 0.1.2, 0.1.1)
EMPTY_DELIVERY_OPTION_IDS	Berikan daftar ID opsi pengiriman.
INVALID_DELIVERY_OPTIONS_INPUT	Daftar ini berisi satu atau beberapa opsi pengiriman yang tidak valid. Berikan daftar yang valid, dan pastikan bahwa setiap opsi memiliki metode pengiriman tunggal.
OVERRIDE_PARAMETER_KEYS_CONTAINS_SPECIAL_CHARS	Kunci parameter override [invalid_keys] berisi karakter yang tidak valid. Kunci Anda harus menggunakan hanya huruf, angka, tanda kutip ganda (” “) dan tanda plus (+).
INVALID_CONTAINER_IMAGE_REPOSITORI	Repositori [invalid_repositories] tidak valid. Menyediakan repositori yang dibuat melalui jenis AddRepositories perubahan.
INVALID_CONTAINER_IMAGE_TAG_FORMAT	Tag gambar kontainer [invalid_image_tag] tidak valid. Berikan tag yang sesuai dengan ekspresi reguler {CONTAINER_IMAGE_TAG_REGEX}.
DUPLICATE_OVERRIDE_PARAMETER_KEYS	Parameter override berisi kunci duplikat [duplicate_keys]. Hapus duplikat.
UNSUPPORTED_CONTAINER_IMAGE_URI	Gambar kontainer [unsupported_image] tidak didukung. Berikan gambar yang mengikuti Image Manifest V 2, Schema 1.
DUPLIKATE_REPOSITORY_NAMES	Nama repositori duplikat: [duplicate_repo_names]. Berikan nama unik.
INVALID_NAMESPACE	Nilai namespace [invalid_namespaces] tidak valid. Berikan nilai yang sesuai dengan ekspresi reguler {HELM_RELEASE_PARAM_REGEX}.
INVALID_RELEASE_NAME	Nilai releaseName [invalid_release_names] tidak valid. Berikan nilai yang sesuai dengan ekspresi reguler {HELM_RELEASE_PARAM_REGEX}.
OVERRIDE_PARAMETER_KEYS_CONTAINS_RESERVED_PARAMETER_KEYS	Kunci parameter override untuk judul opsi pengiriman [invalid_keys] dicadangkan. Kunci cadangan: [reserved_param_keys]. Berikan kunci yang berbeda.

Perbarui visibilitas untuk add-on Amazon EKS

Anda dapat menggunakan API Katalog untuk memperbarui visibilitas opsi pengiriman add-on Amazon EKS versi produk Anda di. AWS Marketplace Opsi kontainer dan Helm pengiriman untuk produk kontainer Anda secara otomatis dibuat dengan status visibilitas 'Publik'.

catatan

Kemampuan untuk memperbarui visibilitas versi produk Anda hanya didukung untuk opsi pengiriman add-on Amazon EKS dari versi yang terdaftar. Jika produk Anda belum 'Publik', kirimkan permintaan untuk mempublikasikan produk dengan status visibilitas 'Publik' dengan menggunakan. Portal Manajemen AWS Marketplace

Secara default, saat Anda membuat versi dengan opsi pengiriman add-on Amazon EKS, itu diterbitkan dalam status 'Terbatas'. Status 'Terbatas' berarti produk tidak tersedia untuk umum di semua Wilayah untuk digunakan dan digunakan pembeli Anda di klaster Amazon EKS. Anda dapat memperbarui visibilitas opsi pengiriman dari 'Terbatas' ke 'Publik' dengan memanggil operasi StartChangeSet API dengan jenis UpdateDeliveryOptionsVisibility perubahan. Tentukan DeliveryOptions Id dari versi produk Anda yang sesuai dengan opsi pengiriman add-on Amazon EKS.

Permintaan Sintaks



{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateDeliveryOptionsVisibility",
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "ContainerProduct@1.0"
      },
      "DetailsDocument":
      {
        "DeliveryOptions":
        [
          {
            "Id": "do-1234567891234567891234",
            "TargetVisibility": "Public"
          }
        ]
      }
    }
  ]
}

Untuk menambahkan jenis UpdateDeliveryOptionsVisibility perubahan, berikan informasi untuk bidang berikut:

Entity(objek) (wajib) - Produk berbasis wadah Anda.
- Identifier(string) (wajib) — ID produk Anda. Untuk informasi selengkapnya, lihat Pengidentifikasi.
- Type(string) (wajib) — Type Ini didasarkan pada metode pengiriman (jenis produk) yang digunakan produk Anda:ContainerProduct@1.0.
DetailsDocument(objek) (wajib) - Detail permintaan, termasuk informasi tentang repositori yang ingin Anda buat. Semua bidang berikut diperlukan.
- DeliveryOptions(daftar objek) — Daftar DeliveryOption objek, termasuk rincian masing-masing:
  - Id(string) - Pengidentifikasi unik untuk file. DeliveryOption (Untuk mendapatkan pengenal unik untukDeliveryOption, panggil DescribeEntity tindakan pada produk yang Anda perbarui.
  - TargetVisibility— Visibilitas baru yang dimaksudkan dari produk.

Sintaks Respon

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



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

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

Kesalahan Asinkron

Tabel berikut menunjukkan kesalahan yang spesifik 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
EMPTY_DELIVERY_OPTION_IDS	Berikan daftar ID opsi pengiriman.
INVALID_VISIBILITY_STATE	`TargetVisibility`Opsi yang Anda berikan tidak didukung. Silakan coba lagi dengan opsi yang diizinkan. Opsi yang diizinkan adalah: `Public`
INVALID_DELIVERY_OPTION_IDS	Anda memberikan rincian opsi pengiriman yang tidak valid. Berikan ID opsi pengiriman yang dapat ditemukan di produk. ID tidak ditemukan: [x]
DUPLIKATE_DELIVERY_OPTION_IDS	ID opsi pengiriman duplikat: [duplicate_ids]. Berikan ID opsi pengiriman yang unik.
AUDIT_ERROR	Anda belum menyelesaikan pengujian vendor perangkat lunak independen (ISV) untuk semua versi kluster Amazon EKS yang kompatibel untuk versi add-on Amazon EKS Anda. Anda harus menyelesaikan pengujian sebelum kami dapat merilis opsi pengiriman.
INVALID_DELIVERY_OPTION_TYPE	Jenis opsi pengiriman yang Anda berikan tidak valid. Pastikan bahwa opsi pengiriman Anda adalah jenis: `EksAddOn` dan coba lagi.
INCOMPATIBLE_HELM_OBJECTS	Berikan Helm bagan tanpa Objek yang tidak didukung: Helm Objek yang tidak didukung Helm adalah sebagai berikut: semua objek Rilis (kecuali .Name dan .Namespace), kait, Helm dan fungsi pencarian.
INCOMPATIBLE_ADDON_NAME	Nama add-on [provided_name] tidak cocok dengan nama versi publik. Perbarui nama publik sebelum dirilis.
NCOMPATIBLE_ADDON_TYPE	Jenis add-on tidak cocok. Gunakan kembali jenis add-on yang ada dari versi add-on publik atau versi add-on sebelumnya dari produk ini. Hanya satu add-on yang didukung untuk setiap produk.
INCOMPATIBLE_ADDON_NAMESPACE	Namespace add-on yang disediakan [provided_namespace] tidak cocok dengan namespace versi publik. Perbarui namespace add-on sebelum merilis.

Buat repositori dan sumber daya

Untuk membuat versi baru produk berbasis kontainer, Anda harus memiliki sumber daya untuk versi yang tersedia di AWS Marketplace repositori. Anda membuat repositori dan kemudian mendorong (mengunggah) sumber daya Docker (danHelm) ke dalam repositori. Untuk mempelajari cara membuat repositori melaluiPortal Manajemen AWS Marketplace, lihat Menambahkan versi baru produk Anda di Panduan AWS MarketplacePenjual.

Untuk membuat repositori baru, panggil StartChangeSet dengan jenis AddRepositories perubahan, seperti yang ditunjukkan pada contoh berikut.

Permintaan Sintaks


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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "AddRepositories",
      "Entity":
      {
        "Identifier": "example1-abcd-1234-5ef6-7890abcdef12",
        "Type": "ContainerProduct@1.0"
      },
      "DetailsDocument":
      {
        "Repositories":
        [
          {
            "RepositoryName": "new-repo-1",
            "RepositoryType": "ECR"
          },
          {
            "RepositoryName": "new-repo-2",
            "RepositoryType": "ECR"
          }
        ]
      }
    }
  ]
}

Berikan informasi untuk bidang untuk menambahkan jenis AddRepositories perubahan:

Untuk informasi selengkapnya tentang membuat repositori, lihat Menambahkan versi baru di Panduan AWS MarketplacePenjual.

Entity(objek) (wajib) - Produk berbasis wadah 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:ContainerProduct@1.0.
DetailsDocument(objek) (wajib) — Detail permintaan. Ini termasuk informasi tentang repositori yang ingin Anda buat. Semua bidang yang disertakan diperlukan.
- Repositories(array struktur) — Daftar objek repositori. Setiap objek repositori menyertakan nama dan jenis.
  - RepositoryName(string) — Nama repositori yang akan dibuat.
  - RepositoryType(string) — Jenis repositori yang akan dibuat. Satu-satunya nilai yang diperbolehkan adalah ECR.

catatan

Anda dapat memiliki hingga 70 repositori per produk, meskipun Anda dapat menambahkan beberapa sumber daya, dan versi sumber daya, ke satu repositori dengan memberi mereka tag yang berbeda saat Anda mendorongnya.

Setelah Anda membuat satu atau lebih repositori, Anda menambahkan sumber daya Anda ke repositori. Untuk informasi tentang cara mendorong resource ke repositori, lihat Mendorong gambar di Panduan Pengguna Amazon Elastic Container Registry. Untuk informasi tentang perintah push spesifik yang diperlukan untuk salah satu repositori Anda, lihat Menambahkan versi baru di Panduan AWS MarketplacePenjual.

Kesalahan Asinkron

Kesalahan berikut khusus untuk AddRepositories 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_ECR_REPOSITORY_NAME	Berikan nama repositori dalam format: 'nginx-web-app'
DUPLIKATE_ECR_REPOSITORY_NAME	Repositori [duplicate_repo_names] sudah ada. Pilih nama yang berbeda.
HILANG_REPOSITORY_INFORMATION	Berikan setidaknya 1 nama repositori.
INVALID_ECR_REPOSITORY_NAME	Panjang karakter maksimum 256 tercapai. Jumlah panjang karakter termasuk namespace penjual.

Perbarui informasi versi

Anda dapat menggunakan API Katalog untuk memperbarui detail versi produk berbasis container yang sudah ada. AWS Marketplace

catatan

Jika produk tersedia untuk umum, Anda tidak dapat memperbarui judul versi, gambar kontainer, judul opsi pengiriman, atau sumber daya penerapan untuk versi tersebut. Jika Anda perlu memperbarui aspek-aspek produk ini, buat versi baru sebagai gantinya.

Untuk memperbarui versi produk berbasis container Anda yang sudah ada, panggil operasi StartChangeSet API dengan tipe UpdateDeliveryOptions perubahan, seperti yang ditunjukkan pada contoh berikut. Ini memperbarui informasi detail untuk opsi pengiriman yang Anda tentukan, serta versi terkait. Anda harus menyertakan setidaknya satu opsi pengiriman.

Sintaks Permintaan Pengiriman Gambar Kontainer


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

{
   "Catalog":"AWSMarketplace",
   "ChangeSet":[
      {
         "ChangeType":"UpdateDeliveryOptions",
         "Entity":{
            "Identifier":"example1-abcd-1234-5ef6-7890abcdef12",
            "Type":"ContainerProduct@1.0"
         },
         "DetailsDocument":{
            "Version":{
               "ReleaseNotes":"New release notes",
               "VersionTitle":"Version 1.2"
            },
            "DeliveryOptions":[
               {
                  "Id":"example4-2222-cccc-2222-cccccccccccc",
                  "Details":{
                     "EcrDeliveryOptionDetails":{
                        "DeliveryOptionTitle":"New Delivery Option Title",
                        "Description":"New description",
                        "UsageInstructions":"New usage instructions",
                        "CompatibleServices":[
                           "EKS"
                        ]
                     }
                  }
               }
            ]
         }
      }
   ]
}

HelmSintaks Permintaan Pengiriman Bagan


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

{
   "Catalog":"AWSMarketplace",
   "ChangeSet":[
      {
         "ChangeType":"UpdateDeliveryOptions",
         "Entity":{
            "Identifier":"example1-abcd-1234-5ef6-7890abcdef12",
            "Type":"ContainerProduct@1.0"
         },
         "DetailsDocument":{
            "Version":{
               "ReleaseNotes":"New release notes",
               "VersionTitle":"Version 1.2"
            },
            "DeliveryOptions":[
               {
                  "Id":"example5-2222-cccc-2222-cccccccccccc",
                  "Details":{
                     "HelmDeliveryOptionDetails":{
                        "DeliveryOptionTitle":"New Delivery Option Title",
                        "ContainerImages":[
                           "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/imagename:1.0"
                        ],
                        "HelmChartUri":"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/helmname:1.0",
                        "CompatibleServices":[
                           "EKS-Anywhere"
                        ],
                        "Description":"New description",
                        "UsageInstructions":"New usage instructions",
                        "MarketplaceServiceAccountName":"new-service-account-name",
                        "ReleaseName":"new-release-name",
                        "Namespace":"new-cluster-namespace",
                        "OverrideParameters":[
                           {
                              "Key":"new.parameter.key",
                              "DefaultValue":"New parameter default value"
                           }
                        ]
                     }
                  }
               }
            ]
         }
      }
   ]
}

Sintaks Permintaan Add-On Pengiriman Amazon EKS


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

{
   "Catalog":"AWSMarketplace",
   "ChangeSet":[
      {
         "ChangeType":"UpdateDeliveryOptions",
         "Entity":{
            "Identifier":"example1-abcd-1234-5ef6-7890abcdef12",
            "Type":"ContainerProduct@1.0"
         },
         "DetailsDocument":{
            "Version":{
               "ReleaseNotes":"New release notes",
               "VersionTitle":"Version 1.2"
            },
            "DeliveryOptions":[
               {
                  "Id":"example4-2222-cccc-2222-cccccccccccc",
                  "Details":{
                     "EksAddOnDeliveryOptionDetails":{
                        "ContainerImages":[
                           "709825985650.dkr.ecr.us-east-1.amazonaws.com/test-seller/canary-test-repo-product-6:mongo"
                        ],
                        "Description":"Description for delivery option provided by ISV",
                        "UsageInstructions":"Usage instructions with launch instructions",
                        "HelmChartUri":"709825985650.dkr.ecr.us-east-1.amazonaws.com/rocket/rocket-product-helm:1.0",
                        "AddOnName":"aws-mp-test",
                        "AddOnVersion":"1.2.1",
                        "AddOnType":"networking",
                        "CompatibleKubernetesVersions":[
                           "1.19",
                           "1.20"
                        ],
                        "SupportedArchitectures":[
                           "amd64",
                           "arm64"
                        ],
                        "Namespace":"my-test-namespace",
                        "EnvironmentOverrideParameters":[
                           {
                              "Key":"my-field",
                              "Value":"${AWS_EKS_CLUSTER_NAME}"
                           }
                        ]
                     }
                  }
               }
            ]
         }
      }
   ]
}

Berikan informasi untuk bidang untuk menambahkan jenis UpdateDeliveryOptions perubahan:

Untuk informasi selengkapnya tentang bidang ini, lihat Menambahkan versi baru di Panduan AWS Marketplace Penjual.

Entity(objek) (wajib) - Produk berbasis wadah 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:ContainerProduct@1.0.
DetailsDocument(objek) (wajib) — Detail permintaan. Ini mencakup informasi apa pun tentang versi produk berbasis kontainer yang ingin Anda perbarui. Bidang yang disertakan semuanya opsional, tetapi Anda harus menyertakan setidaknya satu bidang untuk diperbarui.
- Version(objek) — Detail tentang versi perangkat lunak.
  - VersionTitle(string) - Judul versi yang Anda buat. Biasanya ini adalah deskripsi versi, seperti Version 1.1 atau sederhana1.1. Pembeli Anda akan dapat memilih versi yang akan digunakan dari daftar semua judul versi.
    
    Properti ini tidak dapat diperbarui jika produk sudah dipublikasikan secara publik.
  - ReleaseNotes(string) — Catatan bagi pembeli untuk memberi tahu mereka tentang perubahan dari satu versi ke versi berikutnya.
- DeliveryOptions(daftar objek) — Daftar DeliveryOption objek, termasuk rincian masing-masing:
  - Id(string) - Pengidentifikasi unik untuk DeliveryOption (Anda bisa mendapatkan pengenal unik untuk DeliveryOption dengan memanggil DescribeEntity tindakan pada produk yang Anda perbarui).
  - Details(objek) - Memegang detail opsi pengiriman. Perhatikan bahwa objek detail bersarang ini tidak perlu diloloskan ganda.
    
    EcrDeliveryOptionDetails(objek) - Rincian opsi pengiriman gambar kontainer.
    
    DeliveryOptionTitle(string) — Deskripsi singkat yang memungkinkan pembeli Anda memilih di antara opsi pengiriman Anda.
    
    Properti ini tidak dapat diperbarui jika produk sudah dipublikasikan secara publik.
    
    ContainerImages(array string) - Sebuah array URL gambar kontainer yang digunakan oleh versi ini. Jalur akan menjadi repositori tempat Anda mengunggah gambar, dengan tag untuk gambar yang digunakan oleh versi ini. Jika bidang ini disertakan, daftar harus menyertakan semua gambar yang diperlukan, bahkan gambar yang tidak berubah.
    
    Properti ini tidak dapat diperbarui jika produk sudah dipublikasikan secara publik.
    
    DeploymentResources(array objek) - Array sumber daya penyebaran lain yang diperlukan untuk versi, seperti tautan ke Helm bagan atau dokumentasi lainnya. Setiap sumber daya menyertakan nama untuk mendeskripsikannya dan URL yang menunjuk ke sumber daya. Pada halaman peluncuran untuk versi Anda, ini ditampilkan sebagai daftar tautan.
    
    Properti ini tidak dapat diperbarui jika produk sudah dipublikasikan secara publik.
    
    Name(string) — Teks hyperlink yang ditampilkan kepada pembeli.
    
    Url(string) — URL hyperlink yang ditampilkan kepada pembeli.
    
    CompatibleServices(array string) — Sebuah array layanan yang rilis kompatibel dengan. Opsi yang valid:ECS,EKS,ECS-Anywhere,EKS-Anywhere, danBedrock-AgentCore.
    
    AgenticTypeJenis agen runtime. Opsi yang valid:AGENT,MCP_SERVER, atauA2A_SERVER.
    
    Description(string) — Deskripsi yang lebih panjang tentang opsi pengiriman untuk memberikan detail kepada pembeli Anda. Anda juga dapat menyertakan tautan ke instruksi lainnya yang dihosting di tempat lain.
    
    UsageInstructions(string) — Berikan instruksi tentang cara menyebarkan dan menggunakan produk Anda. Anda juga dapat menambahkan tautan ke petunjuk penggunaan yang dihosting di tempat lain. Bisa sampai 4.000 karakter.
    
    EnvironmentVariables— Daftar variabel lingkungan yang diperlukan oleh kontainer AgentCore Runtime dan yang akan diisi sebelumnya untuk pembeli saat penerapan. Untuk setiap variabel, berikan objek dengan nama seperti yang diharapkan oleh container Anda, deskripsi, dan defaultValue opsional. Untuk variabel seperti kredensyal atau kunci API yang unik, jangan berikan nilai default. Anda dapat menggunakan deskripsi untuk menentukan rincian tentang variabel serta nilai yang mungkin. Semua variabel yang disediakan dengan nilai defaultnya akan diisi sebelumnya saat pembeli meluncurkan produk Anda.
  - Id(string) - Pengidentifikasi unik untuk DeliveryOption (Anda bisa mendapatkan pengenal unik untuk DeliveryOption dengan memanggil DescribeEntity tindakan pada produk yang Anda perbarui).
  - Details(objek) - Memegang detail opsi pengiriman. Perhatikan bahwa objek detail bersarang ini tidak perlu diloloskan ganda.
    
    HelmDeliveryOptionDetails(objek) - Rincian opsi pengiriman Helm bagan.
    
    DeliveryOptionTitle(string) — Deskripsi singkat yang memungkinkan pembeli Anda memilih di antara opsi pengiriman Anda.
    
    Properti ini tidak dapat diperbarui jika produk sudah dipublikasikan secara publik.
    
    ContainerImages(array string) - Sebuah array URL gambar kontainer yang digunakan oleh versi ini. Jalur akan menjadi repositori tempat Anda mengunggah gambar, dengan tag untuk gambar yang digunakan oleh versi ini. Daftar harus mencakup semua gambar yang diperlukan, bahkan gambar yang belum berubah dari versi sebelumnya. Lihat bagian selanjutnya untuk informasi tentang membuat repositori menggunakan API Katalog.
    
    HelmChartUri(string) — URL ke Helm bagan yang dihosting di Amazon ECR yang akan diinstal pembeli untuk meluncurkan perangkat lunak.
    
    CompatibleServices(array string) — Sebuah array layanan yang rilis kompatibel dengan. Opsi yang valid adalah ECS danEKS.
    
    Description(string) — Deskripsi yang lebih panjang tentang opsi pengiriman untuk memberikan detail kepada pembeli Anda. Anda juga dapat menyertakan tautan ke lebih banyak instruksi yang disediakan di tempat lain.
    
    UsageInstructions(string) — Berikan instruksi tentang penggunaan untuk opsi pengiriman ini. Bisa sampai 4.000 karakter.
    
    MarketplaceServiceAccountName(string) — Nama akun Kubernetes layanan. Akun layanan akan digunakan untuk terhubung ke izin AWS Identity and Access Management untuk memanggil AWS layanan.
    
    ReleaseName(string) — Nama untuk Helm rilis yang diberikan untuk helm install perintah yang digunakan pembeli untuk meluncurkan perangkat lunak.
    
    Namespace(string) - Kubernetes Namespace tempat Helm bagan akan dipasang.
    
    OverrideParameters(array objek) — Parameter yang akan digunakan dalam Helm perintah yang meluncurkan aplikasi. Pembeli dapat mengganti nilai default.
    
    Key(string) — Kunci untuk parameter dalam notasi titik (override.example.key).
    
    DefaultValue(string) — Nilai default untuk parameter override ini.

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.

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.

Kode kesalahan	Pesan kesalahan
INCOMPATIBLE_PRODUCT_STATUS	Gunakan produk terbatas atau publik yang ada.
INCOMPATIBLE_SERVICES	Daftar layanan berisi layanan yang tidak kompatibel. [incompatible_services] Berikan daftar layanan kompatibel yang valid.
NO_SERVICE_SPECIFIED	Berikan setidaknya 1 layanan yang kompatibel.
DUPLICATE_COMPATIBLE_AWS_SERVICES	Daftar layanan berisi entri duplikat. Hapus mereka. Setiap entri harus unik.
INVALID_VERSION_TITLE	Hapus spasi sebelum simbol merek dagang.
INVALID_VERSION_TITLE	Hapus karakter yang tidak didukung berikut: [x, y, z]
INVALID_VERSION_TITLE	Hapus spasi dari awal judul versi.
INVALID_VERSION_TITLE	Berikan judul versi dengan karakter kurang dari [x].
DUPLIKATE_VERSION_TITLE	Judul versi [duplicate_version_title] adalah duplikat. Hapus atau ubah judul.
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	Berikan petunjuk penggunaan dengan karakter kurang dari (x).
INVALID_USAGE_INSTRUCTIONS	Berikan instruksi penggunaan.
MISSING_CONTAINER_IMAGES	Berikan setidaknya 1 gambar kontainer.
TOO_MANY_CONTAINER_IMAGES	Berikan kurang dari 50 gambar kontainer.
DUPLIKATE_CONTAINER_IMAGES	Daftar gambar kontainer berisi gambar duplikat: [duplicate_images]. Berikan daftar dengan gambar unik.
INVALID_CONTAINER_IMAGES	Berikan URI yang valid untuk gambar kontainer.
INVALID_CONTAINER_IMAGE_URI	Gambar [invalid_image_uri] tidak memiliki akses ke produk ini. Unggah gambar ke repositori produk yang sesuai. Untuk informasi tentang mengunggah, lihat Memulai produk kontainer.
INVALID_CONTAINER_IMAGE_TAG	Hindari menggunakan tag 'terbaru'.
HILANG_DELIVERY_OPTION_IDS	Berikan opsi pengiriman dari daftar Id yang ada.
EMPTY_DELIVERY_OPTION_IDS	Berikan daftar ID opsi pengiriman yang tidak kosong.
DUPLIKATE_DELIVERY_OPTION_IDS	ID opsi pengiriman duplikat: [duplicate_ids]. Berikan ID opsi pengiriman yang unik.
DUPLIKATE_DELIVERY_OPTION_TITLES	Judul opsi pengiriman duplikat: [duplicate_titles]. Hapus duplikat
INVALID_DELIVERY_OPTION_TITLES	Judul opsi pengiriman [existing_titles] sudah ada. Berikan judul yang berbeda.
INVALID_FULFILLMENT_OPTION_TITLE	Berikan judul opsi pengiriman dengan karakter kurang dari (x).
EMPTY_RESOURCE_NAME	Berikan nama sumber daya.
EMPTY_RESOURCE_URL	Berikan URL sumber daya.
INVALID_RESOURCE_NAME	Berikan nama sumber daya dengan kurang dari 256 karakter.
INVALID_RESOURCE_URL	Berikan URL sumber daya dengan kurang dari 256 karakter.
INVALID_SHORT_DESCRIPTION	Berikan deskripsi singkat dengan kurang dari 1.000 karakter.
INVALID_SHORT_DESCRIPTION	Berikan deskripsi singkat.
NO_LICENSE_SECRET_KEYS	Untuk produk Amazon EKS Anywhere, berikan 1 parameter penggantian untuk rahasia lisensi. `DefaultValue`Kebutuhan`"${AWSMP_LICENSE_SECRET}"`, lihat contoh di bagian.
NO_SERVICE_ACCOUNT_CONFIGURATION	Untuk produk berbayar, berikan 1 parameter penggantian untuk konfigurasi akun layanan. `DefaultValue`Kebutuhan`"${AWSMP_SERVICE_ACCOUNT}"`, lihat contoh di bagian.
SCAN_ERROR	Perbaiki kerentanan keamanan “" [y] "” pada Gambar “" [x] "”.
FIELD_NOT_ALLOWED_TO_CHANGE	Field [x] tidak dapat diubah.
INVALID_DELIVERY_OPTIONS_STATUS	ID opsi pengiriman [invalid_ids] tidak valid. Berikan opsi pengiriman di negara terbatas atau publik.
NO_CHANGE_FOUND	Berikan setidaknya 1 perubahan.
MULTIPLE_VERSION_UPDATE	Berikan ID opsi pengiriman dari versi yang sama.
OVERRIDE_PARAMETER_KEYS_CONTAINS_SPECIAL_CHARS	Kunci parameter override [invalid_keys] berisi karakter yang tidak valid. Kunci Anda harus menggunakan hanya huruf, angka, tanda kutip ganda (” “) dan tanda plus (+).
INVALID_CONTAINER_IMAGE_REPOSITORI	Repositori [invalid_repositories] tidak valid. Menyediakan repositori yang dibuat melalui jenis AddRepositories perubahan.
INVALID_CONTAINER_IMAGE_TAG_FORMAT	Tag gambar kontainer [invalid_image_tag] tidak valid. Berikan tag yang sesuai dengan ekspresi reguler {CONTAINER_IMAGE_TAG_REGEX}.
DUPLICATE_OVERRIDE_PARAMETER_KEYS	Parameter override berisi kunci duplikat [duplicate_keys]. Hapus duplikat.
UNSUPPORTED_CONTAINER_IMAGE_URI	Gambar kontainer [unsupported_image] tidak didukung. Berikan gambar yang mengikuti Image Manifest V 2, Schema 1.
INVALID_NAMESPACE	Nilai namespace [invalid_namespaces] tidak valid. Berikan nilai yang sesuai dengan ekspresi reguler {HELM_RELEASE_PARAM_REGEX}.
INVALID_RELEASE_NAME	Nilai releaseName [invalid_release_names] tidak valid. Berikan nilai yang sesuai dengan ekspresi reguler {HELM_RELEASE_PARAM_REGEX}.
OVERRIDE_PARAMETER_KEYS_CONTAINS_RESERVED_PARAMETER_KEYS	Kunci parameter override untuk judul opsi pengiriman [invalid_keys] dicadangkan. Kunci cadangan: [reserved_param_keys]. Berikan kunci yang berbeda.
INCOMPATIBLE_ADDON_NAME	Nama add-on [provided_name] tidak cocok dengan nama yang ada. Gunakan kembali nama yang ada dari versi publik, atau versi sebelumnya, dari add-on ini. Anda hanya dapat menggunakan satu nama add-on untuk setiap produk.
INCOMPATIBLE_ADDON_NAMESPACE	Namespace add-on [provided_namespace] tidak cocok dengan namespace yang ada. Gunakan kembali namespace yang ada dari versi publik, atau versi sebelumnya, dari add-on ini. Anda hanya dapat menggunakan satu add-on namespace untuk setiap produk.

Batasi versi

Anda dapat menggunakan API Katalog untuk membatasi versi produk berbasis container Anda. AWS Marketplace Ini mencegah pembeli baru untuk dapat menggunakan versi itu. Harus ada setidaknya satu versi yang tersedia untuk umum dalam suatu produk. Anda tidak dapat membatasi satu-satunya versi yang tersedia untuk umum yang tersisa untuk suatu produk.

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

catatan

Membatasi satu atau lebih, tetapi tidak semua, opsi pengiriman dari versi akan menghapus opsi tersebut agar tidak tersedia bagi pembeli Anda. Membatasi semua opsi pengiriman untuk versi akan menghapus versi itu dari AWS Marketplace katalog.

Membatasi add-on Amazon EKS saat ini tidak didukung melalui API Katalog.

Versi terbatas masih tersedia untuk pelanggan yang sudah ada.

Permintaan Sintaks


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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "RestrictDeliveryOptions",
      "Entity":
      {
        "Identifier": "example1-abcd-1234-5ef6-7890abcdef12",
        "Type": "ContainerProduct@1.0"
      },
      "DetailsDocument":
      {
        "DeliveryOptionIds":
        [
          "example1-2222-cccc-2222-cccccccccccc"
        ]
      }
    }
  ]
}

Berikan informasi untuk bidang untuk menambahkan jenis RestrictDeliveryOptions perubahan:

Entity(objek) (wajib) - Produk berbasis wadah 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:ContainerProduct@1.0.
DetailsDocument(objek) (wajib) — Detail permintaan. Ini termasuk ID untuk opsi pengiriman produk berbasis kontainer yang ingin Anda batasi.
- DeliveryOptionIds(array string) — Daftar DeliveryOption ID untuk versi yang ingin Anda batasi. Anda bisa mendapatkan pengenal unik untuk DeliveryOption dengan memanggil DescribeEntity tindakan pada produk 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. Proses ini bisa memakan waktu beberapa menit hingga berjam-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
INCOMPATIBLE_PRODUCT_STATUS	Gunakan produk publik.
HILANG_DELIVERY_OPTION_IDS	Berikan opsi pengiriman dari daftar ID yang ada.
INVALID_DELIVERY_OPTIONS_STATUS	ID opsi pengiriman [invalid_ids] tidak valid. Berikan opsi pengiriman di negara publik.
EMPTY_DELIVERY_OPTION_IDS	Berikan daftar ID opsi pengiriman yang tidak kosong.
INVALID_MINIMUM_PUBLIC_DELIVERY_OPTIONS	Tidak dapat membatasi semua ID opsi pengiriman.
DUPLIKATE_DELIVERY_OPTION_IDS	ID opsi pengiriman duplikat: [duplicate_ids]. Berikan ID opsi pengiriman yang unik.

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

Bekerja dengan produk komponen EC2 Image Builder

Bekerja dengan produk SaaS