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 privaten Angeboten mit dem AWS Marketplace APIs

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

Während das Produkt beschreibt, worin verkauft wird AWS Marketplace, beschreibt das Angebot die Bedingungen und Regeln, wie ein Produkt gekauft und konsumiert wird. AWS Marketplace Produkte können mehrere Angebote haben, die von verschiedenen Verkäufern verkauft werden. Jedes AWS Marketplace Angebot kann jedoch nur für ein Produkt erstellt werden. Ein Angebot enthält eine Sammlung von Vertragsbedingungen zwischen zwei Parteien. Die akzeptierten Angebotsbedingungen werden als Nachweis einer Transaktion in eine Vereinbarung übersetzt.

Es gibt zwei Arten von Angeboten:

Weitere Informationen finden Sie in den folgenden Ressourcen:

In den folgenden Themen wird beschrieben, wie Sie mit der Catalog API Angebote erstellen und aktualisieren können:

Erstellen Sie ein Angebot

Sie können die Katalog-API verwenden, um ein neues Angebot in zu erstellen AWS Marketplace. Wenn Ihre Anfrage erfolgreich verarbeitet wird, wird ein Draft unvollständiges Angebot AWS Marketplace Catalog API erstellt, das für Käufer unsichtbar ist. Verwenden Sie den Update Änderungstyp, um ein Angebot abzuschließen. Wenn das Angebot vollständig ist, verwenden Sie den ReleaseOfferÄnderungstyp, um es zu erstellen und zu veröffentlichen. Durch die Veröffentlichung eines Angebots wird es validiert und für Käufer sichtbar gemacht. AWS Marketplace

Um ein neues Angebot zu erstellen, rufen Sie den StartChangeSet API-Vorgang mit dem CreateOffer Änderungstyp auf, wie im folgenden Beispiel gezeigt.

Anforderungssyntax

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "CreateOffer",
      "Entity": {
        "Type": "Offer@1.0"
      },
      "DetailsDocument": {
        "ProductId": "prod-ad8EXAMPLE51",
        "Name": "Test Offer",
        "OfferSetId": "offerset-b3f9EXAMPLE27"
      }
    }
  ]
}

Geben Sie Informationen für die Felder an, um den CreateOffer Ä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.

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.

Ist dies der Status SUCCEEDED Fall, OfferId wird eine neue generiert.

Die Antwort sieht wie folgt aus.

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef",
  "ChangeSetName": "Submitted by 123456789012",
  "StartTime": "2021-05-27T22:21:26Z",
  "EndTime": "2021-05-27T22:32:19Z",
  "Status": "SUCCEEDED",
  "ChangeSet": [
    {
      "ChangeType": "CreateOffer",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "ProductId": "prod-ad8EXAMPLE51",
        "Name": "Test Offer"
      },
      "ErrorDetailList": []
    }
  ]
}

Synchrone Validierungen

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

Erstellen Sie ein Ersatzangebot

Sie können die Katalog-API verwenden, um ein Ersatzangebot (auch als vereinbarungsbasiertes Angebot bezeichnet) in zu erstellen. AWS Marketplace

Wenn Ihre Anfrage erfolgreich bearbeitet wurde, AWS Marketplace Catalog API wird ein Angebot im Draft Status für Sie erstellt. Dabei handelt es sich um ein unvollständiges Angebot, das für Käufer nicht sichtbar ist. AWS Marketplace Sie verwenden die Update Änderungsarten, um das Angebot abzuschließen. Nachdem das Angebot abgeschlossen ist, verwenden Sie die Option „Typ ReleaseOfferändern“, um den Prozess der Angebotserstellung abzuschließen und das Angebot zu veröffentlichen. Dadurch wird das gesamte Angebot validiert und Ihr Angebot ist ab sofort für Käufer sichtbar AWS Marketplace. Von dort aus hat der Käufer die Möglichkeit, das Ersatzangebot anzunehmen oder im Rahmen der ursprünglichen Vereinbarung weiterzuarbeiten.

Um ein Ersatzangebot zu erstellen, rufen Sie den StartChangeSet API-Vorgang mit dem CreateReplacementOffer Änderungstyp auf und geben Sie eine bereits bestehende Vereinbarungs-ID an, wie im folgenden Beispiel gezeigt.

Anforderungssyntax

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "CreateReplacementOffer",
      "Entity": {
        "Type": "Offer@1.0"
      },
      "DetailsDocument": {
        "AgreementId": "agmt-12345",
        "Name": "Offer name"
      }
    }
  ]
}

