View a markdown version of this page

Arbeiten Sie mit AMI-based Produkten - AWS Marketplace

Die AWS Marketplace-API-Referenz wurde umstrukturiert. 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 AMI-based Produkten

Sie können die verwenden AWS Marketplace Catalog API , um Aufgaben für die Arbeit mit auf Amazon Machine Image (AMI) basierenden Produkten zu automatisieren.

Informationen zum Erstellen eines AMI-based Produkts mithilfe der Catalog API finden Sie unterErstellen Sie ein Produkt.

In den folgenden Themen wird beschrieben, wie Sie die Catalog API verwenden, um Aktionen an Ihren AMI-based Produkten durchzuführen:

Fügen Sie eine neue Version hinzu

Sie können die Catalog API verwenden, um einem vorhandenen AMI-based Produkt in eine neue Version hinzuzufügen AWS Marketplace. Weitere Informationen zum Hinzufügen neuer AMI-Versionen zu Ihrem Produkt mithilfe von finden Sie unter Hinzufügen einer neuen Version im AWS Marketplace Verkäuferhandbuch. AWS Marketplace Management Portal

Wenn Sie eine Anfrage erstellen, die das Hinzufügen eines neuen AMI zum AWS Marketplace beinhaltet, muss das AMI in das AWS Marketplace-System kopiert und dann auf Sicherheitsprobleme überprüft werden. Sie müssen AWS Marketplace Zugriff auf das AMI gewähren, indem Sie eine AWS Identity and Access Management (IAM) -Rolle mit Berechtigungen zum Ausführen von Aktionen an Ihrem AMI erstellen. Weitere Informationen zu den erforderlichen Berechtigungen finden Sie im AWS Marketplace Verkäuferleitfaden unter Gewähren von AWS Marketplace Zugriff auf Ihr AMI.

Um eine neue Version hinzuzufügen, rufen Sie den StartChangeSet API-Vorgang mit dem AddDeliveryOptions Änderungstyp für AMI-based Produkte auf, wie im folgenden Beispiel gezeigt. Um Ihren API-Aufruf zu testen, ohne tatsächlich eine neue Version zu erstellen, setzen Sie den Intent Parameter aufVALIDATE. Weitere Informationen finden Sie unter Absicht.

Anmerkung

Bei AMI-Produkten besteht eine Version aus einer oder mehreren Lieferoptionen. Alle Lieferoptionen in derselben Version müssen dasselbe AmiSource Objekt mit denselben Details enthalten. Alle Lieferoptionen müssen einer Version hinzugefügt werden, wenn die Version erstellt wird. Es ist nicht möglich, einer vorhandenen Version Lieferoptionen hinzuzufügen.

Anforderungssyntax

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

