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 Verkäuferprodukten

Sie können das verwenden AWS Marketplace Catalog API , um Aufgaben für die Arbeit mit Verkäuferprodukten zu automatisieren. Dazu gehört die Möglichkeit, Produkte zu erstellen, zu aktualisieren, anzuzeigen, aufzulisten und zu sortieren. Auf diese Weise können Sie das Produktmanagement automatisieren. Sie können beispielsweise Self-Service-Veröffentlichungsfunktionen auf dem AWS Marketplace Management Portal bereitstellen.

Ein Produkt ist eine Einheit oder Ressource, in der Sie verkaufen möchten. AWS Marketplace Dies wird häufig als Basisprodukt bezeichnet. Käufer können ein Basisprodukt erst nutzen, wenn Sie Produktinformationen, Bereitstellungsmerkmale und Rechnungsinformationen hinzugefügt haben.

Ein Produkt beschreibt die Produktinformationen, die Merkmale der Softwarebereitstellung und den Abrechnungsmechanismus des Angebots, das Sie verkaufen möchten. Das Produkt muss mit einem Angebot kombiniert werden, um zu einer Transaktionseinheit zu werden, die Sie verkaufen und in der Käufer verwenden können. AWS Marketplace

Sie können das auch verwenden, um: AWS Marketplace Catalog API

Jeder Produkttyp hat eine andere Produkteinheit. Bei einer Entität kann es sich um ein Produkt oder ein Angebot handeln AWS Marketplace. Die folgenden Produkttypen und Entitäten werden unterstützt:

Bei den folgenden Themen wird davon ausgegangen, dass Sie Zugriff auf die API haben und alle Voraussetzungen für Verkäufer erfüllt haben, wie unter beschriebenZugriffskontrolle für die AWS Marketplace Catalog-API.

Weitere Informationen finden Sie in den folgenden Ressourcen:

In den folgenden Themen wird beschrieben, wie Sie die Catalog API verwenden, um Aktionen für Ihre Single-AMI-Produkte, containerbasierten Produkte oder SaaS-Produkte durchzuführen.

Erstellen Sie ein Produkt

Sie können die Catalog API verwenden, um ein AMI-, Container-, Machine Learning- oder SaaS-Produktdokument mit Identifikatoren (Produktcode und Produkt-ID) zu erstellen. AWS Marketplace

Sie erstellen ein Produkt im Draft Status, indem Sie den StartChangeSet API-Vorgang mit dem CreateProduct Änderungstyp aufrufen.

Wenn Ihre Anfrage erfolgreich bearbeitet wurde, wird ein Produkt im Draft Status für Sie AWS Marketplace Catalog API generiert. Dies ist ein unvollständiges Produkt und für Käufer in nicht sichtbar AWS Marketplace.

Anschließend verwenden Sie Update Änderungstypen, um den Prozess zur Produkterstellung abzuschließen: UpdateInformationUpdateDimensions, UpdateTargeting, und UpdateVisibility.

Nachdem das Produkt fertiggestellt ist, können Sie den ReleaseProductÄnderungstyp verwenden, um den Produkterstellungsprozess abzuschließen und anschließend das Angebot zu veröffentlichen. Bei diesem Prozess wird das gesamte Produkt validiert und das Produkt in den Limited Status versetzt.

Um ein Produkt im Draft Status zu erstellen, rufen Sie den StartChangeSet API-Vorgang mit dem CreateProduct Änderungstyp auf, wie im folgenden Beispiel gezeigt.

Anforderungssyntax

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

{
"Catalog": "AWSMarketplace",
"ChangeSet": [ 
  { 
    "ChangeType":"CreateProduct",
    "Entity":{
      "Type": "SaaSProduct@1.0" // choose from ["AmiProduct@1.0", "ContainerProduct@1.0", "SaaSProduct@1.0", "MachineLearningProduct@1.0"]
     },
     "DetailsDocument": {
        "ProductTitle": "Test product title set in CreateProduct"
     }
  }
]
}

Geben Sie Informationen für die Felder an, um den CreateProduct Änderungstyp hinzuzufügen. Dieser Änderungstyp kann ProductTitle Attribute annehmen, wobei dieselben Einschränkungen gelten wie für den Änderungstyp, der in den UpdateInformation Änderungstyp gesendet wurde.

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.

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