Geben Sie Informationen für die Felder an, um den CreateReplacementOffer Ä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.

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.

Synchrone Validierungen

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

Angebotsinformationen aktualisieren

Sie können die Katalog-API verwenden, um die Angebotsinformationen in zu aktualisieren AWS Marketplace.

Um die Angebotsinformationen zu aktualisieren, rufen Sie den StartChangeSet API-Vorgang mit dem UpdateInformation Änderungstyp auf, wie im folgenden Beispiel gezeigt. Alle anderen Informationen bleiben unverändert.

Anforderungssyntax

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "UpdateInformation",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "Name": "New offer name",
        "Description": "New offer description",
        "PreExistingAgreement": {
          "AcquisitionChannel": "External",
          "PricingModel": "Contract"
        }
      }
    }
  ]
}

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. Dazu gehört auch die Überprüfung der Informationen, um sicherzustellen, dass sie den AWS Marketplace Richtlinien entsprechen. Der Validierungsprozess kann einige Minuten dauern.

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

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.

Targeting-Konfiguration aktualisieren

Sie können die Katalog-API verwenden, um die Targeting-Konfiguration Ihres Angebots in zu aktualisieren AWS Marketplace.

Alle vorhandenen Targeting-Optionen, die nicht in der letzten Anfrage enthalten sind und aus dem Angebot entfernt werden.

Um die Targeting-Konfiguration Ihres Angebots zu aktualisieren, 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": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "PositiveTargeting": {
          "CountryCodes": [
            "US",
            "CA"
          ],
          "BuyerAccounts": [
            "111122223333"
          ]
        },
        "NegativeTargeting": {
          "CountryCodes": [
            "XX"
          ]
        }
      }
    }
  ]
}

Geben Sie Informationen für die Felder an, um den UpdateTargeting Ä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. Dazu gehört auch die Überprüfung der Informationen, um sicherzustellen, dass sie den AWS Marketplace Richtlinien entsprechen. Der Validierungsprozess kann einige Minuten dauern.

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

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

Rückerstattungsrichtlinie aktualisieren

Sie können die Katalog-API verwenden, um die Rückerstattungsrichtlinie Ihres Angebots in zu aktualisieren AWS Marketplace.

Diese Änderung hat keine Auswirkungen auf bestehende Vereinbarungen. Die Support-Bedingungen, die nicht in der letzten Anfrage enthalten sind, werden aus dem Angebot entfernt.

Um die Rückerstattungsrichtlinie zu aktualisieren, rufen Sie den StartChangeSet API-Vorgang mit dem UpdateSupportTerms Änderungstyp auf, wie im folgenden Beispiel gezeigt.

Anforderungssyntax

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "UpdateSupportTerms",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "Terms": [
          {
            "Type": "SupportTerm",
            "RefundPolicy": "Updated refund policy description"
          }
        ]
      }
    }
  ]
}

Geben Sie Informationen für die Felder an, um den UpdateSupportTerms Ä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. Dazu gehört auch die Überprüfung der Informationen, um sicherzustellen, dass sie den AWS Marketplace Richtlinien entsprechen. Der Validierungsprozess kann einige Minuten dauern.

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

Synchrone Validierungen

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

Rechtliche Ressourcen aktualisieren

Sie können die Katalog-API verwenden, um die vorhandenen rechtlichen Dokumente, wie z. B. eine Endbenutzer-Lizenzvereinbarung (EULA), zu ersetzen. Die rechtlichen Bestimmungen, die nicht in der letzten Anfrage enthalten sind, werden aus dem Angebot entfernt.

Um die rechtlichen Ressourcen Ihres Angebots zu aktualisieren, rufen Sie den StartChangeSet API-Vorgang mit dem UpdateLegalTerms Änderungstyp auf, wie im folgenden Beispiel gezeigt.

Anforderungssyntax

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "UpdateLegalTerms",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "Terms": [
          {
            "Type": "LegalTerm",
            "Documents": [
              {
                "Type": "CustomEula",
                "Url": "https://s3.amazonaws.com/EULA/custom-eula-1234.txt"
              }
            ]
          }
        ]
      }
    }
  ]
}

Geben Sie Informationen für die Felder an, um den UpdateLegalTerms Ä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. Dazu gehört auch die Überprüfung der Informationen, um sicherzustellen, dass sie den AWS Marketplace Richtlinien entsprechen. Der Validierungsprozess kann einige Minuten dauern.

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