Die folgende Liste enthält Informationen zu den Eingabefeldern, die Sie für den AddDeliveryOptions Änderungstyp verwenden. Alle Felder sind erforderlich, sofern nicht anders angegeben. Weitere Informationen zu diesen Feldern finden Sie im AWS Marketplace Verkäuferleitfaden unter Hinzufügen einer neuen Version.

  • DeliveryOptions(Reihe von Objekten) — Eine Liste von Lieferoptionsobjekten, einschließlich der Details zu den einzelnen Objekten. Sie müssen mindestens eines angeben.

    • Geben Sie für die AMI-Lieferoption (Standalone) ein Objekt mit den folgenden Details an. Bei diesem Typ können Sie nur eine Lieferoption haben.

      • Details (Objekt) — Enthält die Details dieser Lieferoption. Beachten Sie, dass für dieses verschachtelte Detailobjekt kein doppeltes Escape-Symbol erforderlich ist.

        • AmiDeliveryOptionDetails(Objekt) — Wird verwendet, um die Details der einzelnen AMI-Lieferoptionen bereitzustellen.

          • AmiSource(Objekt) — Details über das AMI, das für die hinzugefügte Version verwendet werden soll.

            • AmiId(string) — ID für das Quell-AMI, die sich an der AWS-Region Stelle befindet, an der die API aufgerufen wird. Dies muss immer US East (Nord-Virginia) sein, da dies die einzige Region ist, in der die Catalog API verfügbar ist. Muss zum Anruferkonto gehören.

            • AccessRoleArn(string) — Die IAM-Rolle Amazon Resource Name (ARN), die von für den AWS Marketplace Zugriff auf das bereitgestellte AMI verwendet wird. Einzelheiten zur Erstellung und Verwendung dieses ARN finden Sie im AWS Marketplace Verkäuferleitfaden unter Gewähren des Zugriffs auf Ihr AMI für AWS Marketplace.

            • UserName(string) — Login-Benutzername für den Zugriff auf das Betriebssystem (OS) im AMI. In der Regel ec2-user für Linux-AMIs oder Administrator für Windows.

            • ScanningPort(Integer) — SSH- oder RDP-Port, der für den Zugriff auf das Betriebssystem verwendet wird. Wird verwendet, um das bereitgestellte AMI nach Sicherheitslücken zu durchsuchen. Die Standardeinstellung ist 22.

            • OperatingSystemName(string) — Name des Betriebssystems, das Käufern angezeigt wird.

            • OperatingSystemVersion(string) — Die Zeichenfolge mit der Betriebssystemversion, die Käufern angezeigt wird.

            • AfiIds(Zeichenkettenarray) (optional) — Amazon FPGA Image (AFI) -IDs, um die FPGA-Unterstützung für diese Version zu aktivieren. Wenn diese Option bereitgestellt wird, kann Ihr Produkt auf FPGA-enabled F2-Instance-Typen ausgeführt werden. Sie können bis zu 15 AFI-IDs pro Version angeben. Alle von Ihnen angegebenen AFI-IDs müssen aus der Region USA Ost (Nord-Virginia) stammen und in Ihrem AWS-Marketplace-Verkäuferkonto enthalten sein. Die angegebene IAM-Zugriffsrolle sollte berechtigt sein, dieses AFI mit AWS Marketplace zu teilen. Weitere Informationen zu den erforderlichen Berechtigungen finden Sie im AWS Marketplace Verkäuferleitfaden unter Gewähren des Zugriffs auf Ihre FPGA-Images für AWS Marketplace.

          • UsageInstructions(string) — Anweisungen zur Verwendung des AMI oder ein Link zu weiteren Informationen über das AMI.

          • AccessEndpointUrl(Objekt) (optional) — Wird verwendet, um einen Pfad für den Zugriff auf das AMI zu erstellen, nachdem es verwendet wurde.

            • Port (string) — Die Portnummer, die für den Zugriff auf den Dienst verwendet wird, der auf dem AMI ausgeführt wird.

            • Protokoll (Zeichenfolge) — Das Protokoll (http oder https), das für den Zugriff auf den Dienst verwendet wird, der auf dem AMI ausgeführt wird.

            • RelativePath(string) — Der Pfad vom Web-Root zum Zugriff auf den Dienst, der auf dem AMI ausgeführt wird (z. B. /index.html).

          • RecommendedInstanceType(string) — Der Instance-Typ, der für die Ausführung des Dienstes mit dem AMI empfohlen wird und der Standard für 1-Klick-Installationen Ihres Dienstes ist. Eine Liste der Instance-Typen finden Sie unter Instance-Typen im Amazon Elastic Compute Cloud-Benutzerhandbuch für Linux-Instances.

          • SecurityGroups(Reihe von Objekten) — Eine Liste von Objekten, die Eingangsregeln für die automatisch erstellten Gruppen für die Version darstellen.

            • IpProtocol(string) — Das zu verwendende Protokoll (tcp oder udp).

            • FromPort(Integer) — Der Quellport.

            • ToPort(integer) — Der Zielport.

            • IpRanges(Zeichenkettenarray) — Zulässige IP-Bereiche im CIDR-Format (in der Form xxx.xxx.xxx. xxx/nn, zum Beispiel). 192.0.2.0/24

    • Geben Sie für AMI mit CloudFormation Lieferoption ein Objekt mit den folgenden Details an. Sie können bis zu drei Lieferoptionen dieses Typs haben.

      • DeliveryOptionTitle(string) — Titel für die Lieferoption.

      • Details (Objekt) — Enthält die Details einer AMI-Lieferoption. Beachten Sie, dass für dieses verschachtelte Detailobjekt kein doppeltes Escape-Symbol erforderlich ist.

        • DeploymentTemplateDeliveryOptionDetails(Objekt) — Wird verwendet, um die Details der einzelnen CFT-Lieferoptionen anzugeben.

          • ShortDescription(string) — Kurze Beschreibung Ihrer CloudFormation Vorlagen-Versandoption.

          • LongDescription(string) — Detaillierte Beschreibung Ihrer Versandoption CloudFormation für Vorlagen.

          • UsageInstructions(string) — Anweisungen zur Verwendung des AMI oder ein Link zu weiteren Informationen über das AMI.

          • RecommendedInstanceType(string) — Der Instance-Typ, der für die Ausführung des Dienstes mit dem AMI empfohlen wird und der Standard für 1-Klick-Installationen Ihres Dienstes ist. Eine Liste der Instance-Typen finden Sie unter Instance-Typen im Amazon Elastic Compute Cloud-Benutzerhandbuch für Linux-Instances.

          • ArchitectureDiagram(string) — URL zum Speicherort Ihres Architekturdiagramms in Amazon S3.

          • Template (string) — URL zum Speicherort Ihrer CloudFormation Vorlage in Amazon S3.

          • TemplateSources(Reihe von Objekten)

            • ParameterName(string) — Name des Parameters in der CloudFormation Vorlage, an den das AMI in dieser Version übergeben werden soll. Weitere Informationen finden Sie unter Anforderungen für AMI-Details.

            • AmiSource(Objekt)

              • AmiId(string) — ID für das Quell-AMI, das sich in dem AWS-Region Ort befindet, an dem die API aufgerufen wird (derzeit muss es immer US East (Nord-Virginia) sein, da dies die einzige Region ist, in der die Catalog API verfügbar ist). Muss zum Anruferkonto gehören.

              • AccessRoleArn(string) — Die IAM-Rolle Amazon Resource Name (ARN), die von für den AWS-Region Zugriff auf das bereitgestellte AMI verwendet wird. Einzelheiten zur Erstellung und Verwendung dieses ARN finden Sie im AWS Marketplace Verkäuferleitfaden unter Gewähren des Zugriffs auf Ihr AMI für AWS Marketplace.

              • UserName(string) — Login-Benutzername für den Zugriff auf das Betriebssystem (OS) im AMI. In der Regel ec2-user für Linux-AMIs oder Administrator für Windows.

              • OperatingSystemName(string) — Name des Betriebssystems, das Käufern angezeigt wird.

              • OperatingSystemVersion(string) — Die Zeichenfolge mit der Betriebssystemversion, die Käufern angezeigt wird.

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. Dazu gehörte auch die Überprüfung der Informationen, um sicherzustellen, dass sie den AWS Marketplace Richtlinien entsprechen. Der Validierungsvorgang kann zwischen einigen Minuten und einigen Stunden dauern.

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

Weitere Informationen zu Fehlern in den Produktänderungssätzen von Verkäufern finden Sie unterStatus und Fehler des Sets ändern.

Wenn die Anfrage abgeschlossen ist, wird die Version hinzugefügt, und alle bestehenden Abonnenten erhalten eine E-Mail-Nachricht, in der sie über die neue Version informiert werden. Weitere Informationen zum Hinzufügen einer neuen Version finden Sie im AWS Marketplace Verkäuferleitfaden unter Hinzufügen einer neuen Version.

Asynchrone Fehler

Die folgenden Fehler beziehen sich spezifisch auf AddDeliveryOptions Aktionen in der. AWS Marketplace Catalog API Diese Fehler werden zurückgegeben, wenn Sie DescribeChangeSet nach der Verarbeitung eines Änderungssatzes aufrufen. Weitere Hinweise zur VerwendungDescribeChangeSet, um den Status einer Änderungsanforderung abzurufen, finden Sie unterMit Änderungssätzen arbeiten.

Fehlercode Fehlermeldung
UNGÜLTIGER_AMI_NAME Das Präfix (x) im AMI-Namen ist ungültig. Geben Sie einen neuen Namen ein, wobei Sie Ihren Firmen- oder Markennamen als Präfix verwenden.

UNGÜLTIGES_PRODUKT

Verwenden Sie ein vorhandenes limitiertes oder öffentliches Produkt.

DOPPELTER VERSIONSTITEL

Der Versionstitel muss sich von allen anderen Versionstiteln dieses Produkts unterscheiden.

UNGÜLTIGER_VERSIONSTITEL

Entfernen Sie Leerzeichen vor dem Markensymbol.

UNGÜLTIGER_VERSIONSTITEL

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

UNGÜLTIGER_VERSIONSTITEL

Entfernen Sie Leerzeichen am Anfang des Versionstitels.

