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.
Arbeite mit AMI-based Produkten
Sie können das verwenden AWS Marketplace Catalog API , um Aufgaben für die Arbeit mit Amazon Machine Image (AMI) -basierten 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 Katalog-API verwenden, um Aktionen an Ihren AMI-based Produkten durchzuführen:
Topics
Eine neue Version hinzufügen
Sie können die Katalog-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äuferleitfaden. AWS Marketplace Management Portal
Wenn Sie eine Anfrage erstellen, die das Hinzufügen eines neuen AMI zu AWS Marketplace beinhaltet, muss das AMI in das AWS Marketplace 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 zur Ausführung von Aktionen auf Ihrem AMI erstellen. Weitere Informationen zu den erforderlichen Berechtigungen finden Sie im AWS Marketplace Verkäuferleitfaden unter Gewähren von AWS Marktplace-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 Intent.
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 haben. 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 Pflichtfelder, sofern nicht anders angegeben. Weitere Informationen zu diesen Feldern finden Sie im AWS Marketplace Verkäuferleitfaden unter Hinzufügen einer neuen Version.
-
DeliveryOptions(Anordnung von Objekten) — Eine Liste von Objekten mit Lieferoptionen, einschließlich der jeweiligen Details. 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 Versandoption haben.
-
Details (Objekt) — Enthält die Details dieser Lieferoption. Beachten Sie, dass dieses verschachtelte Detailobjekt nicht doppelt maskiert werden muss.
-
AmiDeliveryOptionDetails(Objekt) — Wird verwendet, um die Details der einzelnen AMI-Lieferoptionen bereitzustellen.
-
AmiSource(object) — Details zum AMI, das für die hinzugefügte Version verwendet werden soll.
-
AmiId(string) — ID für das Quell-AMI, das sich dort befindet, AWS-Region wo die API aufgerufen wird. Dies muss immer US East (Nord-Virginia) sein, da dies die einzige Region ist, in der die Katalog-API verfügbar ist. Muss zum Anruferkonto gehören.
-
AccessRoleArn(string) — 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(Ganzzahl) — SSH- oder RDP-Port, der für den Zugriff auf das Betriebssystem verwendet wird. Wird verwendet, um das bereitgestellte AMI auf Sicherheitslücken zu scannen. Die Standardeinstellung ist 22.
-
OperatingSystemName(string) — Name des Betriebssystems, der Käufern angezeigt wird.
-
OperatingSystemVersion(string) — Die Zeichenfolge für die 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. Sofern bereitgestellt, 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(object) (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.
-
Protocol (string) — 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 für den 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(Array 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 Bereitstellungsoptionen dieses Typs verwenden.
-
DeliveryOptionTitle(string) — Titel der Lieferoption.
-
Details (Objekt) — Enthält die Details einer AMI-Lieferoption. Beachten Sie, dass dieses verschachtelte Detailobjekt nicht doppelt maskiert werden muss.
-
DeploymentTemplateDeliveryOptionDetails(Objekt) — Wird verwendet, um die Details der einzelnen CFT-Lieferoptionen bereitzustellen.
-
ShortDescription(string) — Kurze Beschreibung Ihrer CloudFormation Vorlagenlieferoption.
-
LongDescription(string) — Detaillierte Beschreibung Ihrer Lieferoption 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.
-
Vorlage (Zeichenfolge) — 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 Katalog-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. Typischerweise
ec2-userfür Linux-AMIs oderAdministratorfür Windows. -
OperatingSystemName(string) — Name des Betriebssystems, der Käufern angezeigt wird.
-
OperatingSystemVersion(string) — Die Zeichenfolge für die 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. Dies beinhaltete die Überprüfung der Informationen, um sicherzustellen, dass sie den AWS Marketplace Richtlinien entsprechen. Der Validierungsprozess 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 Produktänderungssets 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. 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 |
|---|---|
| UNGÜLTIGER_AMI_NAME | Das Präfix (x) im AMI-Namen ist ungültig. Geben Sie einen neuen Namen mit Ihrem Firmen- oder Markennamen als Präfix ein. |
|
UNGÜLTIGER_PRODUKT |
Verwenden Sie ein vorhandenes limitiertes oder öffentliches Produkt. |
|
DUPLIZIERTE_VERSION_TITLE |
Der Versionstitel muss sich von allen anderen Versionstiteln dieses Produkts unterscheiden. |
|
INVALID_VERSION_TITLE |
Entfernen Sie Leerzeichen vor dem Markensymbol. |
|
UNGÜLTIGE_VERSIONSTITEL |
Nicht unterstützte Zeichen entfernen: [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. |
|
INVALID_RELEASE_NOTES |
Entfernen Sie Leerzeichen vor dem Markensymbol. |
|
INVALID_RELEASE_NOTES |
Nicht unterstützte Zeichen entfernen: [x, y, z] |
|
UNGÜLTIGE_VERÖFFENTLICHUNGSHINWEISE |
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 |
Entfernen Sie Leerzeichen am Anfang der Versionshinweise. |
|
UNGÜLTIGE VERWENDUNGSHINWEISE |
Geben Sie Nutzungsanweisungen mit weniger als (x) Zeichen an. |
|
RECOMMENDED_INSTANCE_TYPE_NOT_AVAILABLE |
Geben Sie einen vorhandenen, verfügbaren Instanztyp an. |
|
INVALID_RECOMMENDED_INSTANCE_TYPE |
Geben Sie einen gültigen Instanztyp an. |
|
INVALID_SECURITY_GROUP |
Die Ports der Sicherheitsgruppe müssen zwischen 1 und [max] liegen. |
|
INVALID_SECURITY_GROUP |
Geben Sie einen Wert für CIDR-IP-Bereiche an. |
|
INVALID_SECURITY_GROUP |
Geben Sie den Startport der Sicherheitsgruppe an, der nicht größer als der Endport ist. |
|
INVALID_SECURITY_GROUP_PROTOCOL |
Das Sicherheitsgruppenprotokoll muss entweder 'tcp' oder 'udp' sein. |
|
INVALID_CIDR_IP |
Geben Sie den Standard-CIDR-IP-Bereich in der Form '0.0.0 an. 0/0'. |
|
UNGÜLTIGER_ACCESS_ENDPOINT_PORT |
Geben Sie einen Endpunkt-Port mit weniger als [x] an. |
|
INVALID_ACCESS_ENDPOINT_PORT |
Geben Sie den Endpunkt-Port zwischen 1 und [max] an. |
|
INVALID_ACCESS_ENDPOINT_PORT |
Geben Sie den Endpunkt-Port an. |
|
INVALID_ACCESS_ENDPOINT_RELATIVE_PATH |
Entfernen Sie Leerzeichen im relativen Pfad. |
|
INVALID_ACCESS_ENDPOINT_RELATIVE_PATH |
Entfernt das vorangegangene '/' aus dem relativen Pfad. |
|
INKOMPATIBLE_BETRIEBSSYSTEM_ |
Geben Sie den Namen und die Version des Betriebssystems an, die mit den Instanztypen kompatibel sind: [x] |
|
INKOMPATIBLE_OPERATING_SYSTEM_NAME |
Geben Sie einen Namen mit weniger als (x) Zeichen an. |
|
INKOMPATIBLE_OPERATING_SYSTEM_NAME |
Geben Sie den Namen des unterstützten Betriebssystems an. |
|
INKOMPATIBLE_OPERATING_SYSTEM_VERSION |
Geben Sie eine Version mit weniger als (x) Zeichen an. |
|
UNGÜLTIGER_SCANNING_PORT |
Geben Sie einen Scanport zwischen 1 und [max] an. |
|
UNGÜLTIGE_AMI_ID |
Geben Sie eine gültige AMI-ID an. |
|
EXISTING_AMI_PRODUCT_CODE |
Entfernen Sie den an Bild X angehängten Produktcode. |
|
INVALID_AMI_ARCHITECTURE |
Stellen Sie ein neues 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 [z] Volumen für Bild [x] an. |
|
INKOMPATIBLE_AMI |
Stellen Sie ein neues AMI bereit, da die Architektur [x] auf [y] von den folgenden Instance-Typen nicht unterstützt wird: [z] |
|
INCOMPATIBLE_AMI |
Neues AMI bereitstellen, da der Virtualisierungstyp [x] auf [y] von den folgenden Instance-Typen nicht unterstützt wird: [z] |
|
INCOMPATIBLE_AMI |
Aktivieren Sie die ENA-Unterstützung für Image x, da für die folgenden Instance-Typen ENA-Unterstützung erforderlich ist: [y] |
|
ASSET_NOT_FOUND |
Prüfen Sie, ob [ami-id] in der Region us-east-1 von [Account-ID] existiert AWS-Konto und der |
|
ASSET_ACCESS_EXCEPTION |
AMI [x] konnte nicht in das AWS Marketplace
Konto kopiert werden. |
|
SCAN_ERROR |
Sicherheitslücke [y] auf Bild [x] behoben. |
|
ASSET_NOT_FOUND |
Prüfen Sie, ob [afi-id] in der Region us-east-1 von [Account-ID] existiert AWS-Konto und der |
|
ASSET_ACCESS_EXCEPTION |
Auf AFI kann nicht zugegriffen werden. Prüfen Sie, ob AccessARN provided [ARN] berechtigt ist, dieses AFI mit AWS Marketplace der Zugriffsrolle zu teilen. Das Konto ist AFI-Besitzer. |
|
MISSING_FPGA_INSTANCE_TYPE |
Es wurde kein FPGA-basierter Instanztyp gefunden. Verwenden Sie AddInstanceTypes Change Type, um einen FPGA-basierten Instance-Typ hinzuzufügen. |
Sie können ein AMI-based Produkt auch mit dem AWS Marketplace Management Portal erstellen. Weitere Informationen finden Sie unter AMI-Produkte im AWS Marketplace Verkäuferleitfaden.
Eine Anleitung zur automatischen Aktualisierung Ihres AMI-based Produkts finden Sie auch im Video Automatisieren von Aktualisierungen Ihrer Produktangebote AWS Marketplace mit der Katalog-API
Versionsinformationen aktualisieren
Sie können die Katalog-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 von Versionsinformationen im AWS Marketplace Verkäuferleitfaden. AWS Marketplace Management Portal
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 den StartChangeSet API-Vorgang 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äuferleitfaden unter Versionsinformationen aktualisieren.
-
Entität (Objekt) (erforderlich) — Ihr AMI-based Produkt.
-
Kennung (Zeichenfolge) (erforderlich) — Ihre Produkt-ID. Weitere Informationen finden Sie unter Kennung.
-
Typ (Zeichenfolge) (erforderlich) — Das
Typebasiert auf der Versandmethode (Produkttyp), 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, aber Sie müssen mindestens ein Feld angeben, um sie zu aktualisieren.
-
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 (Zeichenfolge) (erforderlich) — Eindeutige Kennung für die Lieferoption (Sie können die eindeutige Kennung für die Lieferoption abrufen, indem Sie die
DescribeEntityAktion für das Produkt aufrufen, das Sie aktualisieren). -
Details (Objekt) — Enthält die Details einer AMI-Lieferoption. Beachten Sie, dass dieses verschachtelte Detailobjekt nicht doppelt maskiert werden muss.
-
AmiDeliveryOptionDetails(Objekt) — Die Details einer AMI-Lieferoption.
-
UsageInstructions(string) — Anweisungen zur Verwendung des AMI oder ein Link zu weiteren Informationen über das AMI.
-
AccessEndpointUrl(Objekt) — 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.
-
Protocol (string) — 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) — Zulässige 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 (Zeichenfolge) (erforderlich) — Eindeutige Kennung für die Lieferoption (Sie können die eindeutige Kennung für die Lieferoption abrufen, indem Sie die
DescribeEntityAktion für das Produkt aufrufen, das Sie aktualisieren). -
Details (Objekt) — Enthält die Details einer AMI-Lieferoption. Beachten Sie, dass dieses verschachtelte Detailobjekt nicht doppelt maskiert werden muss.
-
DeploymentTemplateDeliveryOptionDetails(Objekt) — Wird verwendet, um die Details der einzelnen CFT-Lieferoptionen bereitzustellen.
-
DeliveryOptionTitle(string) — Titel der Lieferoption.
-
ShortDescription(string) — Kurze Beschreibung Ihrer Lieferoption CloudFormation für Vorlagen.
-
LongDescription(string) — Detaillierte Beschreibung Ihrer Lieferoption 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.
-
Vorlage (Zeichenfolge) — 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 Katalog-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. Typischerweise
ec2-userfür Linux-AMIs oderAdministratorfür Windows. -
OperatingSystemName(string) — Name des Betriebssystems, der Käufern angezeigt wird.
-
OperatingSystemVersion(string) — Die Zeichenfolge für die 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. Dies beinhaltete die Überprüfung der Informationen, um sicherzustellen, dass sie den AWS Marketplace Richtlinien entsprechen. Der Validierungsprozess 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 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.
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 Problembehebung 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. |
| MISSING_DELIVERY_OPTION_IDS | Geben Sie mindestens eine Lieferoption-ID an. |
| INVALID_DELIVERY_OPTION_IDS | Geben Sie die IDs der Lieferoptionen an, die im Produkt zu finden sind. IDs wurden nicht gefunden: [x] |
| INVALID_DELIVERY_OPTIONS | Geben Sie Lieferoption-IDs an, die zu derselben Version gehören. |
Beschränken Sie eine Version
Sie können die Katalog-API verwenden, um eine Version Ihres AMI-based Produkts einzuschränken. Dadurch wird verhindert, dass neue Käufer diese Version verwenden, sie steht aber bestehenden Käufern weiterhin zur Verfügung. 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. Sie müssen immer mindestens eine uneingeschränkte Version eines Produkts verfügbar haben, sodass Sie die letzte öffentlich verfügbare Version eines Produkts nicht einschränken können.
Anmerkung
Weitere Informationen zur Beschränkung von AMI-Versionen in AWS Marketplace via finden Sie unter Eine Version einschränken im AWS Marketplace Verkäuferleitfaden. AWS Marketplace Management Portal
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 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 Deprecate an AMI im Amazon Elastic Compute Cloud-Benutzerhandbuch für Windows Instances.
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.
-
Kennung (Zeichenfolge) (erforderlich) — Ihre Produkt-ID. Weitere Informationen finden Sie unter Kennung.
-
Typ (Zeichenfolge) (erforderlich) — Das
Typebasiert auf der Versandmethode (Produkttyp), 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
DeliveryOptionIDs für die Versionen, die Sie einschränken möchten. Sie können die eindeutige Kennung für abrufen,DeliveryOptionindem Sie dieDescribeEntityAktion für die Version aufrufen, die 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. Dies beinhaltete die Überprüfung der Informationen, um sicherzustellen, dass sie den AWS Marketplace Richtlinien entsprechen. Der Validierungsprozess 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. 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_PRODUCT |
Verwenden Sie ein vorhandenes öffentliches Produkt. |
|
MISSING_DELIVERY_OPTION_IDS |
Geben Sie mindestens eine Lieferoption-ID an. |
|
INVALID_DELIVERY_OPTION_IDS |
Geben Sie die IDs der Lieferoptionen an, die im Produkt zu finden sind. IDs wurden nicht gefunden: [x] |
|
UNGÜLTIGE_LIEFEROPTION |
Geben Sie IDs für Lieferoptionen an, die sich in einem öffentlichen Zustand befinden. IDs, die sich nicht im öffentlichen Zustand befinden: [x] |
|
ALL_DELIVERY_OPTIONS_RESTRICTED |
Stellen Sie weniger Lieferoptionen zur Verfügung, die eingeschränkt werden müssen, da mindestens eine Option im öffentlichen Zustand bleiben muss. |
future aktualisieren AWS-Region Support
Sie können die Katalog-API verwenden, um future AWS-Region Supporteinstellungen für Ihr AMI-based Produkt in zu ändern AWS Marketplace.
Anmerkung
Weitere Informationen zur Änderung des AWS Marketplace Management Portal Supports für future Regionen mithilfe von finden Sie unter Support für future AWS-Regionen aktualisieren im AWS Marketplace Verkäuferleitfaden.
Anmerkung
Der UpdateFutureRegionSupport Änderungstyp ist nur am verfügbarAmiProduct@1.0.
Um future AWS-Region Supporteinstellungen 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 an, 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) — DasTypebasiert auf der Versandmethode (Produkttyp), die Ihr Produkt verwenden wird:AmiProduct@1.0.
-
-
DetailsDocument(object) (erforderlich) — Die Details, die zur Ausführung von erforderlich sind ChangeSet.-
FutureRegionSupport— Objekt-
SupportedRegions— Single-element Reihe von ZeichenkettenUnterstützte Werte für das Element: 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. Dies beinhaltete die Überprüfung der Informationen, um sicherzustellen, dass sie den AWS Marketplace Richtlinien entsprechen. Der Validierungsprozess 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. 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 |
|---|---|
| TOO_MANY_REGIONS | 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 die Werte [x, y, z] werden unterstützt. |
| UNGÜLTIGE_EINGABE | SupportedRegions kann nicht leer sein. |
Fügen Sie ein unterstütztes hinzu AWS-Region
Sie können die Katalog-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 an, 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) — DasTypebasiert auf der Versandmethode (Produkttyp), die Ihr Produkt verwenden wird:AmiProduct@1.0.
-
-
Beispiel
DetailsDocument(object) (required) – The details required to execute the ChangeSet.-
Regions: Zeichenfolgen-ArrayUnterstützte Elementwerte: 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. Dies beinhaltete die Überprüfung der Informationen, um sicherzustellen, dass sie den AWS Marketplace Richtlinien entsprechen. Der Validierungsprozess 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 wie
SUCCEEDEDfolgt lautet: Eine neue EntitätIdentifier(oderEntityId) wird generiert. Sie können denDescribeEntityAPI-Vorgang für die Produkt-Entität verwenden, um das Ergebnis zu überprüfen. -
Wenn der Ausführungsstatus des Änderungssatzes wie folgt lautet
CLIENT_ERROR: DieDescribeChangeSetAntwort enthält die Einzelheiten des Fehlers sowie die entsprechenden Maßnahmen zur Behebung des Fehlers.
Asynchrone Fehler
Die folgenden Fehler beziehen sich spezifisch auf AddRegions 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_REGIONS | Die angeforderten Regionen [a, b, c] sind ungültig oder nicht verfügbar. Nur die Werte [x, y, z] werden unterstützt. |
| UNGÜLTIGE_EINGABE | Regionen dürfen nicht leer sein. |
Beschränken Sie ein AWS-Region
Sie können die Katalog-API verwenden, um die zuvor AWS-Regionen für Ihr AMI-based Produkt unterstützte Version einzuschränken AWS Marketplace.
Anmerkung
Weitere Informationen zur Einschränkung zuvor unterstützter Regionen mithilfe von finden Sie unter Einschränken einer AWS-Region im AWS Marketplace Verkäuferleitfaden. 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 an, 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) — DasTypebasiert auf der Versandmethode (Produkttyp), die Ihr Produkt verwenden wird:AmiProduct@1.0.
-
-
DetailsDocument(object) (erforderlich) — Die Details, die zur Ausführung von erforderlich sind ChangeSet.
-
Regions— Reihe von ZeichenkettenUnterstützte Elementwerte: 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. Dies beinhaltete die Überprüfung der Informationen, um sicherzustellen, dass sie den AWS Marketplace Richtlinien entsprechen. Der Validierungsprozess 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ätIdentifier(oderEntityId) generiert. Sie können esDescribeEntityauf der Produkt-Entität verwenden, um das Ergebnis zu überprüfen. Weitere Informationen finden Sie unterDescribeEntity. -
Wenn der Ausführungsstatus des Änderungssatzes wie folgt lautet
CLIENT_ERROR: DieDescribeChangeSetAntwort enthält die Einzelheiten des Fehlers sowie die entsprechenden Maßnahmen zur Behebung des Fehlers.
Asynchrone Fehler
Die folgenden Fehler beziehen sich spezifisch auf AddRegions 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_REGIONS | Die angeforderten Regionen [a, b, c] sind ungültig oder nicht verfügbar. Nur die Werte [x, y, z] werden unterstützt. |
| UNGÜLTIGE_EINGABE | Regionen dürfen nicht leer sein. |
Fügen Sie einen neuen Instanztyp hinzu
Sie können die Katalog-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 unter Instanz hinzufügen im AWS Marketplace Verkäuferleitfaden. AWS Marketplace Management Portal
AddInstanceTypesfügt bei der Erstellung eines Produkts neue Instanztypen zu vorhandenen 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 Liste der eingeschränkten Instanztypen 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 hat keinen dauerhaften eingeschränkten Status für ein Produkt.
Bei Produkten mit interner Abrechnung müssen Verkäufer separate Änderungstypen angeben 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
Im Folgenden wird nur der AddInstanceTypes Änderungstyp angezeigt. Obwohl AMI-Verkäufer intern gemessen werden, müssen sie anrufen AddInstanceTypes und die Typen 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 an, in denen der AddInstanceTypes Änderungstyp hinzugefügt werden soll:
-
Entity(Objekt) (erforderlich) — Ihr AMI-based Produkt.-
Identifier(string) (erforderlich) — Ihre Produkt-ID. Weitere Informationen finden Sie unter Kennung. -
Type(string) (erforderlich) — DasTypebasiert auf der Versandmethode (Produkttyp), die Ihr Produkt verwenden wird:AmiProduct@1.0.
-
-
DetailsDocument(object) (erforderlich) — Die Details, die zur Ausführung von erforderlich sind
ChangeSet, in diesem FallInstanceTypes.-
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. Dies beinhaltete die Überprüfung der Informationen, um sicherzustellen, dass sie den AWS Marketplace Richtlinien entsprechen. Der Validierungsprozess 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. AddInstanceTypes AWS Marketplace Catalog API Diese Validierungen werden durchgeführt, wenn Sie aufrufen. 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 | Es dürfen nicht mehr als 1500 Einträge sein | 422 |
| Ein unbekanntes Eigentum | Zusätzliche Eigenschaften sind nicht zulässig | 422 |
Asynchrone Fehler
Die folgenden Fehler beziehen sich spezifisch auf AddInstanceTypes 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_INSTANCE_TYPES | Die folgenden Instanztypen sind nicht gültig: [x] |
| INVALID_INSTANCE_VIRTUALIZATION | Die Virtualisierung des Produkts ist [x]. Sie 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 Instance-Typen nicht unterstützt: [x] |
| INKOMPATIBLE_OPERATING_SYSTEM | Die Instanztypen sind nicht mit dem im Produkt definierten Betriebssystem kompatibel. Stellen Sie Instanztypen bereit, die mit dem im Produkt definierten Betriebssystem kompatibel sind. |
| INVALID_PRODUCT_TYPE | 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 | Für die Instanztypen [x] wurden keine intern gemessenen Dimensionen gefunden |
| MISSING_DIMENSIONS | 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. |
Beschränken Sie einen Instanztyp
Sie können die Katalog-API verwenden, um die für Ihr AMI-based Produkt verfügbaren Instanztypen in einzuschränken oder einzuschränken AWS Marketplace.
Anmerkung
Weitere Informationen zur Beschränkung oder Einschränkung der mit dem AWS Marketplace Management Portal verfügbaren Instanztypen finden Sie unter Einschränken einer Instanz im AWS Marketplace Verkäuferleitfaden.
Bestehende Abonnenten sind von dieser Änderung nicht betroffen und können die eingeschränkten Instanztypen verwenden. Neue Käufer werden jedoch nicht 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 Instanztypen auf alle Versionen im Produktdokument ein. Beim AddInstanceTypes Änderungstyp aktualisieren Sie alle Versionen des Produkts. Sie können die empfohlenen Instance-Typen nicht einschränken. Der empfohlene Instance-Typ bezieht sich auf Versionsebene. Es ist also möglich, dass der Verkäufer nicht in der Lage ist, mehrere Instance-Typen einzuschränken.
Bei einem intern gemessenen Produkt müssen Sie beim Aufrufen separate Änderungstypen aufrufenRestrictDimensions. Dadurch wird verhindert, dass neue Angebote für die eingeschränkten Instance-Typen erstellt werden.
Anmerkung
Der RestrictInstanceTypes Änderungstyp ist nur am verfügbarAmiProduct@1.0.
Um die für Ihr AMI-based Produkt verfügbaren Instance-Typen 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 an, 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) — DasTypebasiert auf der Versandmethode (Produkttyp), die Ihr Produkt verwenden wird:AmiProduct@1.0.
-
-
DetailsDocument(object) (erforderlich) — Die Details, die zur Ausführung von erforderlich sind
ChangeSet, in diesem FallInstanceTypes.-
InstanceTypes(Zeichenkettenarray) (erforderlich) — Liste derInstanceTypes, die auf das Produkt beschränkt werden sollen. Diese Instanzen werden zu den aktuellen Instanztypen hinzugefügt (oder wenn es keine vorhandenen Instanztypen gibt, werden sie hinzugefügt) oder 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. Dies beinhaltete die Überprüfung der Informationen, um sicherzustellen, dass sie den AWS Marketplace Richtlinien entsprechen. Der Validierungsprozess 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. RestrictInstanceTypes AWS Marketplace Catalog API Diese Validierungen werden durchgeführt, wenn Sie aufrufen. 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 | Es dürfen nicht mehr als 1500 Einträge sein | 422 |
| Ein unbekanntes Eigentum | Zusätzliche Eigenschaften sind nicht zulässig | 422 |
Asynchrone Fehler
Die folgenden Fehler beziehen sich spezifisch auf RestrictInstanceTypes 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 |
|---|---|
| UNGÜLTIGE INSTANZTYPEN | Die folgenden Instanztypen sind nicht gültig: [x] |
| INVALID_ PRODUCT_TYPE | Verwenden Sie ein vorhandenes einzelnes AMI-Produkt. |
| DUPLICATE_INSTANCE_TYPE | Stellen Sie Instanztypen ohne Duplikate bereit. |
| UNAVAILABLE_INSTANCE_TYPE | Geben Sie einen verfügbaren Instanztyp an. |
| RECOMMENDED_INSTANCE_TYPE_RESTRICTED | Die folgenden Instanztypen können nicht eingeschränkt werden. Der empfohlene Instanztyp muss auf einen anderen geändert werden, bevor er eingeschränkt wird. Lieferoptionen ID [X] Instanztyp [X] |
| DIMENSIONS_NOT_RESTRICTED | Schränken Sie die Dimensionen ein, bevor Sie die intern gemessenen Instanztypen einschränken: [x] |
| REGION_NO_INSTANCES | Ihre eingeschränkten Instance-Typen würden dazu führen, dass die Produkteinführung in Region X fehlschlägt. Erwägen Sie, weniger Instances einzuschränken. |
| INCOMPATIBLE_RESTRICTION | Ihre eingeschränkten Instance-Typen würden dazu führen, dass das Produkt keine FPGA-basierten Instance-Typen für AFIs enthält. Das Produkt muss mindestens einen FPGA-basierten Instance-Typ unterstützen. |