View a markdown version of this page

Arbeiten Sie mit Produkten auf Containerbasis mit dem AWS Marketplace APIs - AWS Marketplace

Die AWS Marketplace API-Referenz wurde neu strukturiert. Weitere Informationen zu den unterstützten API-Vorgängen finden Sie in der AWS Marketplace API-Referenz.

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Arbeiten Sie mit Produkten auf Containerbasis mit dem AWS Marketplace APIs

Sie können die AWS Marketplace Catalog API verwenden, um Aufgaben für die Arbeit mit containerbasierten Produkten zu automatisieren.

Informationen zum Erstellen eines containerbasierten Produkts mithilfe der Katalog-API finden Sie unter. Erstellen Sie ein Produkt

In den folgenden Themen wird beschrieben, wie Sie die Catalog API verwenden, um Aktionen für Ihre containerbasierten Produkte durchzuführen:

Eine neue Version hinzufügen

Wenn Sie bereits ein containerbasiertes Produkt installiert haben AWS Marketplace, können Sie das verwenden, AWS Marketplace Catalog API um eine neue Version hinzuzufügen. Dies setzt voraus, dass Sie bereits Repositorys AWS Marketplace für jedes Container-Image oder jedes Container-Artefakt erstellt haben, das Teil Ihres Produkts ist, und dass Sie diese aus Ihren lokalen Dateien und Dateien kopieren können. Docker Helm

Anmerkung

Einzelheiten zur Erstellung eines Produkts auf Containerbasis mithilfe von finden Sie im AWS Marketplace Management Portal Verkäuferleitfaden unter Erste Schritte mit Containerprodukten.AWS Marketplace

Einzelheiten zum Hinzufügen einer neuen Version, einschließlich der Erstellung von Repositorys und der Erstellung Docker von Helm Dateien in diesen Repositorys AWS Marketplace Management Portal, finden Sie unter Neue Version Ihres Produkts hinzufügen im Verkäuferleitfaden.AWS Marketplace

Falls Sie noch keine neuen Repositorys erstellt haben, können Sie diese mithilfe der Katalog-API erstellen, siehe. Erstellen Sie Repositorys und Ressourcen

Um eine neue Version hinzuzufügen, rufen Sie den StartChangeSet API-Vorgang mit dem AddDeliveryOptions Änderungstyp auf, wie im folgenden Beispiel gezeigt.

Anmerkung

Eine Version eines Produkts auf Containerbasis besteht aus einer oder mehreren Lieferoptionen. Möglicherweise haben Sie zwei Lieferoptionen, eine, die mit einer NoSQL-Datenbank funktioniert, und eine andere, die mit MySQL funktioniert, sodass Ihre Benutzer wählen können, wie sie mit Ihrem Produkt arbeiten möchten. Sie erstellen die Version Ihres Produkts und fügen mehrere Lieferoptionen in einer einzigen Anfrage mit AddDeliveryOptions hinzu.

Syntax der Anfrage für die Lieferung von Container-Images

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

Syntax der Amazon Bedrock AgentCore Runtime-Lieferanfrage

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

HelmSyntax der Chart-Lieferanforderung

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

Syntax der Amazon Add-On EKS-Lieferanforderung

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