UNGÜLTIGER_VERSIONSTITEL

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

UNGÜLTIGE_VERSIONSHINWEIS

Entfernen Sie Leerzeichen vor dem Markensymbol.

UNGÜLTIGE_VERSIONSHINWEIS

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

INVALID_RELEASE_NOTES

Entfernen Sie Leerzeichen am Anfang der Versionshinweise.

UNGÜLTIGE_VERSIONSHINWEIS

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

UNGÜLTIGE_NUTZUNGSANWEISUNGEN

Entfernen Sie Leerzeichen vor dem Markensymbol.

UNGÜLTIGE_NUTZUNGSANWEISUNGEN

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

UNGÜLTIGE_USAGE_INSTRUCTIONS

Entfernen Sie Leerzeichen am Anfang der Versionshinweise.

UNGÜLTIGE_NUTZUNGSANWEISUNGEN

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

EMPFOHLEN_INSTANZTYP_NICHT_VERFÜGBAR

Geben Sie einen vorhandenen, verfügbaren Instanztyp an.

UNGÜLTIGER_EMPFOHLEN_INSTANZTYP

Geben Sie einen gültigen Instanztyp an.

UNGÜLTIGE_SICHERHEITSGRUPPE

Die Ports der Sicherheitsgruppe müssen zwischen 1 und [max] liegen.

UNGÜLTIGE_SICHERHEITSGRUPPE

Geben Sie einen Wert für CIDR-IP-Bereiche an.

UNGÜLTIGE_SICHERHEITSGRUPPE

Geben Sie den Startport der Sicherheitsgruppe an, der nicht größer als der Endport ist.

UNGÜLTIGES SICHERHEITSGRUPPENPROTOKOLL

Das Sicherheitsgruppenprotokoll muss entweder 'tcp' oder 'udp' sein.

UNGÜLTIGE_CIDR_IP

Geben Sie den Standard-CIDR-IP-Bereich in der Form '0.0.0 an. 0/0'.

UNGÜLTIGER_ZUGRIFFSENDPUNKT-PORT

Geben Sie den Endpunkt-Port kleiner als [x] an.

UNGÜLTIGER_ZUGRIFFSENDPUNKT-PORT

Geben Sie einen Endpunkt-Port zwischen 1 und [max] an.

UNGÜLTIGER_ZUGRIFFSENDPUNKT-PORT

Geben Sie den Endpunkt-Port an.

UNGÜLTIGER_ZUGRIFFSENDPUNKT_RELATIVE_PFAD

Entfernen Sie Leerzeichen im relativen Pfad.

UNGÜLTIGER_ZUGRIFFSENDPUNKT_RELATIVE_PFAD

Entfernt das vorangestellte '/' aus dem relativen Pfad.

INKOMPATIBELES_BETRIEBSSYSTEM_

Geben Sie den Namen und die Version des Betriebssystems an, die mit den Instanztypen kompatibel sind: [x]

INKOMPATIBELER_BETRIEBSSYSTEMNAME

Geben Sie einen Namen mit weniger als (x) Zeichen an.

INKOMPATIBELER_BETRIEBSSYSTEMNAME

Geben Sie den Namen des unterstützten Betriebssystems an.

INKOMPATIBELE_BETRIEBSSYSTEMVERSION

Geben Sie eine Version mit weniger als (x) Zeichen an.

UNGÜLTIGER_SCANNING-PORT

Geben Sie den Scan-Port zwischen 1 und [max] an.

UNGÜLTIGE_AMI_ID

Geben Sie eine gültige AMI-ID ein.

VORHANDENER_AMI_PRODUKTCODE

Entfernen Sie den an Bild X angehängten Produktcode.

INVALID_AMI_ARCHITECTURE

Stellen Sie das neue AMI mit der Architektur [x] bereit.

UNGÜLTIGER_AMI_VIRTUALISIERUNGSTYP

Stellen Sie ein neues AMI mit dem Virtualisierungstyp [x] bereit.

UNGÜLTIGER_AMI_VIRTUALISIERUNGSTYP

Geben Sie das erwartete Volumen [z] auf dem Bild [x] an.

INKOMPATIBLE_AMI

Neues AMI bereitstellen, da die Architektur [x] auf [y] von den folgenden Instance-Typen nicht unterstützt wird: [z]

INKOMPATIBLE_AMI

Neues AMI bereitstellen, da der Virtualisierungstyp [x] auf [y] von den folgenden Instance-Typen nicht unterstützt wird: [z]

INKOMPATIBLE_AMI

Aktivieren Sie die ENA-Unterstützung für Image x, da die folgenden Instanztypen ENA-Unterstützung benötigen: [y]

ASSET_NOT_FOUND

Prüfen Sie, ob [ami-id] in der Region us-east-1 von [account-id] existiert AWS-Konto und der AccessARN angegebene [ARN] berechtigt ist, dieses AMI mit anderen zu teilen. AWS Marketplace

ASSET_ACCESS_EXCEPTION

AMI [x] konnte nicht in das Konto kopiert werden. AWS Marketplace

SCAN_ERROR

Behebt die Sicherheitslücke [y] auf Bild [x].

ASSET_NICHT_GEFUNDEN

Überprüfe, ob [afi-id] in der us-east-1 Region von [account-id] existiert AWS-Konto und der AccessARN angegebene [ARN] berechtigt ist, diese AFI mit anderen zu teilen. AWS Marketplace

ASSET_ACCESS_EXCEPTION

Auf AFI kann nicht zugegriffen werden. Prüfen Sie, ob AccessARN provided [ARN] berechtigt ist, dieses AFI mit AWS Marketplace und der Zugriffsrolle zu teilen. Das Konto ist AFI-Besitzer.

FEHLENDER_FPGA_INSTANCE_TYPE

Es wurde kein FPGA-basierter Instanztyp gefunden. Verwenden Sie AddInstanceTypes den Änderungstyp, um einen FPGA-basierten Instanztyp hinzuzufügen.

Sie können ein AMI-based Produkt auch mit dem erstellen AWS Marketplace Management Portal. Weitere Informationen finden Sie im AWS Marketplace Verkäuferleitfaden unter AMI-Produkte.

Eine Anleitung, wie Sie die Aktualisierung Ihres AMI-based Produkts automatisieren können, finden Sie auch im Video Automatisieren von Aktualisierungen Ihrer Produktangebote AWS Marketplace mit der Katalog-API (5:08).

Versionsinformationen aktualisieren

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

Anmerkung