Wenn die Anfrage abgeschlossen ist (falls Status jaSUCCEEDED), ProductId wird eine neue generiert.

Synchrone Validierungen

Die folgenden Schemavalidierungen sind spezifisch für Aktionen in. CreateProduct 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.

Asynchrone Fehler

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

Produktdetails aktualisieren

Wenn Sie bereits über ein Produkt verfügen AWS Marketplace, können Sie die Katalog-API verwenden, um die Produktdetails für ein AMI-, Container-, ML- oder SaaS-Produkt zu aktualisieren.

Um Produktdetails zu aktualisieren, rufen Sie den StartChangeSet API-Vorgang mit dem UpdateInformation Änderungstyp und den Details auf, die Sie ändern möchten, wie im folgenden Beispiel gezeigt.

Anforderungssyntax

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateInformation",
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "AmiProduct@1.0"
      },
      "DetailsDocument":
      {
        "ProductTitle": "My Product Title",
        "ShortDescription": "My product short description.",
        "LongDescription": "My product longer description.",
        "Sku": "123example456",
        "LogoUrl": "https://awsmp-logos.s3.amazonaws.com/ca60b754fe05a24257176cdbf31c4e0d",
        "VideoUrls":
        [
          "https://example.com/my-video"
        ],
        "Highlights":
        [
          "123example45"
        ],
        "AdditionalResources":
        [
          {
            "Text": "123example456",
            "Url": "https://example.com/some-link"
          }
        ],
        "SupportDescription": "Need help? Contact our experts at support@example.com \n\nYour purchase includes 24x7 support.",
        "Categories":
        [
          "Operating Systems",
          "Network Infrastructure",
          "Application Development"
        ],
        "SearchKeywords":
        [
          "123example456"
        ]
      }
    }
  ]
}

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

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.

Um den Status der Anfrage zu überprüfen, verwenden Sie die AWS Marketplace Management Portal oder rufen Sie die DescribeChangeSet API auf.

Synchrone Validierungen

Die folgenden Schemavalidierungen sind spezifisch für Aktionen in. UpdateInformation 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.

Asynchrone Fehler

Die folgenden Fehler beziehen sich spezifisch auf UpdateInformation 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.

Fügen Sie Preisdimensionen hinzu

Sie können die AWS Marketplace Catalog Service Actions verwenden, um fakturierbare Preisdimensionen hinzuzufügen, mit denen Sie Benutzern AMI-, Container- oder SaaS-Produkte in Rechnung stellen können.

Eine Preisdimension ist eine Maßeinheit, die Verkäufer definieren, um Käufern Gebühren in Rechnung zu stellen. Verkäufer müssen diese Informationen einrichten, um Käufern die Nutzung des Produkts in Rechnung zu stellen, unabhängig davon, ob es sich um ein nutzungsbasiertes oder ein vertragsbasiertes Preismodell handelt. Die Art der Dimension hängt vom Preismodell des Produkts ab.

Weitere Informationen zur Preisgestaltung von Produkten finden Sie unter den folgenden Themen im AWS Marketplace Verkäuferleitfaden:

Weitere Informationen zum Hinzufügen von Preisdimensionen mithilfe von finden Sie in den folgenden Themen im AWS Marketplace Verkäuferleitfaden: AWS Marketplace Management Portal

Um Preisdimensionen hinzuzufügen, rufen Sie die StartChangeSet API mit dem AddDimensions Änderungstyp auf, wie im folgenden Beispiel gezeigt.

Anforderungssyntax

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "AddDimensions",
      "DetailsDocument":
      [
        {
          "Description": "Description of the dimension",
          "Key": "UniqueApiKey",
          "Unit": "HostHrs",
          "Name": "First Dimension",
          "Types":
          [
            "ExternallyMetered"
          ]
        }
      ],
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "SaaSProduct@1.0"
      }
    }
  ]
}

Geben Sie die folgenden Felder für den AddDimensions Änderungstyp an.

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ört auch 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. AddDimensions 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.

Asynchrone Fehler