Geben Sie Informationen für die Felder an, um den AddDeliveryOptions Änderungstyp hinzuzufügen:

  • Entity(Objekt) (erforderlich) — Ihr Produkt auf Containerbasis.

    • Identifier(string) (erforderlich) — Ihre Produkt-ID. Weitere Informationen finden Sie unter Kennung.

    • Type(string) (erforderlich) — Das Type basiert auf der Versandmethode (Produkttyp), die Ihr Produkt verwenden wird:ContainerProduct@1.0.

  • DetailsDocument(object) (erforderlich) — Einzelheiten der Anfrage. Es enthält alle Informationen über die Version, die Sie hinzufügen. Dieses Feld ist ein Zeichenfolgenfeld.

    • Version(Objekt) — Details zu der Version, die Sie Ihrem Produkt hinzufügen.

      • VersionTitle(string) — Der Titel der Version, die Sie erstellen. In der Regel ist dies eine Beschreibung der Version, wie Version 1.1 oder einfach1.1. Ihre Käufer können die Version, die bereitgestellt werden soll, aus einer Liste von Versionstiteln auswählen.

      • ReleaseNotes(string) — Die detaillierten Hinweise zu dieser Version. Muss weniger als 30.000 Zeichen lang sein.

    • DeliveryOptions(Reihe von Objekten) — Eine Reihe von Lieferoptionen, wobei jede eine Versandart für Ihre Produktversion darstellt. Wenn Sie beispielsweise eine Lieferoption für Amazon Elastic Container Service (Amazon ECS) und eine weitere für Amazon Elastic Kubernetes Service (Amazon EKS) haben, müssen Sie zwei Lieferoptionen haben.

      • DeliveryOptionTitle(Zeichenfolge) — Eine kurze Beschreibung, die Ihrem Käufer hilft, zwischen Ihren Lieferoptionen zu wählen.

      • Details(Objekt) — Die für diese Versandoption verwendeten Ressourcen. Dies ist ein Detailfeld innerhalb des Detailfeldes. Sie müssen die Zeichen in diesem Feld nicht doppelt maskieren.

        • AddOnName – Ein eindeutiger Zusatzname, den Käufer im Amazon EKS-Katalog sehen. Dieser Name wird später mit einem Präfix hinzugefügtSellerAlias. Wo isv-alias_ ist zum Beispiel der vom ISV bereitgestellte Add-On-Name?

        • AddOnType – Der Typ des Add-Ons, der aus einer Liste unterstützter Werte von Amazon EKS ausgewählt wurde: Gitops | monitoring | logging | cert-management | policy-management | cost-management | autoscaling | storage | kubernetes-management | service-mesh | etcd-backup | ingress-service-type | load-balancer | local-registry| networking | security | backup | ingress-controller | beobachtbarkeit

        • AddOnVersion – Eine semantische Version, sodass der Käufer eine bestimmte Version auswählen kann, die AddOn er installieren oder aktualisieren möchte.

        • CompatibleKubernetesVersions— Die Amazon EKS Kubernetes-Versionen, mit denen diese Software kompatibel ist.

        • CompatibleServices(Array von Zeichenketten) — Eine Reihe von Diensten, mit denen die Version kompatibel ist. Gültige Optionen: ECSEKS,ECS-Anywhere,EKS-Anywhere, undBedrock-AgentCore.

        • ContainerImages(Array von Zeichenketten) — Ein Array von Container-Image-URLs, die von dieser Version verwendet werden. Der Pfad ist das Repository, in das Sie das Bild hochgeladen haben, mit dem Tag für das von dieser Version verwendete Bild. Die Liste muss alle benötigten Bilder enthalten, auch Bilder, die sich gegenüber früheren Versionen nicht geändert haben. Im nächsten Abschnitt finden Sie Informationen zum Erstellen von Repositorys mithilfe der Catalog API.

        • Description(Zeichenfolge) — Eine längere Beschreibung der Lieferoption, um Ihrem Käufer weitere Informationen zu geben. Sie können auch einen Link zu weiteren Anweisungen hinzufügen, die an anderer Stelle bereitgestellt werden.

        • EcrDeliveryOptionDetailsAgenticType — Der Typ des Runtime-Agenten. Gültige Optionen:AGENT,MCP_SERVER, oderA2A_SERVER.

        • EcrDeliveryOptionDetailsEnvironmentVariables — Liste der Umgebungsvariablen, die für den AgentCore Runtime-Container erforderlich sind und die für Käufer bei der Bereitstellung vorab ausgefüllt werden. Geben Sie für jede Variable ein Objekt mit dem von Ihrem Container erwarteten Namen, einer Beschreibung und einem optionalen defaultValue an. Geben Sie für eindeutige Variablen wie Anmeldeinformationen oder API-Schlüssel keinen Standardwert an. Sie können die Beschreibung verwenden, um Details zur Variablen sowie mögliche Werte anzugeben. Alle bereitgestellten Variablen mit ihren Standardwerten werden vorab ausgefüllt, wenn Käufer Ihr Produkt auf den Markt bringen.

        • EcrDeliveryOptionDetails – DeploymentResources (array of objects)— Eine Reihe anderer Ressourcen, die für die Version benötigt werden, z. B. Helm Diagramme. Jede Ressource enthält eine, Name um sie zu beschreiben, und eineURL, die auf die Ressource verweist.

        • EnvironmentOverrideParameters – Liste der Systemparameter, die vom Add-on verwendet werden sollen. Einige der bereitgestellten ISVs AddOn (HelmChart) benötigen möglicherweise Konfigurationen mit Informationen, die aus dem Status der Amazon EKS-Ausführungsumgebung (/Systeminformationen) abgeleitet wurden. Zum Beispiel, EksClusterRegionEKSClusterName, und andere. Sie können zusätzliche Aktionen des Käufers vermeiden, indem Sie diese Werte beim Start von Amazon EKS AddOn dynamisch ersetzen. Das Amazon EKS-System unterstützt bereits die automatische Ersetzung von Systemparametern durch Add-Ons. AWS Marketplace Die ISV-Erfahrung kann erweitert werden, um diese Parameter zu sammeln, die eine Ersetzung erfordern würden.

          Die generischen Systeminformationen, die ersetzt werden sollen, können durch Angabe einer AWS Marketplace bestimmten Konstante angegeben werden, die einer Substitution ähnelt. Helm Die unterstützten Werte sind ${AWS_REGION} und ${AWS_EKS_CLUSTER_NAME}.

          "EnvironmentOverrideParameters" : [ { "Key" : "my-field.region" "Value" : "${AWS_REGION}" }, { "Key" : "my-second-field" "Value" : "${AWS_EKS_CLUSTER_NAME}" },
        • HelmDeliveryOptionDetailsHelmChartUri (string) — Die URL zu dem in Amazon ECR gehosteten Helm Diagramm, das der Käufer installieren wird, um die Software zu starten.

        • HelmDeliveryOptionDetails – MarketplaceServiceAccountName (string)Optional — Der Name des Kubernetes-Servicekontos. Das Dienstkonto wird verwendet, um eine Verbindung zu AWS Identity and Access Management (IAM) herzustellen, um Zugriffsberechtigungen zu erhalten. AWS-Services

        • HelmDeliveryOptionDetails – ReleaseName (string)Optional — Der Name der Helm Version, der für den helm install Befehl angegeben wurde, mit dem Käufer die Software starten. Falls nicht enthalten, Helm wird ein automatisch generierter Versionsname für Sie bereitgestellt.

        • HelmDeliveryOptionDetails – Namespace (string)Optional — Der Kubernetes Namespace, in dem das Helm Diagramm installiert wird.

        • HelmDeliveryOptionDetails – OverrideParameters (array of objects)— Parameter, die in den Helm Befehlen verwendet werden, mit denen die Anwendung gestartet wird. Käufer können die Standardwerte überschreiben.

          Anmerkung

          Geben Sie für Amazon EKS Anywhere Anywhere-Produkte mindestens einen Override-Parameter für das Lizenzgeheimnis an. Geben Sie DefaultValue von an"${AWSMP_LICENSE_SECRET}".

          Geben Sie für kostenpflichtige Produkte mindestens einen Override-Parameter für die Konfiguration des Dienstkontos an. Geben Sie DefaultValue an"${AWSMP_SERVICE_ACCOUNT}".

          • Key(string) — Der Schlüssel für den Parameter in Punktnotation (override.example.key).

          • DefaultValue(string) — Der Standardwert für diesen Override-Parameter.

        • Namespace – Der ISV hat einen Namespace für die Installation von Add-Ons bereitgestellt.

        • SupportedArchitectures – Die Liste der unterstützten Architekturen, wie amd64 und arm64.

        • UsageInstructions(string) — Stellen Sie Anweisungen zur Verwendung dieser Lieferoption bereit. Kann bis zu 4.000 Zeichen lang sein.

Syntax der Antwort

Für Ihre Anfrage wird ein Änderungssatz erstellt. Die Antwort auf diese Anfrage gibt Ihnen das ChangeSetId und ChangeSetArn für den Änderungssatz und sieht wie folgt aus.

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

Die Änderungsanforderung wird einer Warteschlange hinzugefügt und verarbeitet, einschließlich des Scannens der Container-Bilder und anderer Informationen, um sicherzustellen, dass sie den AWS Marketplace Richtlinien für Containerprodukte entspricht. Dieser Vorgang kann je nach Anzahl und Größe Ihrer Container einige Minuten bis Stunden dauern.

Sie können den Status der Anfrage über die oder direkt über die AWS Marketplace Management Portal Katalog-API mithilfe des DescribeChangeSet API-Vorgangs überprüfen.

Weitere Informationen über Änderungssätze finden Sie unter Mit Änderungssätzen arbeiten. Weitere Informationen zu Fehlern in Produktänderungssets von Verkäufern finden Sie unterStatus und Fehler des Sets ändern.

Asynchrone Fehler

Die folgenden Fehler beziehen sich spezifisch auf AddDeliveryOptions Aktionen in. AWS Marketplace Catalog API Diese Fehler werden zurückgegeben, wenn Sie aufrufen, DescribeChangeSet nachdem ein Änderungssatz verarbeitet wurde. Weitere Hinweise zur Verwendung DescribeChangeSet zum Abrufen des Status einer Änderungsanforderung finden Sie unterMit Änderungssätzen arbeiten.

Fehlercode Fehlermeldung

INCOMPATIBLE_PRODUCT_STATUS

Verwenden Sie ein vorhandenes limitiertes oder öffentliches Produkt.

INKOMPATIBLE_SERVICES

Die Dienstliste enthält inkompatible Dienste. [incompatible_services] Stellen Sie eine gültige Liste kompatibler Dienste bereit.

NO_SERVICE_SPECIFIED

Stellen Sie mindestens einen kompatiblen Dienst bereit.

DUPLIZIERE_KOMPATIBELE_ DIENSTE AWS

Die Serviceliste enthält doppelte Einträge. Entferne sie. Jeder Eintrag muss einzigartig sein.

INVALID_VERSION_TITLE

Entfernen Sie Leerzeichen vor dem Markensymbol.

UNGÜLTIGER VERSIONSTITEL

Entfernen Sie die folgenden nicht unterstützten Zeichen: [x, y, z]

UNGÜLTIGER VERSIONSTITEL

Entfernen Sie Leerzeichen am Anfang des Versionstitels.

UNGÜLTIGER_VERSIONSTITEL

Geben Sie einen Versionstitel mit weniger als [x] Zeichen an.

DUPLICATE_VERSION_TITLE

Der Versionstitel [duplicate_version_title] ist ein Duplikat. Entferne oder ändere den Titel.

INVALID_RELEASE_NOTES

Entfernen Sie Leerzeichen vor dem Markensymbol.

INVALID_RELEASE_NOTES

Nicht unterstützte Zeichen entfernen: [x, y, z]

UNGÜLTIGE_VERSIONSHINWEISE

Entfernen Sie Leerzeichen am Anfang der Versionshinweise.

INVALID_RELEASE_NOTES

Geben Sie Versionshinweise mit weniger als (x) Zeichen an.

UNGÜLTIGE VERWENDUNGSHINWEISE

Entfernen Sie Leerzeichen vor dem Markensymbol.

UNGÜLTIGE VERWENDUNGSHINWEISE

Nicht unterstützte Zeichen entfernen: [x, y, z]

UNGÜLTIGE NUTZUNGSANWEISUNGEN

Geben Sie Nutzungsanweisungen mit weniger als (x) Zeichen an.

INVALID_USAGE_INSTRUCTIONS

Geben Sie Anweisungen zur Verwendung an.

FEHLENDES_CONTAINER_IMAGES

Stellen Sie mindestens ein Container-Image bereit.

NO_LICENSE_SECRET_KEYS

Geben Sie für Amazon EKS Anywhere Anywhere-Produkte einen Override-Parameter für den Lizenzschlüssel an. Anforderungen DefaultValue von"${AWSMP_LICENSE_SECRET}", siehe Beispiel im Abschnitt.

ZU VIELE_CONTAINER_IMAGES

Stellen Sie weniger als 50 Container-Images bereit.

DUPLICATE_CONTAINER_IMAGES

Die Container-Bilderliste enthält doppelte Bilder: [duplicate_images]. Stellen Sie eine Liste mit eindeutigen Bildern bereit.

INVALID_CONTAINER_IMAGES

Geben Sie eine gültige URI für das Container-Image an.

INVALID_CONTAINER_IMAGE_URI

Das Bild [invalid_image_uri] hat keinen Zugriff auf dieses Produkt. Laden Sie das Bild in das entsprechende Produkt-Repository hoch. Informationen zum Hochladen finden Sie unter Erste Schritte mit Container-Produkten.

INVALID_CONTAINER_IMAGE_TAG

Vermeiden Sie die Verwendung des Tags „latest“.

DUPLICATE_DELIVERY_OPTION_TITLES

Doppelte Titel der Lieferoptionen: [duplicate_titles]. Entferne die Duplikate

INVALID_DELIVERY_OPTION_TITLES

Die Titel der Lieferoptionen [existing_titles] sind bereits vorhanden. Geben Sie einen anderen Titel an.

UNGÜLTIGER_ERFÜLLUNGSOPTIONSTITEL

Geben Sie den Titel der Lieferoption mit weniger als (x) Zeichen an.

NO_SERVICE_ACCOUNT_CONFIGURATION

Geben Sie für kostenpflichtige Produkte einen Override-Parameter für die Konfiguration des Dienstkontos an. Anforderungen DefaultValue von"${AWSMP_SERVICE_ACCOUNT}", siehe Beispiel im Abschnitt.

UNGÜLTIGE_DETAILS

Die angegebenen Details sind nicht gültig.

LEERER_RESSOURCENNAME

Geben Sie den Namen der Ressource an.

EMPTY_RESOURCE_URL

Geben Sie die Ressourcen-URL an.

UNGÜLTIGER_RESSOURCENNAME

Geben Sie einen Ressourcennamen mit weniger als 256 Zeichen an.

INVALID_RESOURCE_URL

Geben Sie eine Ressourcen-URL mit weniger als 256 Zeichen an.

INVALID_SHORT_DESCRIPTION

Geben Sie eine kurze Beschreibung mit weniger als 1.000 Zeichen ein.

INVALID_SHORT_DESCRIPTION

Geben Sie eine kurze Beschreibung ein.

SCAN_ERROR

Sicherheitslücke „" [y] "“ im Bild „" [x] "“ behoben.

IMAGE_NOT_FOUND

Die öffentliche Image-URI [invalid_image_uri] ist ungültig. Geben Sie einen gültigen URI an.

INVALID_ARN

Geben Sie einen gültigen ARN für den Bildzugriff an.

IMAGE_INACCESSIBLE

Geben Sie einen gültigen ARN für den Bildzugriff an.

DUPLICATE_ADDON_NAME

Der von Ihnen angegebene AddOn Name wird bereits von einem anderen Produkt verwendet. Geben Sie einen anderen Namen ein.

DUPLICATE_ADDON_VERSION

Der Titel der Add-On-Version [duplicate_version_title] wird bereits verwendet. Geben Sie einen anderen Titel an.

UNGÜLTIGER_ZUSATZTYP

Die Zusatztypen [invalid_types] sind ungültig. Geben Sie einen Typ aus der Liste der unterstützten Typen an: [eks_addon_do_supported_types].

UNGÜLTIGE_KUBERNETES_VERSION

Die Kubernetes-Versionen [invalid_versions] sind ungültig. Stellen Sie Versionen aus der Liste der unterstützten Versionen bereit: [eks_addon_do_supported_kubernetes_versions].

DUPLICATE_KUBERNETES_VERSIONS

Doppelte Kubernetes-Versionen: [duplicate_versions]. Stellen Sie eine Liste mit eindeutigen Versionen bereit.

UNGÜLTIGE ARCHITEKTUR

Die Architekturen [invalid_architectures] sind ungültig. Stellen Sie Architekturen der von Amazon EKS unterstützten Architekturen bereit: [eks_addon_do_supported_architectures].

DUPLIZIERTE_UNTERSTÜTZTE_ARCHITEKTUREN

Doppelte Architekturen: [duplicate_architectures]. Stellen Sie eine Liste einzigartiger, unterstützter Architekturen bereit.

INVALID_VISIBILITY_STATE

Die Bundesstaaten [invalid_states] sind für die Lieferoption {EKS_DO} ungültig. Geben Sie einen gültigen Sichtbarkeitsstatus aus den folgenden zulässigen Werten an: Eingeschränkt.

INVALID_ENVIRONMENT_OVERRIDE_PARAMETER_VALUE

Die Override-Parameterwerte [invalid_values] sind ungültig. Geben Sie einen gültigen Wert aus der folgenden Liste an: [eks_addon_do_environment_override_parameter_values].

DUPLICATE_ENVIRONMENT_OVERRIDE_PARAMETER_KEY

Die Umgebungsüberschreibungsparameter enthalten doppelte Schlüssel: [duplicate_keys]. Entferne sie.

TOO_MANY_EKS_ADDON_DELIVERY_OPTIONS

Stellen Sie nur eine Amazon EKS-Add-On-Lieferoption für die Version bereit.

INCOMPATIBLE_ADDON_NAME

Der Name des Add-ons [provided_name] stimmt nicht mit dem vorhandenen Namen überein. Verwenden Sie den vorhandenen Namen aus der öffentlichen Version oder früheren Versionen dieses Add-ons wieder. Sie können für jedes Produkt nur einen Add-On-Namen verwenden.

INCOMPATIBLE_ADDON_TYPE

Der Add-On-Typ [provided_type] entspricht nicht dem vorhandenen Typ. Verwenden Sie den vorhandenen Typ aus der öffentlichen Version oder früheren Versionen dieses Add-ons wieder. Sie können für jedes Produkt nur einen Add-On-Typ verwenden.

INCOMPATIBLE_ADDON_NAMESPACE

Der Add-On-Namespace [provided_namespace] stimmt nicht mit dem vorhandenen Namespace überein. Verwenden Sie den vorhandenen Namespace aus der öffentlichen Version oder früheren Versionen dieses Add-ons wieder. Sie können für jedes Produkt nur einen Add-On-Namespace verwenden.

INVALID_HELM_CHART_URI

Die Helm-Chart-URI [invalid_uri] ist ungültig. Geben Sie eine URI im SemVer 2-Format an.

INKOMPATIBLE_HELM_OBJECTS (INVALID_HELM_OBJECTS)

<unsupported-objects>Stellen Sie ein Diagramm bereit, ohne die folgenden nicht unterstützten Objekte zu verwenden:. Helm Helm

INVALID_DEPENDENT_HELM_CHARTS

<invalid-subcharts>Stellen Sie ein Helm-Diagramm bereit, das die folgenden abhängigen Diagramme direkt im übergeordneten Diagrammverzeichnis enthält und nicht extern bezogen wurde:.

INVALID_HELM_SENSITIVE_CONFIG

Stellen Sie ein erweitertes Konfigurationsschema ohne vertrauliche Informationen oder Geheimnisse bereit. Schlüsselwörter: <sensitive-parameters-identified>

INVALID_HELM_UNDECLARED_IMAGES

<list-of-images>Geben Sie die folgenden Helm-Chart-Bilder in der Lieferoption der Anfrage an:.

INVALID_HELM_CHART_IMAGES

Stellen Sie ein Helm-Diagramm bereit, das Bilder in Repositorys enthält, die mit dem Änderungstyp erstellt wurden. AddRepositories <images-identified>Externe Bilder:.

INVALID_HELM_LINT

Stellen Sie ein Helm-Diagramm bereit, das Helm Lint erfolgreich bestanden hat.

INVALID_HELM_TEMPLATE

Stellen Sie ein Helm-Diagramm bereit, das die Helm-Vorlage erfolgreich erfüllt.

INVALID_HELM_CHART

Stellen Sie ein Helm-Diagramm bereit, das den Richtlinien entspricht, die in der Aufzählung der Helmdiagramme im AWS Marketplace Verkäuferleitfaden aufgeführt sind.AWS Marketplace

UNGÜLTIGER_ZUSATZNAME

Geben Sie einen AddOn Namen ein, der dem folgenden Regex-Muster folgt: xx

UNGÜLTIGER_ADDON_NAMESPACE

Die Namespace-Werte [invalid_namespaces] sind ungültig. Der Namespace muss dem regulären Ausdruck {EKS_ADD_ON_NAMESPACE_REGEX} folgen. Zum Beispiel Namespace, Namespace-Test.

UNGÜLTIGER_ZUSATZNAME_MUSTER

Geben Sie einen Namen für das Add-On ein, der mit einem Buchstaben oder einer Ziffer und dann mit einer Kombination aus Buchstaben, Ziffern und Bindestrichen beginnt. Zum Beispiel Test-Addon, Eksaddon

UNGÜLTIGER_ERWEITERUNG_VERSIONSMUSTER

<major>Stellen Sie eine Add-On-Version mit dem folgenden Muster bereit: ". <minor>. <patch>"(zum Beispiel 1.2.3, 0.1.2, 0.1.1)

LEERE_LIEFEROPTIONS-IDS

Geben Sie eine Liste der Lieferoption-IDs an.

INVALID_DELIVERY_OPTIONS_INPUT

Die Liste enthält eine oder mehrere ungültige Lieferoptionen. Stellen Sie eine gültige Liste bereit und stellen Sie sicher, dass für jede Option eine einzige Versandmethode gilt.

OVERRIDE_PARAMETER_KEYS_CONTAINS_SPECIAL_CHARS

Die Override-Parameterschlüssel [invalid_keys] enthalten ungültige Zeichen. Ihre Schlüssel dürfen nur Buchstaben, Zahlen, doppelte Anführungszeichen („“) und Pluszeichen (+) enthalten.

INVALID_CONTAINER_IMAGE_REPOSITORY

Die Repositorien [invalid_repositories] sind ungültig. Stellen Sie Repositorys bereit, die mit dem Änderungstyp erstellt wurden. AddRepositories

INVALID_CONTAINER_IMAGE_TAG_FORMAT

Das Container-Image-Tag [invalid_image_tag] ist ungültig. Geben Sie ein Tag an, das dem regulären Ausdruck {CONTAINER_IMAGE_TAG_REGEX} entspricht.

PARAMETERSCHLÜSSEL DUPLIZIEREN

Die Override-Parameter enthalten doppelte Schlüssel [duplicate_keys]. Entferne die Duplikate.

UNSUPPORTED_CONTAINER_IMAGE_URI

Das Container-Image [unsupported_image] wird nicht unterstützt. Stellen Sie ein Image bereit, das dem Image-Manifest V 2, Schema 1 folgt.

DUPLIZIERTE_REPOSITORY_NAMES

Doppelte Repository-Namen: [duplicate_repo_names]. Geben Sie eindeutige Namen an.

UNGÜLTIGER_NAMESPACE

Die Namespace-Werte [invalid_namespaces] sind ungültig. Geben Sie Werte an, die dem regulären Ausdruck {HELM_RELEASE_PARAM_REGEX} entsprechen.

UNGÜLTIGER_RELEASENAME

Die ReleaseName-Werte [invalid_release_names] sind ungültig. Geben Sie Werte an, die dem regulären Ausdruck {HELM_RELEASE_PARAM_REGEX} entsprechen.

OVERRIDE_PARAMETER_KEYS_CONTAINS_RESERVED_PARAMETER_KEYS

Der Override-Parameterschlüssel für Übermittlungsoptionstitel [invalid_keys] ist reserviert. Reservierte Schlüssel: [reserved_param_keys]. Geben Sie einen anderen Schlüssel an.

Aktualisieren Sie die Sichtbarkeit für ein Amazon EKS-Add-on

Sie können die Katalog-API verwenden, um die Sichtbarkeit einer Amazon EKS-Add-On-Lieferoption Ihrer Produktversion in zu aktualisieren AWS Marketplace. Container- und Helm Lieferoptionen für Ihr Container-Produkt werden automatisch mit dem Sichtbarkeitsstatus „Öffentlich“ erstellt.

Anmerkung

Die Möglichkeit, die Sichtbarkeit Ihrer Produktversion zu aktualisieren, wird nur für die Amazon EKS-Zusatzlieferoption aus den aufgelisteten Versionen unterstützt. Wenn Ihr Produkt noch nicht „Öffentlich“ ist, reichen Sie eine Anfrage zur Veröffentlichung des Produkts mit dem Sichtbarkeitsstatus „Öffentlich“ ein. Verwenden Sie dazu den AWS Marketplace Management Portal.

Wenn Sie eine Version mit der Zusatzlieferoption Amazon EKS erstellen, wird sie standardmäßig im Status „Eingeschränkt“ veröffentlicht. Der Status „Eingeschränkt“ bedeutet, dass das Produkt nicht in allen Regionen öffentlich verfügbar ist, sodass Ihre Käufer es in einem Amazon EKS-Cluster verwenden und bereitstellen können. Sie können die Sichtbarkeit der Lieferoption von „Eingeschränkt“ auf „Öffentlich“ ändern, indem Sie den StartChangeSet API-Vorgang mit dem UpdateDeliveryOptionsVisibility Änderungstyp aufrufen. Geben Sie die DeliveryOptions Id Version Ihres Produkts an, die der Amazon EKS-Add-On-Lieferoption entspricht.

Anforderungssyntax

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

Um den UpdateDeliveryOptionsVisibility Änderungstyp hinzuzufügen, geben Sie Informationen für die folgenden Felder ein:

  • Entity(Objekt) (erforderlich) — Ihr Produkt auf Containerbasis.

    • Identifier(string) (erforderlich) — Ihre Produkt-ID. Weitere Informationen finden Sie unter Kennung.

    • Type(string) (erforderlich) — Das Type basiert auf der Versandmethode (Produkttyp), die Ihr Produkt verwendet:ContainerProduct@1.0.

  • DetailsDocument(object) (erforderlich) — Details der Anfrage, einschließlich der Informationen zu den Repositorys, die Sie erstellen möchten. Die folgenden Felder sind alle erforderlich.

    • DeliveryOptions(Liste der Objekte) — Liste der DeliveryOption Objekte, einschließlich der Details zu den einzelnen Objekten:

      • Id(string) — Eindeutiger Bezeichner für dieDeliveryOption. (Um die eindeutige Kennung für zu erhaltenDeliveryOption, rufen Sie die DescribeEntity Aktion für das Produkt auf, das Sie aktualisieren.

      • TargetVisibility— Die beabsichtigte neue Sichtbarkeit des Produkts.

Syntax der Antwort

Für Ihre Anfrage wird ein Änderungssatz erstellt. Die Antwort auf diese Anfrage gibt Ihnen das ChangeSetId und ChangeSetArn für den Änderungssatz.

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

Die Änderungsanforderung wird einer Warteschlange hinzugefügt und verarbeitet, einschließlich des Scannens der Containerbilder und anderer Informationen, um sicherzustellen, dass sie den AWS Marketplace Richtlinien für Containerprodukte entspricht. Dieser Vorgang kann je nach Anzahl und Größe Ihrer Container einige Minuten bis Stunden dauern.

Sie können den Status der Anfrage über AWS Marketplace Management Portal die oder AWS Marketplace Catalog API mithilfe der DescribeChangeSet API-Operation überprüfen.

Weitere Informationen über Änderungssätze finden Sie unter Mit Änderungssätzen arbeiten. Weitere Informationen zu Fehlern in Produktänderungssets von Verkäufern finden Sie unterStatus und Fehler des Sets ändern.

Asynchrone Fehler

Die folgende Tabelle zeigt Fehler, die spezifisch für AddDeliveryOptions Aktionen in der AWS Marketplace Catalog API sind. Diese Fehler werden zurückgegeben, wenn Sie aufrufen, DescribeChangeSet nachdem ein Änderungssatz verarbeitet wurde. Weitere Hinweise zur Verwendung DescribeChangeSet zum Abrufen des Status einer Änderungsanforderung finden Sie unterMit Änderungssätzen arbeiten.

Fehlercode Fehlermeldung

EMPTY_DELIVERY_OPTION_IDS

Geben Sie eine Liste der Lieferoption-IDs an.

INVALID_VISIBILITY_STATE

Die von Ihnen angegebene TargetVisibility Option wird nicht unterstützt. Bitte versuchen Sie es erneut mit einer zulässigen Option. Die erlaubten Optionen sind: Public

INVALID_DELIVERY_OPTION_IDS

Sie haben ungültige Angaben zur Lieferoption angegeben. Geben Sie die Lieferoption-IDs an, die im Produkt zu finden sind. IDs wurden nicht gefunden: [x]

DUPLICATE_DELIVERY_OPTION_IDS

Doppelte Lieferoption-IDs: [duplicate_ids]. Geben Sie eindeutige Lieferoption-IDs an.

AUDIT_ERROR

Sie haben die Tests durch unabhängige Softwareanbieter (ISV) nicht für alle kompatiblen Amazon EKS-Cluster-Versionen für Ihre Amazon EKS-Add-On-Version (en) abgeschlossen. Sie müssen die Tests abschließen, bevor wir die Lieferoption (en) veröffentlichen können.

INVALID_DELIVERY_OPTION_TYPE

Die von Ihnen angegebene Versandoption ist ungültig. Stellen Sie sicher, dass Ihre Lieferoption vom Typ: ist, EksAddOn und versuchen Sie es erneut.

INCOMPATIBLE_HELM_OBJECTS

Stellen Sie ein Helm Diagramm ohne nicht unterstützte Helm Objekte bereit: Die folgenden Objekte werden nicht unterstützt: alle Helm Release-Objekte (außer .Name und .Namespace), Hooks und Suchfunktionen. Helm

INKOMPATIBLE_ADDON_NAME

Der Name des Add-ons [provided_name] stimmt nicht mit dem Namen der öffentlichen Version überein. Aktualisieren Sie den öffentlichen Namen vor der Veröffentlichung.

INCOMPATIBLE_ADDON_TYPE

Die Add-On-Typen stimmen nicht überein. Verwenden Sie den vorhandenen Add-On-Typ aus der öffentlichen Add-On-Version oder früheren Add-On-Versionen dieses Produkts wieder. Für jedes Produkt wird nur ein Add-on unterstützt.

INCOMPATIBLE_ADDON_NAMESPACE

Der bereitgestellte Add-On-Namespace [provided_namespace] stimmt nicht mit dem Namespace der öffentlichen Version überein. Aktualisieren Sie den Add-On-Namespace vor der Veröffentlichung.

Erstellen Sie Repositorys und Ressourcen

Um eine neue Version eines containerbasierten Produkts zu erstellen, müssen Ihnen die Ressourcen für die Version in Repositorys zur Verfügung stehen. AWS Marketplace Sie erstellen die Repositorys und laden dann die Ressourcen (undHelm) in die Docker Repositorys hoch. Informationen zum Erstellen der Repositorys mithilfe von finden Sie im Verkäuferleitfaden unter Neue Version Ihres Produkts hinzufügen. AWS Marketplace Management PortalAWS Marketplace

Um neue Repositorys zu erstellen, rufen Sie StartChangeSet mit dem AddRepositories Änderungstyp auf, wie im folgenden Beispiel gezeigt.

Anforderungssyntax

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

Geben Sie Informationen für die Felder an, um den AddRepositories Änderungstyp hinzuzufügen:

Weitere Informationen zum Erstellen von Repositorys finden Sie im AWS Marketplace Verkäuferleitfaden unter Hinzufügen einer neuen Version.

  • Entity(Objekt) (erforderlich) — Ihr Produkt auf Containerbasis.

    • Identifier (Zeichenfolge) (erforderlich) — Ihre Produkt-ID. Weitere Informationen finden Sie unter Kennung.

    • Type(Zeichenfolge) (erforderlich) — Das Type basiert auf der Versandmethode (Produkttyp), die Ihr Produkt verwenden wird:ContainerProduct@1.0.

  • DetailsDocument(object) (erforderlich) — Einzelheiten der Anfrage. Es enthält die Informationen zu den Repositorys, die Sie erstellen möchten. Die enthaltenen Felder sind alle erforderlich.

    • Repositories(Anordnung von Strukturen) — Eine Liste von Repository-Objekten. Jedes Repository-Objekt enthält einen Namen und einen Typ.

      • RepositoryName(string) — Der Name des zu erstellenden Repositorys.

      • RepositoryType(string) — Der Typ des zu erstellenden Repositorys. Der einzige zulässige Wert ist ECR.

Anmerkung

Sie können bis zu 70 Repositorys pro Produkt haben. Sie können jedoch mehrere Ressourcen und Versionen von Ressourcen zu einem einzigen Repository hinzufügen, indem Sie ihnen beim Push unterschiedliche Tags zuweisen.

Nachdem Sie ein oder mehrere Repositorys erstellt haben, fügen Sie Ihre Ressourcen den Repositorys hinzu. Informationen zum Push von Ressourcen in Repositorys finden Sie unter Pushing an Image im Amazon Elastic Container Registry User Guide. Informationen zu den spezifischen Push-Befehlen, die für eines Ihrer Repositorys erforderlich sind, finden Sie im AWS Marketplace Verkäuferleitfaden unter Hinzufügen einer neuen Version.

Asynchrone Fehler

Die folgenden Fehler beziehen sich spezifisch auf AddRepositories Aktionen in. AWS Marketplace Catalog API Diese Fehler werden zurückgegeben, wenn Sie aufrufen, DescribeChangeSet nachdem ein Änderungssatz verarbeitet wurde. Weitere Hinweise zur Verwendung DescribeChangeSet zum Abrufen des Status einer Änderungsanforderung finden Sie unterMit Änderungssätzen arbeiten.

Fehlercode Fehlermeldung

INVALID_ECR_REPOSITORY_NAME

Geben Sie den Repository-Namen im Format an: 'nginx-web-app'

DUPLIZIERTER_ECR_REPOSITORY_NAME

Das Repository [duplicate_repo_names] existiert bereits. Wählen Sie einen anderen Namen.

FEHLENDE REPOSITORY-INFORMATIONEN

Geben Sie mindestens einen Repository-Namen an.

UNGÜLTIGER_ECR_REPOSITORY_NAME

Die maximale Zeichenlänge 256 wurde erreicht. Die Anzahl der Zeichen umfasst den Verkäufer-Namespace.

Versionsinformationen aktualisieren

Sie können die Katalog-API verwenden, um die Details einer vorhandenen Version Ihres containerbasierten Produkts in zu aktualisieren. AWS Marketplace

Anmerkung

Wenn ein Produkt öffentlich verfügbar ist, können Sie den Versionstitel, die Container-Images, den Titel der Lieferoption oder die Bereitstellungsressourcen für die Version nicht aktualisieren. Wenn Sie diese Aspekte eines Produkts aktualisieren müssen, erstellen Sie stattdessen eine neue Version.

Um eine bestehende Version Ihres containerbasierten Produkts zu aktualisieren, rufen Sie den StartChangeSet API-Vorgang mit dem UpdateDeliveryOptions Änderungstyp auf, wie im folgenden Beispiel gezeigt. Dadurch werden die Detailinformationen für die von Ihnen angegebenen Lieferoptionen sowie die zugehörige Version aktualisiert. Sie müssen mindestens eine Lieferoption angeben.

Syntax der Anfrage für die Lieferung von Container-Images

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

HelmSyntax der Anfrage zur Lieferung von Diagrammen

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

Syntax der Amazon Add-On EKS-Lieferanforderung

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

Geben Sie Informationen für die Felder an, um den UpdateDeliveryOptions Änderungstyp hinzuzufügen:

Weitere Informationen zu diesen Feldern finden Sie im AWS Marketplace Verkäuferleitfaden unter Hinzufügen einer neuen Version.

  • Entity(Objekt) (erforderlich) — Ihr Produkt auf Behälterbasis.

    • Identifier(string) (erforderlich) — Ihre Produkt-ID. Weitere Informationen finden Sie unter Kennung.

    • Type(string) (erforderlich) — Das Type basiert auf der Versandmethode (Produkttyp), die Ihr Produkt verwenden wird:ContainerProduct@1.0.

  • DetailsDocument(object) (erforderlich) — Einzelheiten der Anfrage. Es enthält alle Informationen über die Version Ihres containerbasierten Produkts, die Sie aktualisieren möchten. Die enthaltenen Felder sind alle optional, Sie müssen jedoch mindestens ein Feld angeben, um sie zu aktualisieren.

    • Version(Objekt) — Details zur Softwareversion.

      • VersionTitle(string) — Der Titel der Version, die Sie erstellen. In der Regel ist dies eine Beschreibung der Version, z. B. Version 1.1 oder einfach1.1. Ihre Käufer können aus einer Liste aller Versionstitel die Version auswählen, die bereitgestellt werden soll.

        Diese Eigenschaft kann nicht aktualisiert werden, wenn das Produkt bereits öffentlich veröffentlicht wurde.

      • ReleaseNotes(string) — Hinweise für Käufer, um sie über Änderungen von einer Version zur nächsten zu informieren.

    • DeliveryOptions(Liste der Objekte) — Liste der DeliveryOption Objekte, einschließlich der Details zu den einzelnen Objekten:

      • Id(string) — Eindeutige Kennung für DeliveryOption (Sie können die eindeutige Kennung für abrufen, DeliveryOption indem Sie die DescribeEntity Aktion für das Produkt aufrufen, das Sie aktualisieren).

      • Details(Objekt) — Enthält die Details einer Lieferoption. Beachten Sie, dass dieses verschachtelte Detailobjekt nicht doppelt maskiert werden muss.

        • EcrDeliveryOptionDetails(Objekt) — Die Details der Option zur Bereitstellung von Container-Images.

          • DeliveryOptionTitle(Zeichenfolge) — Eine kurze Beschreibung, anhand derer Ihr Käufer zwischen Ihren Lieferoptionen wählen kann.

            Diese Eigenschaft kann nicht aktualisiert werden, wenn das Produkt bereits öffentlich veröffentlicht wurde.

          • ContainerImages(Array von Zeichenketten) — Ein Array von Container-Image-URLs, die von dieser Version verwendet werden. Der Pfad ist das Repository, in das Sie das Bild hochgeladen haben, mit dem Tag für das von dieser Version verwendete Bild. Wenn dieses Feld enthalten ist, muss die Liste alle benötigten Bilder enthalten, auch Bilder, die sich nicht ändern.

            Diese Eigenschaft kann nicht aktualisiert werden, wenn das Produkt bereits öffentlich veröffentlicht wurde.

          • DeploymentResources(Array von Objekten) — Eine Reihe anderer Bereitstellungsressourcen, die für die Version benötigt werden, z. B. Links zu Helm Diagrammen oder anderer Dokumentation. Jede Ressource enthält einen Namen zur Beschreibung und eine URL, die auf die Ressource verweist. Auf der Startseite Ihrer Version wird dies als Linkliste angezeigt.

            Diese Eigenschaft kann nicht aktualisiert werden, wenn das Produkt bereits öffentlich veröffentlicht wurde.

            • Name(string) — Der Text des Hyperlinks, der dem Käufer angezeigt wird.

            • Url(string) — Die URL des Hyperlinks, der dem Käufer angezeigt wird.

          • CompatibleServices(Array von Zeichenketten) — Eine Reihe von Diensten, mit denen die Version kompatibel ist. Gültige Optionen: ECSEKS,ECS-Anywhere,EKS-Anywhere, undBedrock-AgentCore.

          • AgenticTypeDer Typ des Runtime-Agenten. Gültige Optionen: AGENTMCP_SERVER, oderA2A_SERVER.

          • Description(Zeichenfolge) — Eine längere Beschreibung der Lieferoption, um Ihrem Käufer weitere Informationen zu geben. Sie können auch einen Link zu weiteren Anweisungen hinzufügen, die an anderer Stelle gehostet werden.

          • UsageInstructions(Zeichenfolge) — Geben Sie Anweisungen zur Bereitstellung und Verwendung Ihres Produkts. Sie können auch einen Link zu Nutzungsanweisungen hinzufügen, die an anderer Stelle gehostet werden. Kann bis zu 4.000 Zeichen lang sein.

          • EnvironmentVariables— Liste der Umgebungsvariablen, die für den AgentCore Runtime-Container erforderlich sind und die für Käufer bei der Bereitstellung vorab ausgefüllt werden. Geben Sie für jede Variable ein Objekt mit dem von Ihrem Container erwarteten Namen, einer Beschreibung und einem optionalen defaultValue an. Geben Sie für eindeutige Variablen wie Anmeldeinformationen oder API-Schlüssel keinen Standardwert an. Sie können die Beschreibung verwenden, um Details zur Variablen sowie mögliche Werte anzugeben. Alle bereitgestellten Variablen mit ihren Standardwerten werden vorab ausgefüllt, wenn Käufer Ihr Produkt auf den Markt bringen.

      • Id(string) — Eindeutige Kennung für DeliveryOption (Sie können die eindeutige Kennung für abrufen, DeliveryOption indem Sie die DescribeEntity Aktion für das Produkt aufrufen, das Sie aktualisieren).

      • Details(Objekt) — Enthält die Details einer Lieferoption. Beachten Sie, dass dieses verschachtelte Detailobjekt nicht doppelt maskiert werden muss.

        • HelmDeliveryOptionDetails(Objekt) — Die Details der Option zur Lieferung von Helm Diagrammen.

          • DeliveryOptionTitle(string) — Eine kurze Beschreibung, die es Ihrem Käufer ermöglicht, zwischen Ihren Lieferoptionen zu wählen.

            Diese Eigenschaft kann nicht aktualisiert werden, wenn das Produkt bereits öffentlich veröffentlicht wurde.

          • ContainerImages(Array von Zeichenketten) — Ein Array von Container-Image-URLs, die von dieser Version verwendet werden. Der Pfad ist das Repository, in das Sie das Bild hochgeladen haben, mit dem Tag für das von dieser Version verwendete Bild. Die Liste muss alle benötigten Bilder enthalten, auch Bilder, die sich gegenüber früheren Versionen nicht geändert haben. Im nächsten Abschnitt finden Sie Informationen zum Erstellen von Repositorys mithilfe der Catalog API.

          • HelmChartUri(string) — Die URL zu dem in Amazon ECR gehosteten Helm Diagramm, das der Käufer installieren wird, um die Software zu starten.

          • CompatibleServices(Array von Zeichenketten) — Eine Reihe von Diensten, mit denen die Version kompatibel ist. Gültige Optionen sind ECS und EKS.

          • Description(string) — Eine längere Beschreibung der Lieferoption, um Ihrem Käufer weitere Informationen zu geben. Sie können auch einen Link zu weiteren Anweisungen hinzufügen, die an anderer Stelle bereitgestellt werden.

          • UsageInstructions(Zeichenfolge) — Geben Sie Anweisungen zur Verwendung dieser Versandoption an. Kann bis zu 4.000 Zeichen lang sein.

          • MarketplaceServiceAccountName(string) — Der Name des Kubernetes Dienstkontos. Das Dienstkonto wird verwendet, um eine Verbindung herzustellen, um Berechtigungen AWS Identity and Access Management zum Aufrufen von AWS Diensten zu erhalten.

          • ReleaseName(string) — Der Name für die Helm Version, die für den helm install Befehl angegeben wurde, mit dem Käufer die Software starten.

          • Namespace(string) — Der Kubernetes Namespace, in dem das Helm Diagramm installiert wird.

          • OverrideParameters(Array von Objekten) — Parameter, die in den Helm Befehlen verwendet werden, mit denen die Anwendung gestartet wird. Käufer können die Standardwerte überschreiben.

            • Key(string) — Der Schlüssel für den Parameter in Punktnotation (override.example.key).

            • DefaultValue(string) — Der Standardwert für diesen Override-Parameter.

Syntax der Antwort

Für Ihre Anfrage wird ein Änderungssatz erstellt. Die Antwort auf diese Anfrage gibt Ihnen das ChangeSetId und ChangeSetArn für den Änderungssatz und sieht wie folgt aus.

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

Die Änderungsanforderung wird einer Warteschlange hinzugefügt und verarbeitet, einschließlich des Scannens der Container-Bilder und anderer Informationen, um sicherzustellen, dass sie den AWS Marketplace Richtlinien für Containerprodukte entspricht. Dieser Vorgang kann je nach Anzahl und Größe Ihrer Container einige Minuten bis Stunden dauern.

Sie können den Status der Anfrage über die oder direkt über die AWS Marketplace Management Portal Katalog-API mithilfe des DescribeChangeSet API-Vorgangs überprüfen.

Weitere Informationen über Änderungssätze finden Sie unter Mit Änderungssätzen arbeiten. Weitere Informationen zu Fehlern in Produktänderungssets von Verkäufern finden Sie unterStatus und Fehler des Sets ändern.

Asynchrone Fehler

Die folgenden Fehler beziehen sich spezifisch auf UpdateDeliveryOptions Aktionen in. AWS Marketplace Catalog API Diese Fehler werden zurückgegeben, wenn Sie aufrufen, DescribeChangeSet nachdem ein Änderungssatz verarbeitet wurde. Weitere Hinweise zur Verwendung DescribeChangeSet zum Abrufen des Status einer Änderungsanforderung finden Sie unterMit Änderungssätzen arbeiten.

Fehlercode Fehlermeldung

INCOMPATIBLE_PRODUCT_STATUS

Verwenden Sie ein vorhandenes limitiertes oder öffentliches Produkt.

INKOMPATIBLE_SERVICES

Die Dienstliste enthält inkompatible Dienste. [incompatible_services] Stellen Sie eine gültige Liste kompatibler Dienste bereit.

NO_SERVICE_SPECIFIED

Stellen Sie mindestens einen kompatiblen Dienst bereit.

DUPLICATE_COMPATIBLE_AWS_SERVICES

Die Serviceliste enthält doppelte Einträge. Entferne sie. Jeder Eintrag muss einzigartig sein.

INVALID_VERSION_TITLE

Entfernen Sie Leerzeichen vor dem Markensymbol.

UNGÜLTIGER VERSIONSTITEL

Entfernen Sie die folgenden nicht unterstützten Zeichen: [x, y, z]

UNGÜLTIGER VERSIONSTITEL

Entfernen Sie Leerzeichen am Anfang des Versionstitels.

UNGÜLTIGER_VERSIONSTITEL

Geben Sie einen Versionstitel mit weniger als [x] Zeichen an.

DUPLICATE_VERSION_TITLE

Der Versionstitel [duplicate_version_title] ist ein Duplikat. Entferne oder ändere den Titel.

INVALID_RELEASE_NOTES

Entfernen Sie Leerzeichen vor dem Markensymbol.

INVALID_RELEASE_NOTES

Nicht unterstützte Zeichen entfernen: [x, y, z]

UNGÜLTIGE_VERSIONSHINWEISE

Entfernen Sie Leerzeichen am Anfang der Versionshinweise.

INVALID_RELEASE_NOTES

Geben Sie Versionshinweise mit weniger als (x) Zeichen an.

UNGÜLTIGE VERWENDUNGSHINWEISE

Entfernen Sie Leerzeichen vor dem Markensymbol.

UNGÜLTIGE VERWENDUNGSHINWEISE

Nicht unterstützte Zeichen entfernen: [x, y, z]

UNGÜLTIGE NUTZUNGSANWEISUNGEN

Geben Sie Nutzungsanweisungen mit weniger als (x) Zeichen an.

INVALID_USAGE_INSTRUCTIONS

Geben Sie Anweisungen zur Verwendung an.

FEHLENDES_CONTAINER_IMAGES

Stellen Sie mindestens ein Container-Image bereit.

ZU VIELE_CONTAINER-IMAGES

Stellen Sie weniger als 50 Container-Images bereit.

DUPLICATE_CONTAINER_IMAGES

Die Container-Bilderliste enthält doppelte Bilder: [duplicate_images]. Stellen Sie eine Liste mit eindeutigen Bildern bereit.

INVALID_CONTAINER_IMAGES

Geben Sie eine gültige URI für das Container-Image an.

INVALID_CONTAINER_IMAGE_URI

Das Bild [invalid_image_uri] hat keinen Zugriff auf dieses Produkt. Laden Sie das Bild in das entsprechende Produkt-Repository hoch. Informationen zum Hochladen finden Sie unter Erste Schritte mit Container-Produkten.

INVALID_CONTAINER_IMAGE_TAG

Vermeiden Sie die Verwendung des Tags „latest“.

MISSING_DELIVERY_OPTION_IDS

Geben Sie die Lieferoption aus der vorhandenen ID-Liste an.

EMPTY_DELIVERY_OPTION_IDS

Geben Sie eine nicht leere Liste der Lieferoption-IDs an.

DUPLICATE_DELIVERY_OPTION_IDS

Doppelte Lieferoption-IDs: [duplicate_ids]. Geben Sie eindeutige Lieferoption-IDs an.

DUPLICATE_DELIVERY_OPTION_TITLES

Doppelte Titel der Lieferoptionen: [duplicate_titles]. Entferne die Duplikate

INVALID_DELIVERY_OPTION_TITLES

Die Titel der Lieferoptionen [existing_titles] sind bereits vorhanden. Geben Sie einen anderen Titel an.

UNGÜLTIGER_ERFÜLLUNGSOPTIONSTITEL

Geben Sie den Titel der Lieferoption mit weniger als (x) Zeichen an.

LEERER_RESSOURCENNAME

Geben Sie den Namen der Ressource an.

EMPTY_RESOURCE_URL

Geben Sie die Ressourcen-URL an.

UNGÜLTIGER_RESSOURCENNAME

Geben Sie einen Ressourcennamen mit weniger als 256 Zeichen an.

INVALID_RESOURCE_URL

Geben Sie eine Ressourcen-URL mit weniger als 256 Zeichen an.

INVALID_SHORT_DESCRIPTION

Geben Sie eine kurze Beschreibung mit weniger als 1.000 Zeichen ein.

INVALID_SHORT_DESCRIPTION

Geben Sie eine kurze Beschreibung ein.

NO_LICENSE_SECRET_KEYS

Geben Sie für Amazon EKS Anywhere Anywhere-Produkte einen Override-Parameter für den Lizenzschlüssel an. Anforderungen DefaultValue von"${AWSMP_LICENSE_SECRET}", siehe Beispiel im Abschnitt.

NO_SERVICE_ACCOUNT_CONFIGURATION

Geben Sie für kostenpflichtige Produkte einen Override-Parameter für die Konfiguration des Dienstkontos an. Anforderungen DefaultValue von"${AWSMP_SERVICE_ACCOUNT}", siehe Beispiel im Abschnitt.

SCAN_ERROR

Sicherheitslücke „" [y] "“ im Bild „" [x] "“ behoben.

FIELD_NOT_ALLOWED_TO_CHANGE

Das Feld [x] kann nicht geändert werden.

INVALID_DELIVERY_OPTIONS_STATUS

Die Lieferoption-IDs [invalid_ids] sind ungültig. Geben Sie Lieferoptionen im eingeschränkten oder öffentlichen Zustand an.

NO_CHANGE_FOUND

Geben Sie mindestens eine Änderung ein.

MULTIPLE_VERSION_UPDATE

Geben Sie die IDs der Versandoptionen aus derselben Version an.

OVERRIDE_PARAMETER_KEYS_CONTAINS_SPECIAL_CHARS

Die Override-Parameterschlüssel [invalid_keys] enthalten ungültige Zeichen. Ihre Schlüssel dürfen nur Buchstaben, Zahlen, doppelte Anführungszeichen („“) und Pluszeichen (+) enthalten.

INVALID_CONTAINER_IMAGE_REPOSITORY

Die Repositorien [invalid_repositories] sind ungültig. Stellen Sie Repositorys bereit, die mit dem Änderungstyp erstellt wurden. AddRepositories

INVALID_CONTAINER_IMAGE_TAG_FORMAT

Das Container-Image-Tag [invalid_image_tag] ist ungültig. Geben Sie ein Tag an, das dem regulären Ausdruck {CONTAINER_IMAGE_TAG_REGEX} entspricht.

PARAMETERSCHLÜSSEL DUPLIZIEREN

Die Override-Parameter enthalten doppelte Schlüssel [duplicate_keys]. Entferne die Duplikate.

UNSUPPORTED_CONTAINER_IMAGE_URI

Das Container-Image [unsupported_image] wird nicht unterstützt. Stellen Sie ein Image bereit, das dem Image-Manifest V 2, Schema 1 folgt.

UNGÜLTIGER NAMESPACE

Die Namespace-Werte [invalid_namespaces] sind ungültig. Geben Sie Werte an, die dem regulären Ausdruck {HELM_RELEASE_PARAM_REGEX} entsprechen.

UNGÜLTIGER_RELEASENAME

Die ReleaseName-Werte [invalid_release_names] sind ungültig. Geben Sie Werte an, die dem regulären Ausdruck {HELM_RELEASE_PARAM_REGEX} entsprechen.

OVERRIDE_PARAMETER_KEYS_CONTAINS_RESERVED_PARAMETER_KEYS

Der Override-Parameterschlüssel für Übermittlungsoptionstitel [invalid_keys] ist reserviert. Reservierte Schlüssel: [reserved_param_keys]. Geben Sie einen anderen Schlüssel an.

INKOMPATIBLE_ADDON_NAME

Der Name des Add-ons [provided_name] stimmt nicht mit dem vorhandenen Namen überein. Verwenden Sie den vorhandenen Namen aus der öffentlichen Version oder früheren Versionen dieses Add-ons wieder. Sie können für jedes Produkt nur einen Add-On-Namen verwenden.

INCOMPATIBLE_ADDON_NAMESPACE

Der Add-On-Namespace [provided_namespace] stimmt nicht mit dem vorhandenen Namespace überein. Verwenden Sie den vorhandenen Namespace aus der öffentlichen Version oder früheren Versionen dieses Add-ons wieder. Sie können für jedes Produkt nur einen Add-On-Namespace verwenden.

Eine Version einschränken

Sie können die Katalog-API verwenden, um eine Version Ihres containerbasierten Produkts in einzuschränken. AWS Marketplace Dadurch wird verhindert, dass neue Käufer diese Version verwenden können. Ein Produkt muss mindestens eine öffentlich verfügbare Version enthalten. Sie können die einzige verbleibende öffentlich verfügbare Version für ein Produkt nicht einschränken.

Um eine Version einzuschränken, rufen Sie den StartChangeSet API-Vorgang mit dem RestrictDeliveryOptions Änderungstyp auf, wie im folgenden Beispiel gezeigt.

Anmerkung

Wenn Sie eine oder mehrere, aber nicht alle Lieferoptionen einer Version einschränken, stehen diese Optionen Ihren Käufern nicht mehr zur Verfügung. Wenn Sie alle Lieferoptionen für eine Version einschränken, wird diese Version aus dem AWS Marketplace Katalog entfernt.

Das Einschränken eines Amazon EKS-Add-ons wird derzeit nicht über die Catalog API unterstützt.

Eingeschränkte Versionen sind weiterhin für Bestandskunden verfügbar.

Anforderungssyntax

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

Geben Sie Informationen für die Felder an, um den RestrictDeliveryOptions Änderungstyp hinzuzufügen:

  • Entity(Objekt) (erforderlich) — Ihr Produkt auf Containerbasis.

    • Identifier(string) (erforderlich) — Ihre Produkt-ID. Weitere Informationen finden Sie unter Kennung.

    • Type(string) (erforderlich) — Das Type basiert auf der Versandmethode (Produkttyp), die Ihr Produkt verwenden wird:ContainerProduct@1.0.

  • DetailsDocument(object) (erforderlich) — Einzelheiten der Anfrage. Es enthält IDs für die Lieferoptionen Ihres Produkts in Behältern, die Sie einschränken möchten.

    • DeliveryOptionIds(Zeichenkettenarray) — Liste der DeliveryOption IDs für die Versionen, die Sie einschränken möchten. Sie können die eindeutige Kennung für abrufen, DeliveryOption indem Sie die DescribeEntity Aktion für das Produkt aufrufen, das Sie einschränken möchten.

Syntax der Antwort

Für Ihre Anfrage wird ein Änderungssatz erstellt. Die Antwort auf diese Anfrage gibt Ihnen das ChangeSetId und ChangeSetArn für den Änderungssatz und sieht wie folgt aus.

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

Die Änderungsanforderung wird einer Warteschlange hinzugefügt und verarbeitet. Dieser Vorgang kann einige Minuten bis Stunden dauern.

Sie können den Status der Anfrage über die oder direkt über die AWS Marketplace Management Portal Katalog-API mithilfe des DescribeChangeSet API-Vorgangs überprüfen.

Weitere Informationen über Änderungssätze finden Sie unter Mit Änderungssätzen arbeiten. Weitere Informationen zu Fehlern in Produktänderungssets von Verkäufern finden Sie unterStatus und Fehler des Sets ändern.

Asynchrone Fehler

Die folgenden Fehler beziehen sich spezifisch auf RestrictDeliveryOptions Aktionen in. AWS Marketplace Catalog API Diese Fehler werden zurückgegeben, wenn Sie aufrufen, DescribeChangeSet nachdem ein Änderungssatz verarbeitet wurde. Weitere Hinweise zur Verwendung DescribeChangeSet zum Abrufen des Status einer Änderungsanforderung finden Sie unterMit Änderungssätzen arbeiten.

Fehlercode Fehlermeldung

INCOMPATIBLE_PRODUCT_STATUS

Verwenden Sie ein öffentliches Produkt.

MISSING_DELIVERY_OPTION_IDS

Geben Sie die Lieferoption aus der vorhandenen ID-Liste an.

INVALID_DELIVERY_OPTIONS_STATUS

Die Lieferoption-IDs [invalid_ids] sind ungültig. Stellen Sie Lieferoptionen im öffentlichen Bereich bereit.

EMPTY_DELIVERY_OPTION_IDS

Geben Sie eine nicht leere Liste der Lieferoption-IDs an.

INVALID_MINIMUM_PUBLIC_DELIVERY_OPTIONS

Es können nicht alle Lieferoption-IDs eingeschränkt werden.

DUPLICATE_DELIVERY_OPTION_IDS

Doppelte Lieferoption-IDs: [duplicate_ids]. Geben Sie eindeutige Lieferoption-IDs an.