Weitere Informationen zum Aktualisieren von Versionsinformationen mithilfe von finden Sie unter Aktualisieren der AWS Marketplace Management Portal Versionsinformationen im AWS Marketplace Verkäuferhandbuch.

Sie können das AMI für die Version nicht aktualisieren. Wenn Sie das AMI aktualisieren müssen, erstellen Sie stattdessen eine neue Version.

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

Anforderungssyntax

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

Im Folgenden finden Sie Informationen zu den Eingabefeldern, die Sie für das Hinzufügen des UpdateDeliveryOptions Änderungstyps angeben. Weitere Informationen zu diesen Feldern finden Sie im AWS Marketplace Verkäuferhandbuch unter Aktualisieren der Versionsinformationen.

  • Entität (Objekt) (erforderlich) — Ihr AMI-based Produkt.

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

    • Typ (Zeichenfolge) (erforderlich) — Der Type hängt von der Versandart (Produkttyp) ab, die Ihr Produkt verwenden wird:AmiProduct@1.0.

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

    • Version (Objekt) — Details zur Softwareversion.

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

    • DeliveryOptions(Reihe von Objekten) — Liste der Objekte mit Lieferoptionen. Schließen Sie nur die Lieferoptionen ein, die Sie aktualisieren möchten.

      • Geben Sie für die AMI-Lieferoption (Standalone) ein Objekt mit den folgenden Details an. Schließen Sie nur die Felder ein, die Sie aktualisieren möchten. Alle Felder sind optional, sofern nicht anders angegeben.

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

        • Details (Objekt) — Enthält die Details einer AMI-Lieferoption. Beachten Sie, dass für dieses verschachtelte Detailobjekt kein doppeltes Escape-Symbol erforderlich ist.

          • AmiDeliveryOptionDetails(Objekt) — Die Details einer AMI-Lieferoption.

            • UsageInstructions(string) — Anweisungen zur Verwendung des AMI oder ein Link zu weiteren Informationen über das AMI.

            • AccessEndpointUrl(object) — Wird verwendet, um einen Pfad für den Zugriff auf das AMI zu erstellen, nachdem es verwendet wurde.

              • Port (string) — Die Portnummer, die für den Zugriff auf den Dienst verwendet wird, der auf dem AMI ausgeführt wird.

              • Protokoll (Zeichenfolge) — Das Protokoll (httpoderhttps), das für den Zugriff auf den Dienst verwendet wird, der auf dem AMI ausgeführt wird.

              • RelativePath(string) — Der Pfad vom Web-Root zum Zugriff auf den Dienst, der auf dem AMI ausgeführt wird (zum Beispiel/index.html).

            • RecommendedInstanceType(string) — Der Instance-Typ, der für die Ausführung des Dienstes mit dem AMI empfohlen wird und der Standard für 1-Klick-Installationen Ihres Dienstes ist.

            • SecurityGroups(Array von Objekten) — Eine Liste von Objekten, die Eingangsregeln für die automatisch erstellten Gruppen für die Version darstellen:

              • FromPort(integer) — Der Quellport.

              • IpProtocol(string) — Das zu verwendende Protokoll (tcpoderidp).

              • IpRanges(Zeichenkettenarray) — Die zuzulassenden IP-Bereiche im CIDR-Format (in der Form xxx.xxx.xxx. xxx/nn, zum Beispiel). 192.0.2.0/24

              • ToPort(integer) — Der Zielport.

      • Geben Sie für AMI mit CloudFormation Lieferoption ein Objekt mit den folgenden Details an. Schließen Sie nur die Felder ein, die Sie aktualisieren möchten. Alle Felder sind optional, sofern nicht anders angegeben.

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

        • Details (Objekt) — Enthält die Details einer AMI-Lieferoption. Beachten Sie, dass für dieses verschachtelte Detailobjekt kein doppeltes Escape-Symbol erforderlich ist.

          • DeploymentTemplateDeliveryOptionDetails(Objekt) — Wird verwendet, um die Details der einzelnen CFT-Lieferoptionen anzugeben.

            • DeliveryOptionTitle(string) — Titel für die Lieferoption.

            • ShortDescription(string) — Kurze Beschreibung Ihrer CloudFormation Vorlagen-Versandoption.

            • LongDescription(string) — Detaillierte Beschreibung Ihrer Versandoption CloudFormation für Vorlagen.

            • UsageInstructions(string) — Anweisungen zur Verwendung des AMI oder ein Link zu weiteren Informationen über das AMI.

            • RecommendedInstanceType(string) — Der Instance-Typ, der für die Ausführung des Dienstes mit dem AMI empfohlen wird und der Standard für 1-Klick-Installationen Ihres Dienstes ist. Eine Liste der Instance-Typen finden Sie unter Instance-Typen im Amazon Elastic Compute Cloud-Benutzerhandbuch für Linux-Instances.

            • ArchitectureDiagram(string) — URL zum Speicherort Ihres Architekturdiagramms in Amazon S3.

            • Template (string) — URL zum Speicherort Ihrer CloudFormation Vorlage in Amazon S3.

            • TemplateSources(Reihe von Objekten)

              • ParameterName(string) — Name des Parameters in der CloudFormation Vorlage, an den das AMI in dieser Version übergeben werden soll. Weitere Informationen finden Sie unter Anforderungen für AMI-Details.

              • AmiSource(Objekt)

                • AmiId(string) — ID für das Quell-AMI, das sich dort befindet, AWS-Region wo die API aufgerufen wird (derzeit muss es immer US East (Nord-Virginia) sein, da dies die einzige Region ist, in der die Catalog API verfügbar ist). Muss zum Anruferkonto gehören.

                • AccessRoleArn(string) — IAM-Rolle Amazon Resource Name (ARN), die von für den AWS-Region Zugriff auf das bereitgestellte AMI verwendet wird. Einzelheiten zur Erstellung und Verwendung dieses ARN finden Sie im AWS Marketplace Verkäuferleitfaden unter Gewähren des Zugriffs auf Ihr AMI für AWS Marketplace.

                • UserName(string) — Login-Benutzername für den Zugriff auf das Betriebssystem (OS) im AMI. In der Regel ec2-user für Linux-AMIs oder Administrator für Windows.

                • OperatingSystemName(string) — Name des Betriebssystems, das Käufern angezeigt wird.

                • OperatingSystemVersion(string) — Die Zeichenfolge mit der Betriebssystemversion, die Käufern angezeigt wird.

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. Dazu gehörte auch die Überprüfung der Informationen, um sicherzustellen, dass sie den AWS Marketplace Richtlinien entsprechen. Der Validierungsvorgang kann zwischen einigen Minuten und einigen Stunden dauern.