Die folgenden Fehler beziehen sich spezifisch auf AddDimensions 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.

Preisdimensionen aktualisieren

Sie können die Catalog API verwenden, um bestehende Preisdimensionen eines AMI-, Container- oder SaaS-Produkts in zu aktualisieren AWS Marketplace.

Jede Dimension wird anhand des Dimensionsschlüssels und der Dimensionstypen eindeutig identifiziert, um die Aktualisierung durchzuführen. Die Aktualisierung einer Dimension wirkt sich nicht auf aktive Angebote oder Kunden aus, die mit der ursprünglichen Dimension erstellt wurden.

Um Preisdimensionen zu aktualisieren, rufen Sie den StartChangeSet API-Vorgang mit dem UpdateDimensions Änderungstyp auf, wie im folgenden Beispiel gezeigt.

Anforderungssyntax

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateDimensions",
      "DetailsDocument":
      [
        {
          "Key": "UniqueApiKey",
          "Types":
          [
            "ExternallyMetered"
          ],
          "Name": "First Dimension",
          "Description": "Description of the dimension"
        }
      ],
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "SaaSProduct@1.0"
      }
    }
  ]
}

Verwenden Sie die folgenden Felder für den UpdateDimensions Änderungstyp:

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. UpdateDimensions 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.

Asynchrone Fehler

Die folgenden Fehler beziehen sich spezifisch auf UpdateDimensions 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.

Beschränken Sie die Preisdimensionen

Sie können die Catalog API verwenden, um bestehende Preisdimensionen eines AMI- oder SaaS-Produkts in einzuschränken AWS Marketplace.

Jede Dimension wird anhand des Dimensionsschlüssels und der Dimensionstypen eindeutig identifiziert, um die Aktualisierung durchzuführen. Die Einschränkung einer Dimension wirkt sich nicht auf aktive Angebote oder Kunden aus, die mit der ursprünglichen Dimension erstellt wurden.

Um die Preisdimensionen einzuschränken, rufen Sie die StartChangeSet API mit dem RestrictDimensions Änderungstyp auf.

Das folgende Beispiel zeigt, wie die Entitled Dimension für ein SaaS-Produkt eingeschränkt wird.

Anforderungssyntax

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "RestrictDimensions",
      "DetailsDocument":
      [
        {
          "Key": "UniqueApiKey",
          "Types": ["Entitled"]
        }
      ],
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "SaaSProduct@1.0"
      }
    }
  ]
}

Verwenden Sie die folgenden Felder mit dem RestrictDimensions Änderungstyp:

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 AWS Marketplace Management Portal oder durch Aufrufen der DescribeChangeSet API überprüfen.

Synchrone Validierungen

Die folgenden Schemavalidierungen sind spezifisch für Aktionen in. RestrictDimensions 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.

Asynchrone Fehler

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

Targeting-Konfiguration aktualisieren

Sie können die Catalog API verwenden, um AWS-Konto IDs hinzuzufügen, die das AMI-, Container-, ML- oder SaaS-Produkt anzeigen dürfen, AWS Marketplace bevor es in einen Public Status versetzt wird, indem UpdateTargeting Sie den Änderungstyp aufrufen.

Konten für verwaltete Katalogoperationen (MCO) werden automatisch zur Liste der zulässigen Konten hinzugefügt, wenn neue Produkte erstellt werden. Diese MCO-Konten sind für Verkäufer im AWS Marketplace Management Portal (AMMP) sichtbar, wenn sie sich die erlaubten Konten ansehen, sowie im Targeting Abschnitt der DescribeEntity API-Antwort.

Um AWS-Konto IDs hinzuzufügen, die das AMI-, Container-, ML- oder SaaS-Produkt anzeigen dürfen, rufen Sie den StartChangeSet API-Vorgang mit dem UpdateTargeting Änderungstyp auf, wie im folgenden Beispiel gezeigt.

Anforderungssyntax

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateTargeting",
      "Entity":
      {
        "Type": "SaaSProduct@1.0",
        "Identifier": "prod-example12345"
      },
      "DetailsDocument":
      {
        "PositiveTargeting":
        {
          "BuyerAccounts":
          [
            "1112223334444"
          ]
        }
      }
    }
  ]
}