Synchrone Validierungen

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

Preise aktualisieren

Sie können die Katalog-API verwenden, um die bestehenden Preisbedingungen vollständig zu ersetzen. Die Preisbedingungen, die in der letzten Anfrage nicht enthalten sind, werden aus dem Angebot entfernt.

Um die Preisbedingungen für Ihr Angebot zu aktualisieren, rufen Sie den StartChangeSet API-Vorgang mit dem UpdatePricingTerms Änderungstyp auf, wie im folgenden Beispiel gezeigt.

Anforderungssyntax

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "UpdatePricingTerms",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "PricingModel": "Usage",
        "Terms": [
          {
            "Type": "UsageBasedPricingTerm",
            "CurrencyCode": "USD",
            "RateCards": [
              {
                "RateCard": [
                  {
                    "DimensionKey": "m3.large",
                    "Price": "0.10"
                  },
                  {
                    "DimensionKey": "m4.xlarge",
                    "Price": "0.20"
                  }
                ]
              }
            ]
          },
          {
            "Type": "ConfigurableUpfrontPricingTerm",
            "CurrencyCode": "USD",
            "RateCards": [
              {
                "Selector": {
                  "Type": "Duration",
                  "Value": "P365D"
                },
                "RateCard": [
                  {
                    "DimensionKey": "m3.large",
                    "Price": "300"
                  },
                  {
                    "DimensionKey": "m4.xlarge",
                    "Price": "400"
                  }
                ],
                "Constraints": {
                  "MultipleDimensionSelection": "Allowed",
                  "QuantityConfiguration": "Allowed"
                }
              }
            ]
          },
          {
            "Type": "ByolPricingTerm"
          },
          {
            "Type": "RecurringPaymentTerm",
            "CurrencyCode": "USD",
            "BillingPeriod": "Monthly",
            "Price": "100.0"
          },
          {
            "Type": "FixedUpfrontPricingTerm",
            "CurrencyCode": "USD",
            "Price": "200.00",
            "Grants": [
              {
                "DimensionKey": "Users",
                "MaxQuantity": 10
              }
            ]
          },
          {
            "Type": "FreeTrialPricingTerm",
            "Duration": "P30D",
            "Grants": [
              {
                "DimensionKey": "m3.xlarge",
                "MaxQuantity": 10
              },
              {
                "DimensionKey": "m4.xlarge",
                "MaxQuantity": 10
              }
            ]
          }
        ]
      }
    }
  ]
}

Geben Sie Informationen für die Felder an, um den UpdatePricingTerms Ä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. Dazu gehört auch die Überprüfung der Informationen, um sicherzustellen, dass sie den AWS Marketplace Richtlinien entsprechen. Der Validierungsprozess kann einige Minuten dauern.

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

Synchrone Validierungen

Die folgenden Schemavalidierungen sind spezifisch für Aktionen in. UpdatePricingTerms 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 UpdatePricingTerms 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 Auffindbarkeit des Angebots

Sie können die Katalog-API verwenden, um die Auffindbarkeit Ihres Angebots in zu kontrollieren. AWS Marketplace

Sie können entweder ein bestimmtes Datum in der future festlegen, um die Auffindbarkeit Ihres Angebots einzuschränken, oder ob Ihr Angebot in der Vergangenheit ablaufen soll. Die Art der UpdateAvailability Änderung wirkt sich nicht auf bestehende Vereinbarungen aus.

Um zu kontrollieren, ob Ihr Angebot auffindbar ist, rufen Sie den StartChangeSet API-Vorgang mit dem UpdateAvailability Änderungstyp auf, wie im folgenden Beispiel gezeigt.

Anforderungssyntax

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "UpdateAvailability",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "AvailabilityEndDate": "2024-05-31"
      }
    }
  ]
}

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

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

Syntax der Antwort

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

Die Änderungsanforderung wird einer Warteschlange hinzugefügt und verarbeitet. Es beinhaltet die Überprüfung der Informationen, um sicherzustellen, dass sie den AWS Marketplace Richtlinien entsprechen. Der Validierungsprozess kann einige Minuten 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.

Synchrone Validierungen

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

Definieren Sie das Ablaufdatum von Verträgen, die mit dem Angebot erstellt wurden

Sie können die Katalog-API verwenden, um das Ablaufdatum von Vereinbarungen zu definieren, die mit dem Angebot in erstellt wurden AWS Marketplace.

Dieser Änderungstyp wirkt sich nicht auf bestehende Vereinbarungen aus.