Sie können den Status der Anfrage über die oder direkt über die AWS Marketplace Management Portal Catalog 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 den Produktänderungssätzen von Verkäufern finden Sie unterStatus und Fehler des Sets ändern.

Asynchrone Fehler

Die folgenden Fehler beziehen sich spezifisch auf UpdateDeliveryOptions Aktionen in der. AWS Marketplace Catalog API Diese Fehler werden zurückgegeben, wenn Sie DescribeChangeSet nach der Verarbeitung eines Änderungssatzes aufrufen. Weitere Hinweise zur VerwendungDescribeChangeSet, um den Status einer Änderungsanforderung abzurufen, finden Sie unterMit Änderungssätzen arbeiten.

Sie können UpdatePricingTerms Aktionen abrufen, indem Sie den DescribeChangeSet Vorgang verwenden, nachdem der Änderungssatz mit der Verarbeitung begonnen hat. Weitere Informationen zu Fehlerdetails und zur Problembehandlung finden Sie weiter Status und Fehler des Sets ändern oben in diesem Handbuch.

Fehlercode Fehlermeldung
INVALID_PRODUCT Verwenden Sie ein vorhandenes limitiertes oder öffentliches Produkt.
FEHLEN_LIEFEROPTION_IDS Geben Sie mindestens eine Versandoptions-ID an.
UNGÜLTIGE_LIEFEROPTION_IDS Geben Sie die IDs der Lieferoptionen an, die im Produkt zu finden sind. IDs nicht gefunden: [x]
UNGÜLTIGE_LIEFEROPTIONEN Geben Sie Lieferoptions-IDs an, die zu derselben Version gehören.

Eine Version einschränken

Sie können die Catalog API verwenden, um eine Version Ihres AMI-based Produkts einzuschränken. Dadurch wird verhindert, dass neue Käufer diese Version verwenden, aber bestehende Käufer können sie weiterhin nutzen. Wenn Sie alle Lieferoptionen einer Version einschränken, wird die Version eingeschränkt. Wenn Sie eine oder mehrere, aber nicht alle Lieferoptionen einer Version einschränken, werden nur die Lieferoptionen in dieser Version eingeschränkt. Es muss immer mindestens eine uneingeschränkte Version eines Produkts verfügbar sein, sodass Sie die letzte öffentlich verfügbare Version eines Produkts nicht einschränken können.

Anmerkung

Weitere Informationen zum Einschränken von AMI-Versionen AWS Marketplace über den finden Sie im AWS Marketplace Management Portal Verkäuferhandbuch unter Beschränken einer Version. AWS Marketplace

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

Anmerkung

Alle Abonnenten können die aktuelle Version unabhängig vom Einschränkungsstatus verwenden. AWS Marketplace Gemäß den Richtlinien müssen Sie bestehenden Käufern auch nach der Einschränkung der Version noch 90 Tage lang Support anbieten. Ihr AMI wird als veraltet markiert, nachdem die Version eingeschränkt wurde. Weitere Informationen finden Sie unter Ablehnen eines AMI im Amazon Elastic Compute Cloud-Benutzerhandbuch für Instances. Windows

Anforderungssyntax

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

Im Folgenden finden Sie Informationen zu den Eingabefeldern, die Sie für das Hinzufügen des RestrictDeliveryOptions Änderungstyps angeben:

  • Entität (Objekt) (erforderlich) — Ihr AMI-based Produkt.

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

    • Typ (Zeichenfolge) (erforderlich) — Der Type hängt von der Versandart (Produkttyp) ab, die Ihr Produkt verwenden wird:AmiProduct@1.0.

  • DetailsDocument(Objekt) (erforderlich) — Einzelheiten der Anfrage. Es enthält IDs für die Versionen Ihres AMI-based Produkts, die Sie einschränken möchten.

    • DeliveryOptionIds(Array von Objekten) — Liste der DeliveryOption IDs für die Versionen, die Sie einschränken möchten. Sie können den eindeutigen Bezeichner für abrufen, DeliveryOption indem Sie die DescribeEntity Aktion für die Version aufrufen, die Sie einschränken.

Antwortsyntax

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. Dazu gehörte auch die Überprüfung der Informationen, um sicherzustellen, dass sie den AWS Marketplace Richtlinien entsprechen. Der Validierungsvorgang kann zwischen einigen Minuten und einigen Stunden dauern.

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

Asynchrone Fehler

Die folgenden Fehler beziehen sich spezifisch auf RestrictDeliveryOptions Aktionen in der. AWS Marketplace Catalog API Diese Fehler werden zurückgegeben, wenn Sie DescribeChangeSet nach der Verarbeitung eines Änderungssatzes aufrufen. Weitere Hinweise zur VerwendungDescribeChangeSet, um den Status einer Änderungsanforderung abzurufen, finden Sie unterMit Änderungssätzen arbeiten.

Fehlercode Fehlermeldung

UNGÜLTIGES PRODUKT

Verwenden Sie ein vorhandenes öffentliches Produkt.

FEHLEN_LIEFEROPTION_IDS

Geben Sie mindestens eine Versandoptions-ID an.

UNGÜLTIGE_LIEFEROPTION_IDS

Geben Sie die IDs der Lieferoptionen an, die im Produkt zu finden sind. IDs nicht gefunden: [x]

UNGÜLTIGE LIEFEROPTION

Geben Sie IDs für Lieferoptionen an, die öffentlich sind. IDs nicht im öffentlichen Zustand: [x]

ALL_DELIVERY_OPTIONS_RESTRICTED

Geben Sie weniger Zustellungsoptionen an, um diese einzuschränken, da mindestens eine Option im öffentlichen Zustand bleiben muss.

Zukunft aktualisieren AWS-Region Support

Sie können die Catalog API verwenden, um zukünftige AWS-Region Support-Einstellungen für Ihr AMI-based Produkt in zu ändern AWS Marketplace.

Anmerkung

Weitere Informationen zur Änderung des AWS Marketplace Management Portal zukünftigen Regionssupports mithilfe von finden Sie im AWS Marketplace Verkäuferleitfaden unter Support für zukünftige AWS-Regionen aktualisieren.

Anmerkung

Der UpdateFutureRegionSupport Änderungstyp ist nur am verfügbarAmiProduct@1.0.

Um zukünftige AWS-Region Support-Einstellungen zu ändern, rufen Sie den StartChangeSet API-Vorgang mit dem UpdateFutureRegionSupport Änderungstyp auf, wie im folgenden Beispiel gezeigt.