Verwenden Sie die folgenden Felder mit dem UpdateTargeting Änderungstyp.

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.

Um den Status der Anfrage zu überprüfen, verwenden Sie die AWS Marketplace Management Portal oder rufen Sie die DescribeChangeSet API auf.

Wenn die Anfrage abgeschlossen ist (falls Status jaSUCCEEDED), ProductId wird eine neue generiert.

Synchrone Validierungen

Die folgenden Schemavalidierungen sind spezifisch für Aktionen in. UpdateTargeting 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.

Asynchrone Fehler

Die folgenden Fehler beziehen sich spezifisch auf DescribeChangeSet 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.

Aktualisieren Sie die Sichtbarkeit Ihrer Produkte

Sie können die Catalog API verwenden, um die Sichtbarkeit (auch als Lebenszyklusstatus bezeichnet) eines AMI-, Container-, ML- oder SaaS-Produkts in zu aktualisieren AWS Marketplace.

Zulässige Limited Ziellebenszyklusstatus sindPublic,, oderRestricted.

Um die Sichtbarkeit Ihres Produkts zu aktualisieren, rufen Sie den StartChangeSet API-Vorgang mit dem UpdateVisibility Änderungstyp auf, wie im folgenden Beispiel gezeigt.

Anforderungssyntax

Für wann TargetVisibility ist Public oderLimited.

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateVisibility",
      "Entity":
      {
        "Type": "SaaSProduct@1.0",
        "Identifier": "prod-example12345"
      },
      "DetailsDocument":
      {
        "TargetVisibility": "Public"
      }
    }
  ]
}

Für wann TargetVisibility istRestricted.

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateVisibility",
      "Entity":
      {
        "Type": "SaaSProduct@1.0",
        "Identifier": "prod-example12345"
      },
      "DetailsDocument":
      {
        "TargetVisibility": "Restricted",
        "ReplacementProductId": "prod-example54321"
      }
    }
  ]
}

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

Synchrone Validierungen

Die folgenden Schemavalidierungen sind spezifisch für Aktionen in. UpdateVisibility 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.

Nach dem Auslösen dieses Änderungstyps kann es bis zu 37 Tage dauern, bis der Vorgang abgeschlossen ist. Dazu gehört auch die Zeit, die das AWS Marketplace Seller Operations Team zur Prüfung, Prüfung und Genehmigung benötigt. Wenn Sie ein Produkt einschränken, haben Sie 24 Stunden Zeit, Ihre Meinung zu ändern, indem Sie anrufenCancelChangeSet, bevor das AWS Marketplace Seller Operations Team mit der Prüfung beginnt. Weitere Informationen finden Sie unter CancelChangeSet.

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 die Anfrage abgeschlossen ist (falls Status jaSUCCEEDED), ProductId wird eine neue generiert.

Asynchrone Fehler

Die folgenden Fehler beziehen sich spezifisch auf UpdateVisibility 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.

Veröffentlichen Sie ein Produkt

Sie können die Catalog API verwenden, um ein Draft AMI-, Container-, ML- oder SaaS-Produkt in Limited State in zu veröffentlichen AWS Marketplace.

Um ein Produkt zu veröffentlichen, rufen Sie den StartChangeSet API-Vorgang mit dem ReleaseProduct Änderungstyp auf, wie im folgenden Beispiel gezeigt.

Anforderungssyntax

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "ReleaseProduct",
      "Entity":
      {
        "Type": "SaaSProduct@1.0",
        "Identifier": "prod-example12345"
      },
      "DetailsDocument": {}
    }
  ]
}

Geben Sie Informationen für die Felder an, die dem ReleaseProduct Änderungstyp hinzugefügt werden sollen. Dieser Änderungstyp benötigt keine Parameter-Nutzlast.

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 die Anfrage abgeschlossen ist (falls Status jaSUCCEEDED), ProductId wird eine neue generiert.

Asynchrone Fehler

Die folgenden Fehler beziehen sich spezifisch auf ReleaseProduct 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.

Finden Sie Ihre Produkt-ID