Rufen Sie die StartChangeSet API-Operation mit dem UpdateValidityTerms Änderungstyp auf, um die Details zum Ablaufdatum von Vereinbarungen zu definieren, die mit dem Angebot erstellt wurden, wie im folgenden Beispiel gezeigt.

Anforderungssyntax

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "UpdateValidityTerms",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "Terms": [
          {
            "Type": "ValidityTerm",
            "AgreementDuration": "P12M",
            "AgreementStartDate": "2021-08-01",
            "AgreementEndDate": "2022-08-01"
          }
        ]
      }
    }
  ]
}

Geben Sie Informationen für die Felder an, um den UpdateValidityTerms Ä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. Dazu gehört auch die Überprüfung der Informationen, um sicherzustellen, dass sie den AWS Marketplace Richtlinien entsprechen. Der Validierungsprozess kann einige Minuten dauern.

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

Synchrone Validierungen

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

Details zum Zahlungsplan aktualisieren

Sie können die Katalog-API verwenden, um die Einzelheiten des Zahlungsplans für Ihr Angebot, z. B. den flexiblen Zahlungsplan, in zu aktualisieren AWS Marketplace.

Um die Details des Zahlungsplans für Ihr Angebot zu aktualisieren, rufen Sie den StartChangeSet API-Vorgang mit dem UpdatePaymentScheduleTerms Änderungstyp auf, wie im folgenden Beispiel gezeigt.

Anforderungssyntax

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "UpdatePaymentScheduleTerms",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "Terms": [
          {
            "Type": "PaymentScheduleTerm",
            "Schedule": [
              {
                "ChargeDate": "2021-12-01",
                "ChargeAmount": "200.00"
              },
              {
                "ChargeDate": "2022-03-01",
                "ChargeAmount": "250.00"
              }
            ]
          }
        ]
      }
    }
  ]
}

Geben Sie Informationen für die Felder ein, um den UpdatePaymentScheduleTerms Ä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. Dazu gehört auch die Überprüfung der Informationen, um sicherzustellen, dass sie den AWS Marketplace Richtlinien entsprechen. Der Validierungsprozess kann einige Minuten dauern.

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

Synchrone Validierungen

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

Verlängerungsoptionen ändern

Sie können die Katalog-API verwenden, um die Verlängerungsoptionen der Verträge zu steuern, die mit diesem Angebot in erstellt wurden AWS Marketplace.

Für Angebote, die über die Catalog API erstellt wurden, bleibt die automatische Verlängerung standardmäßig deaktiviert, bis Sie den UpdateRenewalTerms Änderungstyp aufrufen, um die automatische Verlängerung zu ermöglichen. Diese Änderung hat keine Auswirkungen auf bestehende Verträge.

Um die Verlängerungsoptionen der Verträge zu steuern, die mit diesem Angebot erstellt wurden, rufen Sie den StartChangeSet API-Vorgang mit dem UpdateRenewalTerms Änderungstyp auf, wie im folgenden Beispiel gezeigt.

Anforderungssyntax

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "UpdateRenewalTerms",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "Terms": [
          {
            "Type": "RenewalTerm"
          }
        ]
      }
    }
  ]
}

Geben Sie Informationen für die Felder ein, um den UpdateRenewalTerms Ä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. Dazu gehört auch die Überprüfung der Informationen, um sicherzustellen, dass sie den AWS Marketplace Richtlinien entsprechen. Der Validierungsprozess kann einige Minuten dauern.

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

Synchrone Validierungen

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

Veröffentlichen Sie ein Angebot

Sie können die Katalog-API verwenden, um die bei allen Arten von Aktualisierungen gesammelten Informationen zusammenzuführen und das Angebot anschließend zu veröffentlichen.

Angebote bleiben so lange im Draft Status, bis sie ReleaseOffer aufgerufen werden. Nachdem das Angebot veröffentlicht wurde, ist es in AWS Marketplace auffindbar.

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

Anforderungssyntax

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "ReleaseOffer",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {}
    }
  ]
}

Geben Sie Informationen für die Felder an, um den ReleaseOffer Ä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. Dazu gehört auch die Überprüfung der Informationen, um sicherzustellen, dass sie den AWS Marketplace Richtlinien entsprechen. Der Validierungsprozess kann einige Minuten dauern.

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

Synchrone Validierungen

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

Beschreiben Sie bestehende Angebotsdetails

Sie können die Katalog-API verwenden, um bestehende Angebotsdetails unter zu beschreiben AWS Marketplace.