Anforderungssyntax

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

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

  • Entity(Objekt) (erforderlich) — Ihr AMI-based Produkt.

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

    • Type(string) (erforderlich) — Type Das hängt von der Versandart (Produkttyp) ab, die Ihr Produkt verwenden wird:AmiProduct@1.0.

  • DetailsDocument(Objekt) (erforderlich) — Die Details, die zur Ausführung des erforderlich sind ChangeSet.

    • FutureRegionSupport— Objekt

      • SupportedRegions— Single-element Reihe von Zeichenketten

        Unterstützte Werte für Elemente: einer von ["All","US","None"]

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. Dazu gehörte auch die Überprüfung der Informationen, um sicherzustellen, dass sie den AWS Marketplace Richtlinien entsprechen. Der Validierungsvorgang kann zwischen einigen Minuten und einigen Stunden dauern.

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

Asynchrone Fehler

Die folgenden Fehler beziehen sich spezifisch auf UpdateFutureRegionSupport Aktionen in der. AWS Marketplace Catalog API Diese Fehler werden zurückgegeben, wenn Sie DescribeChangeSet nach der Verarbeitung eines Änderungssatzes aufrufen. Weitere Hinweise zur VerwendungDescribeChangeSet, um den Status einer Änderungsanforderung abzurufen, finden Sie unterMit Änderungssätzen arbeiten.

Fehlercode Fehlermeldung
ZU VIELE_REGIONEN Derzeit wird nur ein Wert unterstützt für FutureRegionSupport: All, US oder None
INVALID_REGIONS Die angeforderten Regionen [a, b, c] sind ungültig oder nicht verfügbar. Nur unterstützte Werte sind [x, y, z].
UNGÜLTIGE_EINGABE SupportedRegions darf nicht leer sein.

Fügen Sie eine unterstützte hinzu AWS-Region

Sie können die Catalog API verwenden, um neue, AWS-Regionen für Ihr AMI-based Produkt unterstützte Produkte hinzuzufügen AWS Marketplace.

Anmerkung

Weitere Informationen zum Hinzufügen neuer unterstützter Regionen mithilfe von finden Sie unter Hinzufügen einer AWS-Region im AWS Marketplace Verkäuferleitfaden. AWS Marketplace Management Portal

Anmerkung

Der AddRegions Änderungstyp ist nur am verfügbarAmiProduct@1.0.

Um neue unterstützte Regionen hinzuzufügen, rufen Sie den StartChangeSet API-Vorgang mit dem AddRegions Änderungstyp auf, wie im folgenden Beispiel gezeigt.

Anforderungssyntax

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

Geben Sie Informationen für die Felder ein, um den AddRegions Änderungstyp hinzuzufügen.

  • Entity(Objekt) (erforderlich) — Ihr AMI-based Produkt.

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

    • Type(string) (erforderlich) — Type Das hängt von der Versandart (Produkttyp) ab, die Ihr Produkt verwenden wird:AmiProduct@1.0.

  • Beispiel
    DetailsDocument (object) (required) – The details required to execute the ChangeSet.
    • Regions: Zeichenfolgen-Array

      Unterstützte Werte für Elemente: Gültige AWS-Region Codezeichenfolgen.

      Zum Beispiel ["us-east- 1"].

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. Dazu gehörte auch die Überprüfung der Informationen, um sicherzustellen, dass sie den AWS Marketplace Richtlinien entsprechen. Der Validierungsvorgang kann zwischen einigen Minuten und einigen Stunden dauern.

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

  • Wenn der Ausführungsstatus des Änderungssatzes lautetSUCCEEDED: Eine neue Entität Identifier (oderEntityId) wird generiert. Sie können den DescribeEntity API-Vorgang für die Produktentität verwenden, um das Ergebnis zu überprüfen.

  • Wenn der Ausführungsstatus des Änderungssatzes lautetCLIENT_ERROR: Die DescribeChangeSet Antwort enthält die Details des Fehlers sowie die entsprechenden Maßnahmen, die zur Behebung des Fehlers ergriffen werden müssen.

Asynchrone Fehler

Die folgenden Fehler beziehen sich spezifisch auf AddRegions Aktionen in der. AWS Marketplace Catalog API Diese Fehler werden zurückgegeben, wenn Sie DescribeChangeSet nach der Verarbeitung eines Änderungssatzes aufrufen. Weitere Hinweise zur VerwendungDescribeChangeSet, um den Status einer Änderungsanforderung abzurufen, finden Sie unterMit Änderungssätzen arbeiten.

Fehlercode Fehlermeldung
INVALID_REGIONS Die angeforderten Regionen [a, b, c] sind ungültig oder nicht verfügbar. Nur unterstützte Werte sind [x, y, z].
UNGÜLTIGE_EINGABE Regionen dürfen nicht leer sein.

Beschränken Sie eine AWS-Region

Sie können die Catalog API verwenden, um die zuvor AWS-Regionen für Ihr AMI-based Produkt unterstützten Optionen einzuschränken AWS Marketplace.

Anmerkung

Weitere Informationen zum Einschränken zuvor unterstützter Regionen mithilfe von finden Sie im AWS Marketplace Verkäuferleitfaden unter Eine AWS-Region einschränken. AWS Marketplace Management Portal

Anmerkung

Der RestrictRegions Änderungstyp ist nur am AmiProduct@1.0 verfügbar.

Um zuvor unterstützte Regionen einzuschränken, rufen Sie den StartChangeSet API-Vorgang mit dem RestrictRegions Änderungstyp auf, wie im folgenden Beispiel gezeigt.

Anforderungssyntax

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

Geben Sie Informationen für die Felder ein, um den AddRegions Änderungstyp hinzuzufügen.

  • Entity(Objekt) (erforderlich) — Ihr AMI-based Produkt.

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

    • Type(string) (erforderlich) — Type Das hängt von der Versandart (Produkttyp) ab, die Ihr Produkt verwenden wird:AmiProduct@1.0.

  • DetailsDocument(Objekt) (erforderlich) — Die Details, die zur Ausführung des erforderlich sind ChangeSet.

    • Regions— Reihe von Zeichenketten

      Unterstützte Werte für Elemente: Gültige AWS-Region Codezeichenfolgen, z. "us-east-1" B.

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. Dazu gehörte auch die Überprüfung der Informationen, um sicherzustellen, dass sie den AWS Marketplace Richtlinien entsprechen. Der Validierungsvorgang kann zwischen einigen Minuten und einigen Stunden dauern.

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

  • Wenn der Ausführungsstatus des Änderungssatzes SUCCEEDED — lautet, wird eine neue Entität Identifier (oderEntityId) generiert. Sie können es für DescribeEntity die Produkt-Entity verwenden, um das Ergebnis zu überprüfen. Weitere Informationen finden Sie unter DescribeEntity.

  • Wenn der Ausführungsstatus des Änderungssatzes lautetCLIENT_ERROR: Die DescribeChangeSet Antwort enthält die Details des Fehlers sowie die entsprechenden Maßnahmen zur Behebung des Fehlers.