Sie müssen die Produkt-ID für Ihr Produkt erhalten, bevor Sie es mit der AWS Marketplace Catalog API ändern können. Es gibt zwei Möglichkeiten, die Produkt-ID für Serverprodukte zu finden:

In den folgenden Themen wird erklärt, wie Sie ein Produkt finden, indem Sie nach der Entitäts-ID, dem Produkttitel, dem Datum der letzten Änderung oder der Sichtbarkeit filtern.

Finden Sie ein Produkt anhand des Produkttitels

Anforderung

POST /ListEntities HTTP/1.1
Content-Type: application/json
      
{
    "Catalog": "AWSMarketplace",
    "EntityType": "AmiProduct",
    "MaxResults": 10,
    "EntityTypeFilters": {
        "AmiProductFilters": {
            "ProductTitle": {
                "WildCardValue": "XYZ"
            }
        }
    }
}

Antwort

HTTP/1.1 200
Content-type: application/json

{ 
  "EntitySummaryList": [ 
    { 
      "EntityArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/AmiProduct/example-abcd-1234",
      "EntityId": "example1-abcd-1234-5ef6-7890abcdef12@1",
      "EntityType": "AmiProduct",
      "LastModifiedDate": "2018-02-27T13:45:22Z",
       "AmiProductSummary": {
            "ProductTitle": "ABC-XYZ-123",
            "Visibility": "Public"
       }
    } 
  ],
  "NextToken": "" 
}

Finden Sie ein Produkt anhand des Datums der letzten Änderung

Anforderung

POST /ListEntities HTTP/1.1
Content-Type: application/json
      
{
    "Catalog": "AWSMarketplace",
    "EntityType": "AmiProduct",
    "MaxResults": 10,
    "EntityTypeFilters": {
        "AmiProductFilters": {
            "LastModifiedDate": {
                "DateRange": {
                    "BeforeValue": "2018-03-27T13:45:22Z",
                    "AfterValue": "2018-01-27T13:45:22Z"
                }
            }
        }
    }
}

Antwort

HTTP/1.1 200
Content-type: application/json

{ 
  "EntitySummaryList": [ 
    { 
      "EntityArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/AmiProduct/example-abcd-1234",
      "EntityId": "example1-abcd-1234-5ef6-7890abcdef12@1",
      "EntityType": "AmiProduct",
      "LastModifiedDate": "2018-02-27T13:45:22Z",
       "AmiProductSummary": {
            "ProductTitle": "ABC-XYZ-123",
            "Visibility": "Public"
       }
    } 
  ],
  "NextToken": "" 
}

Finden Sie ein Produkt auf der Grundlage der Produktsichtbarkeit

Anforderung

POST /ListEntities HTTP/1.1
Content-Type: application/json
      
{
    "Catalog": "AWSMarketplace",
    "EntityType": "AmiProduct",
    "MaxResults": 10,
    "EntityTypeFilters": {
        "AmiProductFilters": {
            "Visibility": {
                "ValueList": [
                    "Public"
                ]
            }
        }
    }
}

Antwort

HTTP/1.1 200
Content-type: application/json

{ 
  "EntitySummaryList": [ 
    { 
      "EntityArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/AmiProduct/example-abcd-1234",
      "EntityId": "example1-abcd-1234-5ef6-7890abcdef12@1",
      "EntityType": "AmiProduct",
      "LastModifiedDate": "2018-02-27T13:45:22Z",
       "AmiProductSummary": {
            "ProductTitle": "ABC-XYZ-123",
            "Visibility": "Public"
       }
    } 
  ],
  "NextToken": "" 
}

Finden Sie ein Produkt anhand des Produkttitels, des Datums der letzten Änderung und der Sichtbarkeit des Produkts

Anforderung

POST /ListEntities HTTP/1.1
Content-Type: application/json
      
{
    "Catalog": "AWSMarketplace",
    "EntityType": "AmiProduct",
    "MaxResults": 10,
    "EntityTypeFilters": {
        "AmiProductFilters": {
            "LastModifiedDate": {
                "DateRange": {
                    "BeforeValue": "2018-03-27T13:45:22Z",
                    "AfterValue": "2018-01-27T13:45:22Z"
                }
            },
            "Visibility": {
                "ValueList": [
                    "Public"
                ]
            },
            "ProductTitle": {
                "ValueList": [
                    "ABC-XYZ-123"
                ]
            }
        }
    }
}