Um bestehende Angebotsdetails zu beschreiben, rufen Sie den DescribeEntity API-Vorgang mit dem Offer@1.0 Entitätstyp auf, wie im folgenden Beispiel gezeigt.

Anforderungssyntax

GET /DescribeEntity?catalog=<Catalog>&entityId=<EntityId> HTTP/1.1

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

Syntax der Antwort

Die Antwort auf diese Anfrage enthält die Angebotsdetails und sieht wie folgt aus.

{
  "EntityType": "Offer@1.0",
  "EntityIdentifier": "offer-ad8EXAMPLE51@1",
  "EntityArn": "arn:aws:aws-marketplace:us-east-1:111122223333:AWSMarketplace/Offer/offer-ad8EXAMPLE51",
  "LastModifiedDate": "2021-03-10T21:57:16Z",
  "DetailsDocument": {
    "Id": "offer-3rEXAMPLErn",
    "State": "Released",
    "Name": "Test Offer",
    "Description": "Worldwide offer for Test Product",
    "PreExistingAgreement": {
      "AcquisitionChannel": "External",
      "PricingModel": "Contract"
    },
    "ProductId": "prod-ad8EXAMPLE51",
    "OfferSetId": "offerset-b3f9EXAMPLE27",
    "Terms": [
      {
        "Type": "SupportTerm",
        "RefundPolicy": "If you need to request a refund for software sold by Amazon Web Services, LLC, please contact AWS Customer Service."
      },
      {
        "Type": "LegalTerm",
        "Documents": [
          {
            "Type": "CustomEula",
            "Url": "https://s3.amazonaws.com/EULA/custom-eula-1234.txt"
          }
        ]
      },
      {
        "Type": "FreeTrialPricingTerm",
        "Duration": "P30D",
        "Grants": [
          {
            "DimensionKey": "m3.xlarge",
            "MaxQuantity": 10
          },
          {
            "DimensionKey": "m4.xlarge",
            "MaxQuantity": 10
          }
        ]
      },
      {
        "Type": "ConfigurableUpfrontPricingTerm",
        "CurrencyCode": "USD",
        "RateCards": [
          {
            "Selector": {
              "Type": "Duration",
              "Value": "P365D"
            },
            "RateCard": [
              {
                "DimensionKey": "m3.large",
                "Price": "300.00"
              },
              {
                "DimensionKey": "m4.xlarge",
                "Price": "400.00"
              }
            ],
            "Constraints": {
              "MultipleDimensionSelection": "Allowed",
              "QuantityConfiguration": "Allowed"
            }
          }
        ]
      },
      {
        "Type": "UsageBasedPricingTerm",
        "CurrencyCode": "USD",
        "RateCards": [
          {
            "RateCard": [
              {
                "DimensionKey": "m3.large",
                "Price": "0.10"
              },
              {
                "DimensionKey": "m4.xlarge",
                "Price": "0.20"
              }
            ]
          }
        ]
      },
      {
        "Type": "FixedUpfrontPricingTerm",
        "CurrencyCode": "USD",
        "Price": "200.00",
        "Grants": [
          {
            "DimensionKey": "Users",
            "MaxQuantity": 10
          }
        ]
      },
      {
        "Type": "RecurringPaymentTerm",
        "CurrencyCode": "USD",
        "BillingPeriod": "Monthly",
        "Price": "100.0"
      },
      {
        "Type": "PaymentScheduleTerm",
        "CurrencyCode": "USD",
        "Schedule": [
          {
            "ChargeDate": "2020-12-01T00:00:00.000Z",
            "ChargeAmount": "1000.00"
          },
          {
            "ChargeDate": "2021-06-15T00:00:00.000Z",
            "ChargeAmount": "1250.00"
          }
        ]
      },
      {
        "Type": "ByolPricingTerm"
      },
      {
        "Type": "RenewalTerm"
      }
    ],
    "Rules": [
      {
        "Type": "TargetingRule",
        "PositiveTargeting": {
          "CountryCodes": [
            "US",
            "CA"
          ],
          "BuyerAccounts": [
            "444455556666"
          ]
        },
        "NegativeTargeting": {
          "CountryCodes": [
            "XX"
          ]
        }
      },
      {
        "Type": "AvailabilityRule",
        "AvailabilityEndDate": "2024-08-30T01:56:03.000Z"
      }
    ]
  }
}

Im Folgenden finden Sie Informationen zu den Feldern, die Sie in der DescribeEntity Antwort sehen.