Asynchrone Fehler

Die folgenden Fehler beziehen sich spezifisch auf AddRegions Aktionen in der. AWS Marketplace Catalog API Diese Fehler werden zurückgegeben, wenn Sie DescribeChangeSet nach der Verarbeitung eines Änderungssatzes aufrufen. Weitere Hinweise zur VerwendungDescribeChangeSet, um den Status einer Änderungsanforderung abzurufen, finden Sie unterMit Änderungssätzen arbeiten.

Fehlercode Fehlermeldung
INVALID_REGIONS Die angeforderten Regionen [a, b, c] sind ungültig oder nicht verfügbar. Nur unterstützte Werte sind [x, y, z].
UNGÜLTIGE_EINGABE Regionen dürfen nicht leer sein.

Neuen Instanztyp hinzufügen

Sie können die Catalog API verwenden, um neue Instanztypen für Ihr AMI-based Produkt hinzuzufügen AWS Marketplace.

Anmerkung

Weitere Informationen zum Hinzufügen von Instanztypen mithilfe von finden Sie im AWS Marketplace Verkäuferleitfaden unter Instanz hinzufügen. AWS Marketplace Management Portal

AddInstanceTypesfügt bei der Erstellung eines Produkts neue Instanztypen zu bestehenden Produkten und neu erstellten Produkten hinzu. Durch den Änderungstyp werden alle Versionen im Produktdokument mit einem neuen Instanztyp aktualisiert.

Anmerkung

Der AddInstanceTypes Änderungstyp ist nur am verfügbarAmiProduct@1.0.

Beim Hinzufügen eines eingeschränkten Instanztyps kann der Instanztyp aus der eingeschränkten Liste entfernt und der Liste der verfügbaren Instanztypen hinzugefügt werden. Dadurch haben Verkäufer mehr Kontrolle darüber, wie sie ihre Produkteinschränkungen ändern können. Die Liste der Instanztypen ist austauschbar und stellt keinen permanenten eingeschränkten Status für ein Produkt dar.

Bei Produkten mit interner Abrechnung müssen Verkäufer separate Änderungsarten aufrufen AddDimensions und UpdatePricingTerms die Preise für den Instance-Typ aktualisieren.

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

Anforderungssyntax

Unten wird nur der AddInstanceTypes Änderungstyp angezeigt. Obwohl das AMI intern abgerechnet wird, müssen Verkäufer anrufen AddInstanceTypes und den Typ für ihr AMI UpdatePricingTerms ändern.

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

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

  • Entity(Objekt) (erforderlich) — Ihr AMI-based Produkt.

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

    • Type(string) (erforderlich) — Type Das hängt von der Versandart (Produkttyp) ab, die Ihr Produkt verwenden wird:AmiProduct@1.0.

  • DetailsDocument(Objekt) (erforderlich) — Die AngabenChangeSet, die in diesem Fall zur Ausführung des erforderlich sindInstanceTypes.

    • InstanceTypes(Zeichenkettenarray) (erforderlich) — Liste der ElementeInstanceTypes, die dem Produkt hinzugefügt werden sollen. Diese Instanzen werden zu den vorhandenen hinzugefügtInstanceTypes.

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. Dazu gehörte auch die Überprüfung der Informationen, um sicherzustellen, dass sie den AWS Marketplace Richtlinien entsprechen. Der Validierungsvorgang kann zwischen einigen Minuten und einigen Stunden dauern.

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

Synchrone Validierungen

Die folgenden Schemavalidierungen sind spezifisch für Aktionen in der. AddInstanceTypes AWS Marketplace Catalog API Diese Validierungen werden durchgeführt, wenn Sie anrufen. StartChangeSet Wenn die Anfrage die folgenden Anforderungen nicht erfüllt, schlägt sie mit einer HTTP-Antwort fehl.

Eingabefeld Validierungsregel HTTP
InstanceTypes Erforderlich 422
InstanceTypes Darf nicht leer sein 422
InstanceTypes Die Einträge müssen zwischen 1 und 24 Zeichen lang sein. Muss mit ^ [A-Za-z0-9_.-] +$ übereinstimmen 422
InstanceTypes Die Einträge müssen eindeutig sein 422
InstanceTypes Darf nicht mehr als 1500 Einträge enthalten 422
Eine unbekannte Eigenschaft Es sind keine zusätzlichen Eigenschaften zulässig 422

Asynchrone Fehler

Die folgenden Fehler beziehen sich spezifisch auf AddInstanceTypes Aktionen in der. AWS Marketplace Catalog API Diese Fehler werden zurückgegeben, wenn Sie DescribeChangeSet nach der Verarbeitung eines Änderungssatzes aufrufen. Weitere Hinweise zur VerwendungDescribeChangeSet, um den Status einer Änderungsanforderung abzurufen, finden Sie unterMit Änderungssätzen arbeiten.

Fehlercode Fehlermeldung
INVALID_INSTANCE_TYPES Die folgenden Instanztypen sind nicht gültig: [x]
INVALID_INSTANCE_VIRTUALIZATION Die Virtualisierung des Produkts ist [x]. Es wird von den folgenden Instance-Typen nicht unterstützt: [x]
INVALID_AMI_ARCHITECTURE Die CPU-Architektur des Produkts ist '%s'.“ + „Es wird von den folgenden Instanztypen nicht unterstützt: [x]
INKOMPATIBLE_BETRIEBSSYSTEM Die Instanztypen sind nicht mit dem im Produkt definierten Betriebssystem kompatibel. Stellen Sie Instanztypen bereit, die mit dem im Produkt definierten Betriebssystem kompatibel sind.
UNGÜLTIGER_PRODUKTTYP Verwenden Sie ein vorhandenes einzelnes AMI-Produkt.
INVALID_ENA_SETTING Das Produkt unterstützt ENA nicht. ENA-Unterstützung ist für die folgenden Instance-Typen erforderlich: [x]
INVALID_DIMENSIONS Keine intern gemessenen Dimensionen für Instanztypen gefunden: [x]
FEHLEN_DIMENSIONEN Für das Produkt wurden keine Abmessungen gefunden. AddDimensions ist vorher erforderlich AddInstanceTypes.
UPDATE_PRICING_REQUIRED UpdatePricingTerms Der Änderungstyp ist erforderlich, wenn für das Produkt intern gemessene Abmessungen verfügbar sind.