Antwort

HTTP/1.1 200
Content-type: application/json

{ 
  "EntitySummaryList": [ 
    { 
      "EntityArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/AmiProduct/example-abcd-1234",
      "EntityId": "example1-abcd-1234-5ef6-7890abcdef12@1",
      "EntityType": "AmiProduct",
      "LastModifiedDate": "2018-02-27T13:45:22Z",
       "AmiProductSummary": {
            "ProductTitle": "ABC-XYZ-123",
            "Visibility": "Public"
       }
    } 
  ],
  "NextToken": "" 
}

Holen Sie sich zusätzliche Informationen zu einem Produkt

Sie können zusätzliche Informationen über das Produkt erhalten, indem Sie die Entitäts-ID mit der DescribeEntity Aktion verwenden.

Anforderung

GET /DescribeEntity?catalog=AWSMarketplace&entityId=example-abcd-1234 HTTP/1.1

Antwort

HTTP/1.1 200
Content-type: application/json

{
   "DetailsDocument": {
        "ProductTitle": "ABC-XYZ-123",
        "ShortDescription": "My product short description.", 
        "LongDescription": "My product longer description.", 
        "Sku": "123example456", 
        "SupportDescription": "Need help? Contact our experts at support@example.com \n\nYour purchase includes 24x7 support.", 
        "Categories": [ 
            "Operating Systems", 
            "Network Infrastructure", 
            "Application Development" 
            ] 
   }
    "EntityArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/AmiProduct/example-abcd-1234",
    "EntityId": "example1-abcd-1234-5ef6-7890abcdef12@1",
    "EntityType": "AmiProduct",
    "LastModifiedDate": "2018-02-27T13:45:22Z",
}

Status und Fehler des Sets ändern

Um Änderungen an Verkäuferprodukten in der AWS Marketplace Katalog-API vorzunehmen, müssen Sie Änderungssätze erstellen, die die Änderungen beschreiben, die Sie vornehmen möchten, und dann die StartChangeSet Aktion verwenden, um die Änderungen zu starten. Je nach Anfrage kann es Minuten bis Stunden oder länger dauern, bis die Änderungen an der Anfrage abgeschlossen sind. Die Antwort auf diese Anfrage sieht wie folgt aus.

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

Die Änderungsanfrage wird einer Warteschlange hinzugefügt und bearbeitet. Dazu gehört auch das Scannen der Dateien und Informationen, um sicherzustellen, dass sie den AWS Marketplace Produktrichtlinien entspricht. Je nach Änderungsanforderung kann dieser Vorgang einige Minuten bis Tage dauern. Sie können den Status der Anfrage über die AWS Marketplace Management Portal oder in der Katalog-API mit der DescribeChangeSet Aktion überprüfen. Weitere Informationen über Änderungssätze finden Sie unter Mit Änderungssätzen arbeiten.

Verwenden Sie die DescribeChangeSet Aktion, um den Status Ihrer Anfrage zu überprüfen.

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

{
   "Catalog": "AWSMarketplace",
   "ChangeSetID": "example123456789012abcdef"
}

