Die AWS Marketplace API-Referenz wurde neu strukturiert. Weitere Informationen zu den unterstützten API-Vorgängen finden Sie in der AWS Marketplace API-Referenz.
Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.
Arbeiten Sie mit dem privaten Marktplatz mit dem AWS Marketplace API
Sie können den verwenden AWS Marketplace Catalog API , um einen privaten Marktplatz für Sie AWS-Konto oder Ihre Organisation zu verwalten.
Alle Änderungstypen können nur über das Verwaltungskonto der Organisation oder über ein Mitgliedskonto aufgerufen werden, bei dem es sich um einen delegierten Administrator für den privaten Marktplatz handelt. Wenn Sie bereits Kunde bei einem privaten Marketplace sind und nicht über die AWS Organizations Integration für einen privaten Marketplace verfügen, können Sie einen privaten Marketplace von jedem Konto in Ihrer Organisation aus erstellen und verwalten, für das die AWSPrivateMarketplaceAdminFullAccess IAM-Richtlinie gilt.
Weitere Informationen zu privaten Marktplätzen finden Sie im Buyer Guide unter Private Marktplätze.AWS Marketplace
In der folgenden Tabelle werden eine Reihe von Aufgaben zur Verwaltung privater Marktplätze und die für die einzelnen Aufgaben geltenden Änderungstypen beschrieben.
| Aufgabe | Action | Typen ändern |
|---|---|---|
|
|
|
|
|
Änderung des Brandings eines privaten Marketplace-Erlebnisses |
|
|
|
Aktivierung oder Deaktivierung eines privaten Marketplace-Erlebnisses |
|
|
|
|
|
|
|
Das Abrufen einer Liste von Produkten auf einem privaten Marktplatz |
|
Nicht zutreffend |
|
Produkte zu einem privaten Marktplatz hinzufügen oder daraus entfernen |
|
|
|
Nicht zutreffend |
Nicht zutreffend |
|
|
Zusammenarbeit mit privaten Marktplätzen für AWS Organizations |
Nicht zutreffend |
Nicht zutreffend |
|
|
|
|
|
Archivierung und Reaktivierung eines privaten Marketplace-Erlebnisses |
|
|
Schaffung eines privaten Marktplatzes
Ein privater Marktplatz für einen AWS-Konto kann als eine Liste von Produkten betrachtet werden, die Benutzer über dieses Konto erwerben dürfen, und als Branding für den Marktplatz. In einer Organisation mit mehreren Konten können Sie die Gruppierung aus der so AWS Organizations genannten Organisationseinheit (OU) verwenden, um eine Verbindung zu einem Erlebnis herzustellen. Sie könnten beispielsweise eine Reihe von Produkten haben, die alle Accounts in der Organisation beschaffen dürfen, oder Sie könnten für jede Organisationseinheit in der Organisation eine eigene Produktliste erstellen. Sie können auch eine andere Produktliste für einzelne Konten in der Organisation haben. Jede Liste zugelassener Produkte und Marken wird als Einkaufserlebnis bezeichnet.
In der AWS Marketplace Catalog API stehen vier Einheiten für ein Erlebnis:
-
ExperienceEntität — Diese Entität befindet sich auf der höchsten Erlebnisebene und umfasst zwei untergeordnete Entitäten. -
ProcurementPolicyEntität — Diese Entität steht für die Produkte, die auf Ihrem privaten Marktplatz zugelassen und verweigert wurden. -
BrandingSettingsEntität — Sie können auch eineBrandingSettingsEntität erstellen, um zu definieren, wie Ihr privater Marktplatz für Ihre Nutzer aussieht. -
AudienceEntität — Sie müssen auch eine oder mehrereAudienceEntitäten zuordnen, die die Gruppe, die Organisationseinheiten oder die Organisation definieren, für die das Erlebnis gilt. AWS-Konten
Die Schritte zur Erstellung eines Einkaufserlebnisses lauten wie folgt:
-
Erstellen Sie die
ExperienceEntität. -
Erstellen Sie eine
ProcurementPolicyEntität, um die Liste der Produkte zu speichern, die für das Erlebnis zugelassen oder verweigert wurden. -
(Optional) Erstellen Sie eine
BrandingSettingsEntität, um das Erscheinungsbild Ihres Marketplace-Erlebnisses anzupassen. -
Ordnen Sie Ihrer Erfahrung Principals zu. Ein Principal kann eine AWS-Konto, eine OU oder die Organisation sein.
-
Aktivieren Sie das Erlebnis.
Anmerkung
Wenn Ihr Konto Teil einer Organisation in ist AWS Organizations, finden Sie weitere Informationen unterZusammenarbeit mit privaten Marktplätzen für AWS Organizations.
Erstellen Sie die Experience Entität
Um die Experience Entität zu erstellen, verwenden Sie die StartChangeSet Aktion mit dem CreateExperience Wert für den ChangeType Parameter, um anzufordern, dass das Erlebnis von erstellt wird AWS Marketplace. Beachten Sie hierzu das folgende Codebeispiel.
POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "CreateExperience", "DetailsDocument": { "Name": "ExamplePrivateMarketplace" }, "Entity": { "Type": "Experience@1.0" } } ], "ChangeSetName": "Create Private Marketplace Example" }
Bei dieser Aktion Entity handelt es sich um eine Vorlage für die Entität, die Sie erstellen möchten. Ihr wird zugewiesenEntityId, wenn sie erstellt wird. ChangeSetNameidentifiziert die Änderung, damit Sie sie später leichter finden können.
Die Antwort sieht wie folgt aus.
{ "ChangeSetArn": "arn:...:AWSMarketplace/ChangeSet/abcd1234example5678frjzkz", "ChangeSetId": "abcd1234example5678frjzkz" }
Die Antwort enthält eineChangeSetId, anhand derer Sie den Status Ihrer Änderungsanfrage während der Bearbeitung abrufen könnenDescribeChangeSet. Sie können es auch verwendenListEntities, um Ihre Experience Entität ohne die zu findenChangeSetId. Weitere Informationen über Änderungssätze finden Sie unter Mit Änderungssätzen arbeiten.
Für eine neu erstellte Experience Entität gibt es standardmäßig keine Beschaffungsrichtlinie. Es wird auch mit Standardeinstellungen für das Branding erstellt. Weitere Informationen zu Branding-Einstellungen, einschließlich deren Anpassung, finden Sie unterÄnderung des Brandings eines privaten Marketplace-Erlebnisses.
Erstellen Sie eine ProcurementPolicy Entität
Sie müssen eine ProcurementPolicy Entität erstellen. Standardmäßig ist eine neue Experience Entität deaktiviert, sodass Sie die Beschaffungsrichtlinie erstellen können, bevor Sie sie aktivieren.
Anmerkung
Eine Experience Entität ohne Beschaffungsrichtlinie (Null) ermöglicht die Beschaffung aller Produkte auf Ihrer privaten Marketplace-Site. Für ein Experience Unternehmen mit einer leeren Beschaffungsrichtlinie stehen den Benutzern keine Produkte zur Beschaffung zur Verfügung.
Um Produkte auf Ihrer privaten Marketplace-Site zuzulassen oder abzulehnen, müssen Sie die Beschaffungsrichtlinie erstellen. Dazu rufen Sie erneut anStartChangeSet, diesmal jedoch mit dem ChangeType AusCreateProcurementPolicy. Das folgende Codebeispiel erstellt eine leere Beschaffungsrichtlinie.
POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "CreateProcurementPolicy", "DetailsDocument": { "Name": "ExampleProcurementPolicy" }, "Entity": { "Type": "Experience@1.0", "Identifier": "exp-1234example@1" } } ] }
Die Entität, die Entity Sie in dieser Aktion angeben, ist die Experience Entität, in der Sie die Beschaffungsrichtlinie erstellen möchten. Daher müssen Sie den Bezeichner für die Entität angeben, die Sie zuvor erstellt haben. Verwenden SieListEntities, um die Experience Entität zu finden. Sie können die ID auch zurückgeben, indem Sie sie DescribeChangeSet zusammen mit der Änderungssatz-ID aus der CreateExperience Aktion verwenden
Anmerkung
Dieses Beispiel zeigt den Bezeichner mit einer Revision von1. Weitere Hinweise zu Revisionen für Bezeichner finden Sie unter. Kennung
Sie können den CreateProcurementPolicy Änderungstyp erneut verwendenDescribeChangeSet, um die Bearbeitung Ihrer Anfrage zu verfolgen.
Anmerkung
Die Namen, die Sie Experience den ProcurementPolicy Objekten geben, kommen nicht vor AWS Marketplace. Die Namen dienen nur dazu, Ihnen das Auffinden der Entitäten in der API zu erleichtern.
Nachdem Sie die Beschaffungsrichtlinie erstellt haben, wird Ihr privater Marktplatz im angezeigt AWS-Managementkonsole. (Sie können auf die Private Marketplace-Seite
In den folgenden Abschnitten wird die Verwaltung Ihres privaten Marktplatzes mit dem beschrieben AWS Marketplace Catalog API.
Änderung des Brandings eines privaten Marketplace-Erlebnisses
Sie können das Aussehen Ihres privaten Marktplatzes für Ihre Nutzer anpassen. Ohne Anpassung verfügt Ihr privater Marktplatz über die Standard-Branding-Einstellungen, die im Folgenden beschrieben werden. Zu den Aspekten des Brandings, die Sie auf einer privaten Marketplace-Site ändern können, gehören:
-
Title— Der Name, der für Ihren privaten Marktplatz angezeigt wird. Dies entspricht dem Feld Name in den Profileinstellungen des privaten Marktplatzes. Wenn Sie dasTitleauf setzenExample, wird der angezeigte Text Example Private Marketplace angezeigt. Die Standardeinstellung ist Private Marketplace. -
Information— Der Absatz, der unter dem Namen auf Ihrem privaten Marktplatz angezeigt wird. Dies entspricht dem Feld Beschreibung in den Profileinstellungen. Die Standardeinstellung ist „Keine Informationen“. In diesem Fall wird eine allgemeine Beschreibung der privaten Marktplätze angezeigt. -
ThemeColor— Die Farbe, die im Banner Ihres privaten Marktplatzes angezeigt wird. Dies ist eine Farbe im RGB-Hexadezimalformat. Dieser Wert entspricht dem Feld Themenfarbe in den Profileinstellungen. Der Standardwert ist#232F3E. -
LogoUrl— Die URL, die auf eine Bilddatei verweist, die als Logo auf Ihrem privaten Marktplatz verwendet werden soll. Die URL muss öffentlich verfügbar sein (z. B. eine signierte Amazon S3 S3-URL). Die Datei muss entweder eine PNG- oder eine SVG-Datei sein und weniger als 500 KB groß sein. Falls erforderlich, wird die Bilddatei auf eine maximale Höhe von 30 Pixeln und eine maximale Breite von 100 Pixeln skaliert. Dies ist derselbe Wert wie bei der Logo-Auswahl in den Profileinstellungen. Standardmäßig wird kein Logo angezeigt.
Um diese Werte festzulegen, müssen Sie zuerst eine BrandingSettings Entität mit dem CreateBrandingSettings Änderungstyp erstellen. Sie können dann eine UpdateBrandingSettings Änderung anfordern, um das Branding festzulegen oder zu ändern. Sie müssen ein BrandingSettings Objekt nur einmal erstellen. Um dieses Objekt zu erstellen, rufen Sie es StartChangeSet mit dem CreateBrandingSettings Änderungstyp auf, wie im folgenden Codebeispiel gezeigt.
POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "CreateBrandingSettings", "DetailsDocument": { "Name": "ExampleBrandingSettingsName" }, "Entity": { "Type": "Experience@1.0", "Identifier": "exp-1234example@2" } } ] }
In diesem Beispiel wird die Experience Entität geändert, indem das BrandingSettings Objekt hinzugefügt wird. Die Revision des Entitätsbezeichners wurde auf erhöht. 2 Weitere Hinweise zu Revisionen für Identifikatoren finden Sie unter. Kennung
Anmerkung
Sie können alle Details der Branding-Einstellungen in dem Aufruf angeben, um die Entität für Branding-Einstellungen zu erstellen. Die Detailfacette ist für CreateBrandingSettings und UpdateBrandingSettings dieselbe.
Sie ändern die Einstellungen, indem Sie StartChangeSet mit dem UpdateBrandingSettings Änderungstyp aufrufen. Die Einstellungen sind Teil Configuration des DetailsDocument Objekts.
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet":
[
{
"ChangeType": "UpdateBrandingSettings",
"DetailsDocument":
{
"Name": "ExampleBrandingSettingsName",
"Description": "Example description",
"Configuration":
{
"Title": "ExampleName",
"Information": "Example description.",
"ThemeColor": "#0e7f74",
"LogoUrl": "https://example.com/path/mylogo.png"
}
},
"Entity":
{
"Type": "Experience@1.0",
"Identifier": "exp-1234example@3"
}
}
]
}
Anmerkung
Die URL für das Logo wird verwendet, um während der Änderung des Updates eine Kopie zu erstellen. Wenn Sie nach Abschluss der Änderung die URL unter diesem Pfad entfernen oder ändern, hat dies keine Auswirkungen auf Ihren privaten Marktplatz, es sei denn, Sie stellen erneut eine AnfrageUpdateBrandingSettings.
Aktivierung oder Deaktivierung eines privaten Marketplace-Erlebnisses
Wenn ein privater Marktplatz aktiviert ist (und über eine Beschaffungsrichtlinie verfügt), können Benutzer mit zugehörigen Konten nur Produkte kaufen, die Sie genehmigt haben. Wenn für ein Konto kein privater Marktplatz aktiviert ist, können Benutzer Produkte aus dem gesamten AWS Marketplace Katalog kaufen.
Um einen privaten Marktplatz zu aktivieren, verwenden Sie die StartChangeRequest Aktion mit dem UpdateExperience Änderungstyp.
POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "UpdateExperience", "DetailsDocument": { "Status": "Enabled" }, "Entity": { "Type": "Experience@1.0", "Identifier": "exp-1234example@4" } } ] }
In ähnlicher Weise können Sie dieselbe Aktion und verwendenChangeType, aber den Wert Status in ändern, DetailsDocument Disabled um einen privaten Marktplatz zu deaktivieren.
Anmerkung
Wenn Sie eine private Marketplace-Site deaktivieren, behalten Sie Ihre Liste der zugelassenen und abgelehnten Produkte sowie Anpassungen, wie z. B. das Branding, bei. Wenn eine private Marketplace-Site deaktiviert ist, sehen Nutzer die private Marketplace-Site nicht mehr (obwohl sie möglicherweise weiterhin der Standarderfahrung der Organisation unterliegen). Wenn für ein Konto keine privaten Marketplace-Erlebnisse aktiviert sind, werden alle Einschränkungen aufgehoben, und Benutzer können alle Produkte öffentlich AWS Marketplace erwerben.
Benutzeranfragen aktivieren oder deaktivieren
Benutzer in Ihrer Organisation können die gesamte Öffentlichkeit sehen AWS Marketplace, aber sie können nur die Produkte abonnieren, die Sie zugelassen haben. Standardmäßig können sie verlangen, dass ein Produkt, das nicht auf dem privaten Marketplace erhältlich ist, hinzugefügt wird. Diese Anfragen werden auf der Administratorseite des privaten Marktplatzes (Private Marketplace
Sie können die Möglichkeit für Benutzer aktivieren oder deaktivieren, Anfragen für Ihr privates Marketplace-Erlebnis zu erstellen. Verwenden Sie es StartChangeSet zusammen mit dem UpdateProcurementPolicy Änderungstyp. Die Möglichkeit, Anfragen zu stellen, ist im folgenden Codebeispiel deaktiviert.
POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "UpdateProcurementPolicy", "DetailsDocument": { "Configuration": { "PolicyResourceRequests": "Deny" } }, "Entity": { "Type": "Experience@1.0", "Identifier": "exp-1234example@5" } } ] }
Um die Änderungsanforderungsfunktion für Benutzer zu aktivieren, verwenden Sie Allow statt Deny inPolicyResourceRequests.
Informationen zum Abrufen des aktuellen Status dieser Einstellung finden Sie im nächsten Abschnitt,Das Abrufen einer Liste von Produkten auf einem privaten Marktplatz.
Das Abrufen einer Liste von Produkten auf einem privaten Marktplatz
Die Produkte, die auf einem privaten Marktplatz zugelassen (und verweigert) werden, sind Teil der Beschaffungspolitik des Experience Unternehmens. Um die Details zu den Beschaffungsrichtlinien auf einem privaten Marktplatz zu erhalten, erhalten Sie zunächst die Beschaffungsrichtlinien-ID von der Experience Entität und rufen dann DescribeEntity mit dieser ID an.
Um die Beschaffungsrichtlinien-ID zu erhalten, verwenden DescribeEntity Sie sie für die Experience Entität, an der Sie interessiert sind, wie im folgenden Befehl gezeigt.
GET /DescribeEntity?catalog=AWSMarketplace&entityId=exp-example01
Nachfolgend finden Sie eine Beispielantwort.
{ "Details": "{\"Name\":\"New Private Marketplace\", \"Status\":\"Enabled\", \"ProcurementPolicies\":[\"procpolicy-123example456\"], \"BrandingSettings\":[\"brandsettings-456example123\"]}", "DetailsDocument": { "Name": "New Private Marketplace", "Status": "Enabled", "ProcurementPolicies": [ "procpolicy-123example456" ], "BrandingSettings": [ "brandsettings-456example123" ] }, "EntityArn": "arn:<...>:AWSMarketplace/Experience/exp-example-01", "EntityIdentifier": "exp-example01@6", "EntityType": "Experience@1.0", "LastModifiedDate": "2021-01-13T20:31:36Z" }
Anmerkung
Das DetailsDocument Attribut enthält die Entitätsdetails als JSON-Objekt. Das Details Legacy-Attribut enthält dasselbe JSON-Objekt als Zeichenfolge.
Sie können die zurückgegebene EntityId Beschaffungsrichtlinie verwenden, um die Details abzurufen, wie im folgenden Befehl gezeigt.
GET /DescribeEntity?catalog=AWSMarketplace&entityId=procpolicy-123example456
Dadurch werden die vollständigen Details der Richtlinie zurückgegeben, einschließlich zugelassener und abgelehnter Produkte. Nachfolgend finden Sie eine Beispielantwort.
{
"Details": "{\"Name\":\"ExampleProcurementPolicy\", \"Statements\":[{\"Effect\":\"Allow\",\"Resources\":[{\"Type\":\"Product\",\"Ids\":[\"example1-1234-abcd-5678-90abcdef1234\"]},{\"Type\":\"Product\",\"Ids\":[\"example2-2345-bcde-6789-01bcdea2345\"]}]},{\"Effect\":\"Deny\",\"Resources\":[{\"Type\":\"Product\",\"Ids\":[\"example3-3456-cdef-7890-12defabc5678\"]}]}],\"Configuration\":{\"PolicyResourceRequests\":\"Allow\"}}",
"DetailsDocument":
{
"Name": "ExampleProcurementPolicy",
"Statements":
[
{
"Effect": "Allow",
"Resources":
[
{
"Type": "Product",
"Ids":
[
"example1-1234-abcd-5678-90abcdef1234"
]
},
{
"Type": "Product",
"Ids":
[
"example2-2345-bcde-6789-01bcdea2345"
]
}
]
},
{
"Effect": "Deny",
"Resources":
[
{
"Type": "Product",
"Ids":
[
"example3-3456-cdef-7890-12defabc5678"
]
}
]
}
],
"Configuration":
{
"PolicyResourceRequests": "Allow"
}
},
"EntityArn": "arn:<...>AWSMarketplace/ProcurementPolicy/procpolicy-123example456",
"EntityIdentifier": "procpolicy-123example456@4",
"EntityType": "ProcurementPolicy@1.0",
"LastModifiedDate": "2020-10-01T12:00:00Z"
}
In diesem Beispiel umfasst die Beschaffungsrichtlinie zwei zugelassene Produkte und ein abgelehntes Produkt. Die Richtlinie erlaubt Anfragen von Benutzerressourcen.
Produkte zu einem privaten Marktplatz hinzufügen oder daraus entfernen
Standardmäßig enthält ein privater Marktplatz keine zugelassenen Produkte. Verwenden Sie Änderungsanfragen, um ein Produkt hinzuzufügen oder zu entfernen. Verwenden Sie den AllowProductProcurement Änderungstyp, um ein Produkt hinzuzufügen. Verwenden Sie den DenyProductProcurement Änderungstyp, um ein Produkt zu entfernen.
Das folgende Codebeispiel zeigt den AllowProductProcurement Änderungstyp mit der StartChangeSet Aktion, ein Produkt zu einer privaten Marketplace-Site hinzuzufügen.
POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "AllowProductProcurement", "DetailsDocument": { "Products": [ { "Ids": [ "example-1234-abcd-5678-90abcded1234" ], "Notes": "Useful product" } ] }, "Entity": { "Identifier": "exp-1234example@6", "Type": "Experience@1.0" } } ] }
Sie fügen das Produkt der Experience Entität für einen privaten Marktplatz hinzu, indem SieAllowProductProcurement. Die Syntax zum Entfernen eines Produkts von einer privaten Marketplace-Site ist identisch, mit der Ausnahme, dass Sie DenyProductProcurement ChangeType anstelle von die Syntax verwendenAllowProductProcurement. Die Produkte werden der Zulassungsliste (oder Ablehnungsliste) der ProcurementPolicy Entität hinzugefügt, die in Ihrer Experience Entität enthalten ist.
Anmerkung
Die Liste der Produkte in der DetailsDocument von Ihnen geänderten Version besteht aus einer Reihe von ProduktenIds, sodass Sie mehrere Produkte mit einem Aufruf hinzufügen (oder entfernen) können, indem Sie eine Liste mit Produktkennzeichnungen hinzufügen. Das Limit liegt bei 50 Produkten pro Anfrage.
Das Notes Feld für die Liste von Ids ist nicht erforderlich. Sie können es jedoch verwenden, um aufzuzeichnen, warum eine Entscheidung getroffen wurde, eine Reihe von Produkten zuzulassen oder abzulehnen.
Produkte finden
Wenn Sie sich die Einzelheiten Ihrer Einkaufsrichtlinien ansehen, können Sie die Produkt-IDs für die Produkte finden, die bereits auf einem privaten Marktplatz erhältlich sind. Das AWS Marketplace Catalog API bietet jedoch keine Möglichkeit, die Produkt-IDs für andere Produkte zu finden. Es gibt zwei Möglichkeiten, Produkt-IDs für die Verwendung mit dem Catalog API-Dienst abzurufen:
-
Öffentlicher Marktplatz — Nachdem Sie ein Produkt auf der öffentlichen Marketplace-Site gefunden haben, wählen Sie Weiter abonnieren, um eine Detailseite zu dem Produkt aufzurufen (Sie erhalten das Produkt dadurch nicht). Die URL wird die Produkt-ID als Parameter enthalten. In der URL
ab1234cd-1234-abcd-5678-90abcdef1234stehthttps://aws.amazon.com/marketplace/fulfillment?productId=ab1234cd-1234-abcd-5678-90abcdef1234&ref_=dtl_psb_continuebeispielsweise die Produkt-ID. -
AWS Marketplace Discovery-API — Programmgesteuert können Sie mithilfe der Discovery-API auf die vollständige Liste der AWS Marketplace Produkte in der zugreifen. Die Discovery-API ist eine private API. Sie müssen Zugriff beantragen, um sie verwenden zu können. Weitere Informationen finden Sie unter Zugriffskontrolle für die AWS Marketplace Discovery-API.
Zusammenarbeit mit privaten Marktplätzen für AWS Organizations
Unabhängig davon, ob Sie mit einem privaten Marktplatz für Ihr Konto oder Ihre Organisation arbeiten, verwenden Sie dieselbe API. Es gibt jedoch Unterschiede, wenn Sie innerhalb Ihrer Organisation arbeiten:
-
Bevor Sie die Funktion „Private Marketplace“ in einer Organisation verwenden können, müssen Sie den vertrauenswürdigen Zugriff aktivieren, um dem privaten Marketplace Service (
private-marketplace.marketplace.amazonaws.com) Zugriff auf Ihre AWS Organizations Daten zu gewähren. Sie müssen auch die mit dem Dienst verknüpfte Rolle Private Marketplace im Verwaltungskonto erstellen. Diese Rolle umfasst alle Berechtigungen, die Private Marketplace benötigt, um private Marketplace-Ressourcen in Ihrem Namen zu beschreiben AWS Organizations und zu aktualisieren. Diese Aktionen können nur über das Verwaltungskonto ausgeführt werden. Es wird empfohlen, diese Aktivierung über die private Marketplace-Administratorseite durchzuführen. Wenn Sie ein neuer Kunde sind, finden Sie im Buyer Guide weitere Informationen unter Private Marktplätze.AWS Marketplace Wenn Sie bereits Kunde sind, finden Sie weitere Informationen unter Private Marketplace-Site erstellen und verwalten im AWS Marketplace Buyer Guide. -
Private Marketplace-Ressourcen in einer Organisation werden im Verwaltungskonto erstellt und mit dem Mitgliedskonto geteilt, bei dem es sich um einen delegierten Administrator für private Marketplace-Sites handelt.
-
Wenn Sie Objekte auf einer privaten Marketplace-Site von einem Mitgliedskonto aus anbieten, das ein delegierter Administrator für eine private Marketplace-Site ist, müssen Sie diese mit dem
SharedWithMeFilter ausdrücklich anfordern. Dies gilt sowohlListEntitiesfür Aktionen als auch fürListChangeSetsAktionen.
Um Experience Objekte in Ihrem eigenen Konto aufzulisten, rufen Sie ListEntities wie im folgenden Codebeispiel gezeigt auf.
POST /ListEntities HTTP/1.1 Content-Type: application/json { "Catalog":"AWSMarketplace", "EntityType":"Experience" }
Um jedoch die Entitäten aufzulisten, die für Sie freigegeben wurden, müssen Sie ein Zeichen FilterList mit dem Scope Zeichen von hinzufügenSharedWithMe, wie im folgenden Codebeispiel gezeigt. AWS Marketplace Sucht daher außerhalb Ihres eigenen Kontos nach Entitäten, die mit Ihnen geteilt wurden.
POST /ListEntities HTTP/1.1 Content-Type: application/json {"Catalog":"AWSMarketplace", "EntityType":"Experience", "FilterList": [{ "Name": "Scope", "ValueList": ["SharedWithMe"] }]}
In diesem Fall werden nur Entitäten außerhalb Ihres Kontos (die Entitäten für Ihre Organisation) zurückgegeben.
In ähnlicher Weise müssen Sie für einen Anruf ListChangeSets den Bereich festlegen, wie im folgenden Codebeispiel gezeigt.
POST /ListChangeSets HTTP/1.1 Content-Type: application/json {"Catalog":"AWSMarketplace", "FilterList": [{ "Name": "Scope", "ValueList": ["SharedWithMe"] }]}
Dadurch werden Änderungssätze zurückgegeben, die für eine gemeinsame private Marketplace-Site Ihrer Organisation gelten.
Principals mit Erlebnissen verknüpfen
Ein privates Marketplace-Erlebnis muss mit einem oder mehreren Principals verknüpft sein, damit es Auswirkungen auf Ihr Unternehmen hat. Für ein einzelnes AWS-Konto Erlebnis müssen Sie das Konto mit dem Erlebnis verknüpfen, um den privaten Marktplatz nutzen zu können. In einer Organisation können Sie mehrere Erlebnisse für verschiedene Schulleiter anbieten.
Anmerkung
-
Das Erlebnis, das der Organisation zugeordnet ist, ist der Standard für alle anderen Konten in der Organisation. Die Verknüpfung eines Mitgliedskontos oder einer Organisationseinheit mit einer anderen Benutzererfahrung führt direkt zu einer anderen Benutzererfahrung für das Mitgliedskonto oder die untergeordneten Konten der Organisationseinheit.
-
Wenn Sie ein aktueller privater Marketplace-Kunde ohne die AWS Organizations Integration für einen privaten Marketplace sind, ist das Erlebnis, das mit dem Verwaltungskonto verknüpft ist, der Standard für alle anderen Konten in der Organisation.
Um einem Erlebnis einen Principal zuzuordnen, verwenden Sie den AssociateAudience Änderungstyp für die StartChangeSet Aktion, wie im folgenden Codebeispiel gezeigt.
POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "Entity": { "Type": "Experience@1.0", "Identifier": "exp-example01@1" }, "ChangeType": "AssociateAudience", "DetailsDocument": { "Name": "AudienceName", "Description": "Audience example.", "Principals": [ "012345678901", "ou-abcd-01234567", "o-0123456789" ] } } ], "ChangeSetName": "Set Audience for experience 01" }
Die Zielgruppe ist die Liste der Principals, die dem Experience zugeordnet sind. Ein Principal ist eine AWS-Konto Organisationseinheit oder Organisation, die durch ihre ID definiert wird. Principalsist eine Liste, sodass Sie mehrere Principals angeben können, die dem Erlebnis zugeordnet werden sollen. Nach dem ersten Anruf werden bei nachfolgenden Aufrufen des AssociateAudience Änderungstyps der Zuordnung für das Erlebnis Principals hinzugefügt.
Sie können Konten auch aus einem Erlebnis entfernen. Verwenden Sie dazu den DisassociateAudience Änderungstyp, wie im folgenden Codebeispiel gezeigt.
POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "Entity": { "Type": "Experience@1.0", "Identifier": "exp-example01@02" }, "ChangeType": "DisassociateAudience", "DetailsDocument": { "Principals": [ "012345678901", "ou-abcd-01234567", "o-0123456789" ] } } ], "ChangeSetName": "Disassociate audience example" }
Anmerkung
Ein Schulleiter kann nur einem Erlebnis direkt zugeordnet werden. Um einen Schulleiter nicht mehr direkt mit einem Erlebnis zu einem anderen Erlebnis zu verbinden, müssen Sie ihn von der ersten Erfahrung trennen und ihn dann der zweiten zuordnen.
Archivierung und Reaktivierung eines privaten Marketplace-Erlebnisses
Sie können ein privates Marketplace-Erlebnis entfernen, indem Sie es archivieren. Archivierte Erlebnisse können nicht aktualisiert oder zur Verwaltung von Konten in Ihrer Organisation verwendet werden. Wenn Sie Zielgruppen haben, die mit einem archivierten Erlebnis verknüpft sind, können Sie sie einem anderen Erlebnis zuordnen. Wenn Sie sich entscheiden, das Erlebnis zu einem späteren Zeitpunkt zu nutzen, können Sie es jederzeit wieder aktivieren. Administratoren des Verwaltungskontos oder eines Mitgliedskontos, bei dem es sich um einen delegierten Administrator für den privaten Marktplatz handelt, sind berechtigt, Erlebnisse zu archivieren und zu reaktivieren. Wenn Sie ein aktueller privater Marketplace-Kunde ohne die AWS Organizations Integration für den privaten Marktplatz sind, sind Administratoren des Kontos, das das Erlebnis erstellt hat, berechtigt, Erlebnisse zu archivieren und zu reaktivieren.
Anmerkung
Bevor Sie ein Erlebnis archivieren, müssen Sie es deaktivieren. Informationen zur Deaktivierung eines Erlebnisses finden Sie im AWS Marketplace Buyer Guide unter Konfiguration Ihres privaten Marktplatzes.
Um ein Erlebnis zu archivieren, verwenden Sie den RestrictExperience Änderungstyp zusammen mit der StartChangeSet Aktion, wie im folgenden Codebeispiel gezeigt.
POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "RestrictExperience", "DetailsDocument": {}, "Entity": { "Type": "Experience@1.0", "Identifier": "exp-1234example" } } ] }
Um ein Erlebnis zu reaktivieren, verwenden Sie den ReviveExperience Änderungstyp zusammen mit der StartChangeSet Aktion, wie im folgenden Codebeispiel gezeigt.
POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "ReviveExperience", "DetailsDocument": {}, "Entity": { "Type": "Experience@1.0", "Identifier": "exp-1234example" } } ] }
Fehler in der privaten Marketplace-API
Die folgenden Fehler beziehen sich spezifisch auf die Aktionen für private Marktplätze in der AWS Marketplace Katalog-API.
| Änderungstyp | Fehlercode | Fehlermeldung | Description |
|---|---|---|---|
| Errors returned directly by the StartChangeSet action | |||
|
Alle |
422 |
Dokument ist nicht gültiges JSON-Format |
Es wurde eine ungültige JSON-Eingabe verwendet. Überprüfen Sie Ihre Syntax. |
|
AllowProductProcurement, DenyProductProcurement |
422 |
Werte im IDS-Array müssen eindeutig sein |
Sie können dasselbe Produkt nicht mehrmals in eine einzige Änderungsanforderung aufnehmen. |
|
AllowProductProcurement, DenyProductProcurement |
422 |
Die kumulierte Anzahl der Werte im IDS-Array muss kleiner oder gleich 50 sein |
Sie können in einer einzigen Änderungsanforderung bis zu 50 Produkte zulassen oder ablehnen. |
| Errors found by calling the DescribeChangeSet action | |||
|
CreateBrandingSettings, UpdateBrandingSettings |
UNGÜLTIGE_URL |
Das Bild konnte nicht von der Eingabe-URL abgerufen werden |
Sie müssen eine gültige, erreichbare URL für das Logofeld in |
|
CreateBrandingSettings, UpdateBrandingSettings |
INVALID_IMAGE |
Die Bildverifizierung für Typ, Inhalt oder Dateigröße ist fehlgeschlagen. Nur PNG- und SVG-Dateitypen mit einer Größe von weniger als oder gleich 500 KB werden unterstützt. |
Ihre Bilddatei muss den Logo-Anforderungen für die Branding-Einstellungen entsprechen. |
|
AllowProductProcurement, DenyProductProcurement |
ENTITY_NOT_FOUND |
Die Beschaffungspolitik fehlt in Experience |
Sie müssen eine erstellen, |
|
CreateProcurementPolicy |
ENTITY_ALREADY_EXISTS |
Für Experience gibt es eine Beschaffungsrichtlinie |
Sie können nur eine einzige Beschaffungsrichtlinie für einen privaten Marktplatz haben. |
|
UpdateProcurementPolicy |
ENTITY_NOT_FOUND |
Die Beschaffungspolitik fehlt in Experience |
Sie müssen eine erstellen, |
|
CreateBrandingSettings |
ENTITY_ALREADY_EXISTS |
Branding-Einstellungen sind für Experience vorhanden |
Sie können nur eine einzige Branding-Einstellung für einen privaten Marktplatz verwenden. |
|
UpdateBrandingSettings |
ENTITY_NOT_FOUND |
Branding-Einstellungen fehlen in Experience |
Sie müssen eine |
|
AssociateAudience |
CALLER_NOT_AUTHORIZED |
Der Anrufer ist nicht berechtigt, die Aktion auszuführen |
Sie müssen über die erforderlichen Berechtigungen verfügen, um die Aktion aufrufen zu können. Die hinzugefügten Konten müssen sich in derselben Organisation befinden. |
|
CreateExperience |
CALLER_NOT_AUTHORIZED |
Der Anrufer ist nicht berechtigt, ein Erlebnis zu erstellen. |
Sie müssen über die erforderlichen Berechtigungen verfügen, um ein Erlebnis zu erstellen. |
|
AssociateAudience |
ENTITY_ALREADY_EXISTS |
Dem Konto {accountId} ist bereits ein Erlebnis zugeordnet. Trennen Sie vor der Aktualisierung die Zuordnung zu früheren Erlebnissen |
Sie können einem Konto nur ein einziges Erlebnis zuordnen. Trennen Sie die Verknüpfung des aktuellen Erlebnisses, bevor Sie ein neues Erlebnis verknüpfen. |
|
AssociateAudience, DisassociateAudience |
ENTITY_IN_USE |
Für das ausgewählte Konto ist bereits eine widersprüchliche Änderung im Gange. Versuchen Sie es später erneut |
Sie können die Zuordnung zu einem Konto nicht ändern, solange bereits eine weitere Änderungsanforderung zur Änderung der Zuordnung bearbeitet wird. |
Entitätstypen, die von Private Marketplace definiert sind
In der folgenden Tabelle sind die Entitätstypen, der Zweck und die Aktionen für private Marketplace-Entitäten aufgeführt, für die sie jeweils spezifiziert werden können. Jeder Entitätstyp kann verwendet werden, um einen Amazon-Ressourcennamen (ARN) anzugeben, der in der AWS Identity and Access Management (IAM) -Richtlinie verwendet werden kann. Weitere Informationen zu ARN-Formaten finden Sie unterAPI-Entitäten katalogisieren.
| Entität | Zweck | Aktionen |
|---|---|---|
|
|
Speichert die Einstellungen der obersten Ebene für einen privaten Marketplace |
|
|
|
Speichert die Branding-Einstellungen für einen privaten Marktplatz |
|
|
|
Speichert die Beschaffungseinstellungen und Produktlisten auf einer privaten Marketplace-Site |
|
|
|
Speichert die Details von Auftraggebern, die mit einer privaten Marketplace-Site verknüpft sind |
|