Einen Instanztyp einschränken

Sie können die Catalog API verwenden, um die für Ihr AMI-based Produkt verfügbaren Instanztypen einzuschränken oder einzuschränken AWS Marketplace.

Anmerkung

Weitere Informationen zum Einschränken oder Einschränken der verfügbaren Instanztypen mithilfe von finden Sie im AWS Marketplace Verkäuferleitfaden unter Eine Instanz einschränken. AWS Marketplace Management Portal

Bestehende Abonnenten sind von dieser Änderung nicht betroffen und können die eingeschränkten Instanztypen verwenden. Allerdings werden keine neuen Käufer in der Lage sein, eingeschränkte Instance-Typen zu verwenden. Um Abonnements für aktuelle Instanztypen zu beenden (sobald die Instanztypen eingeschränkt sind), müssen Sie sich an das AWS Marketplace Seller Operations Team wenden.

RestrictInstanctTypesschränkt die Instanztypen auf alle Versionen im Produktdokument ein. Beim AddInstanceTypes Änderungstyp aktualisieren Sie alle Versionen des Produkts. Sie werden die empfohlenen Instanztypen nicht einschränken können. Der empfohlene Instanztyp ist auf Versionsebene, daher ist es möglich, dass der Verkäufer nicht in der Lage ist, mehrere Instanztypen einzuschränken.

Bei einem Produkt, das intern berechnet wird, musst du beim Anruf separate Änderungstypen aufrufenRestrictDimensions. Dadurch wird verhindert, dass neue Angebote für die eingeschränkten Instanztypen erstellt werden.

Anmerkung

Der RestrictInstanceTypes Änderungstyp ist nur am verfügbarAmiProduct@1.0.

Um die für Ihr AMI-based Produkt verfügbaren Instanztypen einzuschränken oder einzuschränken, rufen Sie den StartChangeSet API-Vorgang mit dem RestrictInstanceTypes Änderungstyp auf, wie im folgenden Beispiel gezeigt.

Anforderungssyntax

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

Geben Sie Informationen für die Felder ein, um den RestrictInstanceTypes Änderungstyp hinzuzufügen.

  • Entity(Objekt) (erforderlich) — Ihr AMI-based Produkt.

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

    • Type(string) (erforderlich) — Type Das hängt von der Versandart (Produkttyp) ab, die Ihr Produkt verwenden wird:AmiProduct@1.0.

  • DetailsDocument(Objekt) (erforderlich) — Die AngabenChangeSet, die in diesem Fall zur Ausführung des erforderlich sindInstanceTypes.

    • InstanceTypes(Zeichenkettenarray) (erforderlich) — Liste der Elemente, die InstanceTypes auf das Produkt beschränkt werden sollen. Diese Instanzen werden zu den aktuellen Instanztypen hinzugefügt (oder, falls es keine vorhandenen Instanztypen gibt, werden sie hinzugefügt) bis eingeschränktInstanceTypes.

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. Dazu gehörte auch die Überprüfung der Informationen, um sicherzustellen, dass sie den AWS Marketplace Richtlinien entsprechen. Der Validierungsvorgang kann zwischen einigen Minuten und einigen Stunden dauern.

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

Synchrone Validierungen

Die folgenden Schemavalidierungen sind spezifisch für Aktionen in der. RestrictInstanceTypes AWS Marketplace Catalog API Diese Validierungen werden durchgeführt, wenn Sie anrufen. StartChangeSet Wenn die Anfrage die folgenden Anforderungen nicht erfüllt, schlägt sie mit einer HTTP-Antwort fehl.

Eingabefeld Validierungsregel HTTP
InstanceTypes Erforderlich 422
InstanceTypes Darf nicht leer sein 422
InstanceTypes Die Einträge müssen zwischen 1 und 24 Zeichen lang sein. Muss mit ^ [A-Za-z0-9_.-] +$ übereinstimmen 422
InstanceTypes Die Einträge müssen eindeutig sein 422
InstanceTypes Darf nicht mehr als 1500 Einträge enthalten 422
Eine unbekannte Eigenschaft Es sind keine zusätzlichen Eigenschaften zulässig 422

Asynchrone Fehler

Die folgenden Fehler beziehen sich spezifisch auf RestrictInstanceTypes Aktionen in der. AWS Marketplace Catalog API Diese Fehler werden zurückgegeben, wenn Sie DescribeChangeSet nach der Verarbeitung eines Änderungssatzes aufrufen. Weitere Hinweise zur VerwendungDescribeChangeSet, um den Status einer Änderungsanforderung abzurufen, finden Sie unterMit Änderungssätzen arbeiten.

Fehlercode Fehlermeldung
UNGÜLTIGE_ INSTANZTYPEN Die folgenden Instanztypen sind nicht gültig: [x]
UNGÜLTIGER_ PRODUKTTYP Verwenden Sie ein vorhandenes einzelnes AMI-Produkt.
DOPPELTER INSTANZTYP Stellen Sie Instanztypen ohne Duplikate bereit.
UNVERFÜGBARE_INSTANCE_TYPE Geben Sie einen verfügbaren Instanztyp an.
EMPFOHLEN_INSTANZTYP_EINGESCHRÄNKT Die folgenden Instanztypen können nicht eingeschränkt werden. Der empfohlene Instanztyp muss in einen anderen geändert werden, bevor er eingeschränkt wird. Versandoptionen-ID [X] Instanztyp [X]
DIMENSIONS_NOT_RESTRICTED Beschränken Sie die Dimensionen, bevor Sie die intern gemessenen Instanztypen einschränken: [x]
REGION_NO_INSTANCES Ihre eingeschränkten Instance-Typen würden in Region: X zum Scheitern der Produkteinführung führen. Erwägen Sie, weniger Instances einzuschränken.
INKOMPATIBELE_BESCHRÄNKUNG Ihre eingeschränkten Instanztypen würden dazu führen, dass das Produkt keine FPGA-basierten Instanztypen für AFIs hat. Das Produkt muss mindestens einen FPGA-basierten Instanztyp unterstützen.