Das Ergebnis dieses Aufrufs sieht wie folgt aus (in diesem Fall für das Hinzufügen einer neuen Version zu einem Containerprodukt).

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef",
  "ChangeSetName": "Submitted by 123456789012",
  "StartTime": "2020-10-27T22:21:26Z",
  "EndTime": "2020-10-27T22:32:19Z",
  "Status": "SUCCEEDED",
  "ChangeSet":
  [
    {
      "ChangeType": "AddDeliveryOptions",
      "Entity":
      {
        "Type": "ContainerProduct@1.0",
        "Identifier": "example-1234-abcd-56ef-abcdef12345678@4"
      },
      "Details": "{\"Version\": {\"VersionTitle\": \"1.1\",\"ReleaseNotes\": \"Minor bug fix\"},\"DeliveryOptions\": [{\"DeliveryOptionTitle\": \"EKSDelivery\",\"Details\": {\"EcrDeliveryOptionDetails\" : {\"ContainerImages\": [\"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1\"],\"DeploymentResources\": [{\"Name\": \"HelmDeploymentTemplate\",\"Url\": \"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1\"}],\"CompatibleServices\": [\"EKS\"],\"Description\": \"Sample Description\",\"UsageInstructions\":\"helm pull 111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1\"}}},{\"DeliveryOptionTitle\": \"HelmChartDeliveryOption\",\"Details\": {\"HelmDeliveryOptionDetails\": {\"CompatibleServices\": [\"EKS\", \"EKS-Anywhere\"],\"ContainerImages\": [\"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1\"],\"HelmChartUri\": \"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:helmchart1.1\",\"Description\": \"Helm chart description\",\"UsageInstructions\": \"Usage instructions\",\"MarketplaceServiceAccountName\": \"Service account name\",\"ReleaseName\": \"Optional release name\",\"Namespace\": \"Optional Kubernetes namespace\",\"OverrideParameters\": [{\"Key\": \"HelmKeyName1\",\"DefaultValue\": \"${AWSMP_LICENSE_SECRET}\"},{\"Key\": \"HelmKeyName2\",\"DefaultValue\": \"${AWSMP_SERVICE_ACCOUNT}\"}]}}}]}",
      "DetailsDocument":
      {
        "Version":
        {
          "VersionTitle": "1.1",
          "ReleaseNotes": "Minor bug fix"
        },
        "DeliveryOptions":
        [
          {
            "DeliveryOptionTitle": "EKSDelivery",
            "Details":
            {
              "EcrDeliveryOptionDetails":
              {
                "ContainerImages":
                [
                  "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1"
                ],
                "DeploymentResources":
                [
                  {
                    "Name": "HelmDeploymentTemplate",
                    "Url": "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1"
                  }
                ],
                "CompatibleServices":
                [
                  "EKS"
                ],
                "Description": "Sample Description",
                "UsageInstructions": "helm pull 111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1"
              }
            }
          },
          {
            "DeliveryOptionTitle": "HelmChartDeliveryOption",
            "Details":
            {
              "HelmDeliveryOptionDetails":
              {
                "CompatibleServices":
                [
                  "EKS",
                  "EKS-Anywhere"
                ],
                "ContainerImages":
                [
                  "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1"
                ],
                "HelmChartUri": "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:helmchart1.1",
                "Description": "Helm chart description",
                "UsageInstructions": "Usage instructions",
                "MarketplaceServiceAccountName": "Service account name",
                "ReleaseName": "Optional release name",
                "Namespace": "Optional Kubernetes namespace",
                "OverrideParameters":
                [
                  {
                    "Key": "HelmKeyName1",
                    "DefaultValue": "${AWSMP_LICENSE_SECRET}"
                  },
                  {
                    "Key": "HelmKeyName2",
                    "DefaultValue": "${AWSMP_SERVICE_ACCOUNT}"
                  }
                ]
              }
            }
          }
        ]
      },
      "ErrorDetailList":
      []
    }
  ]
}

Das Status Feld zeigt den aktuellen Status der Anfrage an, in diesem FallSUCCEEDED.

Wenn Fehler auftreten, kann das Ergebnis zwei Arten von Fehlern enthalten. Bei den meisten Fehlern ist die Fehlermeldung direkt enthalten. Fehler, die beim Scannen des Produkts auf Sicherheitslücken gefunden wurden, enthalten jedoch stattdessen eine URL zu einer Datei, in der alle gefundenen Fehler in dem ErrorMessage Feld aufgeführt sind. Fehler, die beim Scannen gefunden wurden, haben das ErrorCode Zeichen "SCAN_ERROR“.

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef",
  "ChangeSetName": "Submitted by 123456789012",
  "StartTime": "2020-10-27T22:21:26Z",
  "EndTime": "2020-10-27T22:32:19Z",
  "Status": "FAILED",
  "FailureDescription": "Change set preparation has failed. For details see 'ErrorDetailList'.",
  "ChangeSet":
  [
    {
      "ChangeType": "AddDeliveryOptions",
      "Entity":
      {
        "Type": "ContainerProduct@1.0",
        "Identifier": "example-1234-abcd-56ef-abcdef12345678@4"
      },
      "Details": "{\"Version\": {\"VersionTitle\": \"1.1\",\"ReleaseNotes\": \"Minor bug fix\"},\"DeliveryOptions\": [{\"DeliveryOptionTitle\": \"EKSDelivery\",\"Details\": {\"EcrDeliveryOptionDetails\" : {\"ContainerImages\": [\"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1\"],\"DeploymentResources\": [{\"Name\": \"HelmDeploymentTemplate\",\"Url\": \"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1\"}],\"CompatibleServices\": [\"EKS\"],\"Description\": \"Sample Description\",\"UsageInstructions\":\"helm pull 111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1\"}}},{\"DeliveryOptionTitle\": \"HelmChartDeliveryOption\",\"Details\": {\"HelmDeliveryOptionDetails\": {\"CompatibleServices\": [\"EKS\", \"EKS-Anywhere\"],\"ContainerImages\": [\"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1\"],\"HelmChartUri\": \"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:helmchart1.1\",\"Description\": \"Helm chart description\",\"UsageInstructions\": \"Usage instructions\",\"MarketplaceServiceAccountName\": \"Service account name\",\"ReleaseName\": \"Optional release name\",\"Namespace\": \"Optional Kubernetes namespace\",\"OverrideParameters\": [{\"Key\": \"HelmKeyName1\",\"DefaultValue\": \"${AWSMP_LICENSE_SECRET}\"},{\"Key\": \"HelmKeyName2\",\"DefaultValue\": \"${AWSMP_SERVICE_ACCOUNT}\"}]}}}]}",
      "DetailsDocument":
      {
        "Version":
        {
          "VersionTitle": "1.1",
          "ReleaseNotes": "Minor bug fix"
        },
        "DeliveryOptions":
        [
          {
            "DeliveryOptionTitle": "EKSDelivery",
            "Details":
            {
              "EcrDeliveryOptionDetails":
              {
                "ContainerImages":
                [
                  "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1"
                ],
                "DeploymentResources":
                [
                  {
                    "Name": "HelmDeploymentTemplate",
                    "Url": "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1"
                  }
                ],
                "CompatibleServices":
                [
                  "EKS"
                ],
                "Description": "Sample Description",
                "UsageInstructions": "helm pull 111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1"
              }
            }
          },
          {
            "DeliveryOptionTitle": "HelmChartDeliveryOption",
            "Details":
            {
              "HelmDeliveryOptionDetails":
              {
                "CompatibleServices":
                [
                  "EKS",
                  "EKS-Anywhere"
                ],
                "ContainerImages":
                [
                  "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1"
                ],
                "HelmChartUri": "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:helmchart1.1",
                "Description": "Helm chart description",
                "UsageInstructions": "Usage instructions",
                "MarketplaceServiceAccountName": "Service account name",
                "ReleaseName": "Optional release name",
                "Namespace": "Optional Kubernetes namespace",
                "OverrideParameters":
                [
                  {
                    "Key": "HelmKeyName1",
                    "DefaultValue": "${AWSMP_LICENSE_SECRET}"
                  },
                  {
                    "Key": "HelmKeyName2",
                    "DefaultValue": "${AWSMP_SERVICE_ACCOUNT}"
                  }
                ]
              }
            }
          }
        ]
      },
      "ErrorDetailList":
      [
        {
          "ErrorCode": "DUPLICATE_VERSION_TITLE",
          "ErrorMessage": "The version title must be different from any other version titles of this product."
        },
        {
          "ErrorCode": "SCAN_ERROR",
          "ErrorMessage": "https://123sample456.cloudfront.net/example-1234-abcd-5678-abcdef12345678/1234abcdef567890"
        }
      ]
    }
  ]
}

In diesem Beispiel wurde ein Fehler direkt gemeldet (DUPLICATE_VERSION_TITLE). Bei dem anderen Fehler handelt es sich um eine Datei mit Fehlermeldungen (bei einem einzelnen Fehler SCAN_ERROR können mehrere Fehler in der verknüpften Datei gefunden werden).