对 AWS Marketplace API 参考进行了重组。有关支持的 API 操作的更多信息，请参阅 AWS 市场 API 参考。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

使用以下方式处理私人优惠 AWS Marketplace API

您可以使用 AWS Marketplace Catalog API 来自动执行处理选件的任务。

虽然产品描述了销售的内容 AWS Marketplace，但优惠描述了如何购买和消费产品的条款和规则。 AWS Marketplace 产品可以有不同卖家出售的多个报价。但是，每个 AWS Marketplace 报价只能为一种产品创建。报价包含双方之间的一系列协议条款。接受的要约条款被翻译成协议，作为交易的证据。

优惠有两种类型：

请参阅以下资源：

以下主题介绍如何使用目录 API 来创建和更新报价：

创建报价

您可以使用目录 API 在中创建新报价 AWS Marketplace。如果您的请求成功处理，则 AWS Marketplace Catalog API 会创建一个Draft，这是一个不完整的报价，买家看不见。要完成报价，请使用Update更改类型。报价完成后，使用ReleaseOffer更改类型来创建和发布报价。发布报价会对其进行验证，并使其对买家可见。 AWS Marketplace

要创建新报价，请使用CreateOffer更改类型调用 StartChangeSet API 操作，如以下示例所示。

请求语法

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"
      }
    }
  ]
}

为字段提供信息以添加CreateOffer更改类型：

响应语法

系统会为您的请求创建变更集。对该请求的响应为您提供了变更集的和，如下所示。ChangeSetId ChangeSetArn

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

变更请求将添加到队列中并进行处理。

您可以通过查看请求的状态 AWS Marketplace 管理门户，也可以使用 API 操作直接通过目录 API 来检查请求的DescribeChangeSet状态。

如果Status是SUCCEEDED，则生成一个新OfferId的。

响应看起来与以下内容类似。

{
  "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": []
    }
  ]
}

同步验证

以下架构验证特定于中的CreateOffer AWS Marketplace Catalog API操作。这些验证是在您致电StartChangeSet时执行的。如果请求不满足以下要求，它将失败并发出 HTTP 响应。

异步错误

以下错误特定于中的CreateOffer操作 AWS Marketplace Catalog API。当您在处理变更集DescribeChangeSet后调用时，会返回这些错误。有关使用DescribeChangeSet获取变更请求状态的更多信息，请参阅使用变更集。

创建替代报价

您可以使用目录 API 在中创建替代报价（也称为基于协议的报价）。 AWS Marketplace

如果您的请求已成功处理，系统 AWS Marketplace Catalog API 将为您生成一个处于Draft状态的报价，这是一个不完整的报价，买家无法在上看到该报价 AWS Marketplace。您将使用Update变更类型来完成报价。报价完成后，您将使用ReleaseOffer更改类型来完成报价创建流程并发布报价，这将验证整个报价，让买家看到您的报价 AWS Marketplace。从那里，买方可以选择接受换货报价或继续根据原始协议经营。

要创建替代报价，请使用CreateReplacementOffer更改类型调用 StartChangeSet API 操作并提供先前存在的协议 ID，如以下示例所示。

请求语法

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"
      }
    }
  ]
}

为字段提供信息以添加CreateReplacementOffer更改类型：

响应语法

系统会为您的请求创建变更集。对该请求的响应为您提供了变更集的和，如下所示。ChangeSetId ChangeSetArn

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

变更请求将添加到队列中并进行处理。

您可以通过查看请求的状态 AWS Marketplace 管理门户，也可以使用 API 操作直接通过目录 API 来检查请求的DescribeChangeSet状态。

同步验证

以下架构验证特定于中的CreateReplacementOffer AWS Marketplace Catalog API操作。这些验证是在您致电StartChangeSet时执行的。如果请求不满足以下要求，它将失败并发出 HTTP 响应。

异步错误

以下错误特定于中的CreateReplacementOffer操作 AWS Marketplace Catalog API。当您在处理变更集DescribeChangeSet后调用时，会返回这些错误。有关使用DescribeChangeSet获取变更请求状态的更多信息，请参阅使用变更集。

更新报价信息

您可以使用目录 API 更新中的报价信息 AWS Marketplace。

要更新优惠信息，请使用UpdateInformation更改类型调用 StartChangeSet API 操作，如以下示例所示。所有其他信息将保持不变。

请求语法

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"
        }
      }
    }
  ]
}

为字段提供信息以添加UpdateInformation更改类型：

响应语法

系统会为您的请求创建变更集。对该请求的响应为您提供了变更集的和，如下所示。ChangeSetId ChangeSetArn

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

变更请求将添加到队列中并进行处理。这包括验证信息以确保其符合 AWS Marketplace 准则。验证过程可能需要几分钟。

您可以通过查看请求的状态 AWS Marketplace 管理门户，也可以使用 API 操作直接通过目录 API 来检查请求的DescribeChangeSet状态。

同步验证

以下架构验证特定于中的UpdateInformation AWS Marketplace Catalog API操作。这些验证是在您致电StartChangeSet时执行的。如果请求不满足以下要求，它将失败并发出 HTTP 响应。

异步错误

以下错误特定于中的UpdateInformation操作 AWS Marketplace Catalog API。当您在处理变更集DescribeChangeSet后调用时，会返回这些错误。有关使用DescribeChangeSet获取变更请求状态的更多信息，请参阅使用变更集。

更新定位配置

您可以使用目录 API 在中更新报价的定位配置 AWS Marketplace。

所有未包含在最新请求中的现有定位选项，将从报价中移除。

要更新报价的定位配置，请使用UpdateTargeting更改类型调用 StartChangeSet API 操作，如以下示例所示。

请求语法

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"
          ]
        }
      }
    }
  ]
}

为字段提供信息以添加UpdateTargeting更改类型：

响应语法

系统会为您的请求创建变更集。对该请求的响应为您提供了变更集的和，如下所示。ChangeSetId ChangeSetArn

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

变更请求将添加到队列中并进行处理。这包括验证信息以确保其符合 AWS Marketplace 准则。验证过程可能需要几分钟。

您可以通过查看请求的状态 AWS Marketplace 管理门户，也可以使用 API 操作直接通过目录 API 来检查请求的DescribeChangeSet状态。

同步验证

以下架构验证特定于中的UpdateTargeting AWS Marketplace Catalog API操作。这些验证是在您致电StartChangeSet时执行的。如果请求不满足以下要求，它将失败并发出 HTTP 响应。

异步错误

以下错误特定于中的UpdateTargeting操作 AWS Marketplace Catalog API。当您在处理变更集DescribeChangeSet后调用时，会返回这些错误。有关使用DescribeChangeSet获取变更请求状态的更多信息，请参阅使用变更集。

更新退款政策

您可以使用目录 API 在中更新报价的退款政策 AWS Marketplace。

此变更不影响现有协议。最新请求中未包含的支持条款将从优惠中删除。

要更新退款政策，请使用UpdateSupportTerms更改类型调用 StartChangeSet API 操作，如以下示例所示。

请求语法

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"
          }
        ]
      }
    }
  ]
}

为字段提供信息以添加UpdateSupportTerms更改类型：

响应语法

系统会为您的请求创建变更集。对该请求的响应为您提供了变更集的和，如下所示。ChangeSetId ChangeSetArn

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

变更请求将添加到队列中并进行处理。这包括验证信息以确保其符合 AWS Marketplace 准则。验证过程可能需要几分钟。

您可以通过查看请求的状态 AWS Marketplace 管理门户，也可以使用 API 操作直接通过目录 API 来检查请求的DescribeChangeSet状态。

同步验证

以下架构验证特定于中的UpdateSupportTerms AWS Marketplace Catalog API操作。这些验证是在您致电StartChangeSet时执行的。如果请求不满足以下要求，它将失败并发出 HTTP 响应。

异步错误

以下错误特定于中的UpdateSupportTerms操作 AWS Marketplace Catalog API。当您在处理变更集DescribeChangeSet后调用时，会返回这些错误。有关使用DescribeChangeSet获取变更请求状态的更多信息，请参阅使用变更集。

更新法律资源

您可以使用目录 API 替换现有的法律文档，例如最终用户许可协议 (EULA)。最新申请中未包含的法律条款将从优惠中删除。

要更新报价的法律资源，请调用UpdateLegalTerms变更类型StartChangeSet的 API 操作，如以下示例所示。

请求语法

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"
              }
            ]
          }
        ]
      }
    }
  ]
}

为字段提供信息以添加UpdateLegalTerms更改类型：

响应语法

系统会为您的请求创建变更集。对该请求的响应为您提供了变更集的和，如下所示。ChangeSetId ChangeSetArn

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

变更请求将添加到队列中并进行处理。这包括验证信息以确保其符合 AWS Marketplace 准则。验证过程可能需要几分钟。

您可以通过查看请求的状态 AWS Marketplace 管理门户，也可以使用 API 操作直接通过目录 API 来检查请求的DescribeChangeSet状态。

同步验证

以下架构验证特定于中的UpdateLegalTerms AWS Marketplace Catalog API操作。这些验证是在您致电StartChangeSet时执行的。如果请求不满足以下要求，它将失败并发出 HTTP 响应。

异步错误

以下错误特定于中的UpdateLegalTerms操作 AWS Marketplace Catalog API。当您在处理变更集DescribeChangeSet后调用时，会返回这些错误。有关使用DescribeChangeSet获取变更请求状态的更多信息，请参阅使用变更集。

更新定价

您可以使用目录 API 完全替换现有定价条款。最新请求中未包含的定价条款将从报价中删除。

要更新报价的定价条款，请调用UpdatePricingTerms变更类型StartChangeSet的 API 操作，如以下示例所示。

请求语法

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
              }
            ]
          }
        ]
      }
    }
  ]
}

为字段提供信息以添加UpdatePricingTerms更改类型：

响应语法

系统会为您的请求创建变更集。对该请求的响应为您提供了变更集的和，如下所示。ChangeSetId ChangeSetArn

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

变更请求将添加到队列中并进行处理。这包括验证信息以确保其符合 AWS Marketplace 准则。验证过程可能需要几分钟。

您可以通过查看请求的状态 AWS Marketplace 管理门户，也可以使用 API 操作直接通过目录 API 来检查请求的DescribeChangeSet状态。

同步验证

以下架构验证特定于中的UpdatePricingTerms AWS Marketplace Catalog API操作。这些验证是在您致电StartChangeSet时执行的。如果请求不满足以下要求，它将失败并发出 HTTP 响应。

异步错误

以下错误特定于中的UpdatePricingTerms操作 AWS Marketplace Catalog API。当您在处理变更集DescribeChangeSet后调用时，会返回这些错误。有关使用DescribeChangeSet获取变更请求状态的更多信息，请参阅使用变更集。

更新优惠的可发现性

您可以使用目录 API 来控制您的报价在中的 AWS Marketplace可见性。

您可以选择将来的特定日期设置为限制报价的可曝光度，也可以选择在过去将报价过期。UpdateAvailability变更类型不影响现有协议。

要控制报价的可发现性，请使用UpdateAvailability变更类型调用 StartChangeSet API 操作，如以下示例所示。

请求语法

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"
      }
    }
  ]
}

为字段提供信息以添加UpdateAvailability更改类型：

系统会为您的请求创建变更集。对该请求的响应为您提供了变更集的 ID 和 ARN，如下所示。

响应语法

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

变更请求将添加到队列中并进行处理。它包括验证信息以确保其符合 AWS Marketplace 准则。验证过程可能需要几分钟。您可以通过或在 Catalog API 中使用DescribeChangeSet操作检查请求的状态。 AWS Marketplace 管理门户

同步验证

以下架构验证特定于中的UpdateAvailability AWS Marketplace Catalog API操作。这些验证是在您致电StartChangeSet时执行的。如果请求不满足以下要求，它将失败并发出 HTTP 响应。

异步错误

以下错误特定于中的UpdateAvailability操作 AWS Marketplace Catalog API。当您在处理变更集DescribeChangeSet后调用时，会返回这些错误。有关使用DescribeChangeSet获取变更请求状态的更多详细信息，请参阅使用变更集。

定义使用优惠创建的协议的到期日期

您可以使用目录 API 来定义使用中的报价创建的协议的到期日期详细信息 AWS Marketplace。

这种变更类型不会影响现有协议。

要定义使用优惠创建的协议的到期日期详细信息，请调用UpdateValidityTerms变更类型StartChangeSet的 API 操作，如以下示例所示。

请求语法

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"
          }
        ]
      }
    }
  ]
}

为字段提供信息以添加UpdateValidityTerms更改类型：

响应语法

系统会为您的请求创建变更集。对该请求的响应为您提供了变更集的和，如下所示。ChangeSetId ChangeSetArn

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

变更请求将添加到队列中并进行处理。这包括验证信息以确保其符合 AWS Marketplace 准则。验证过程可能需要几分钟。

您可以通过查看请求的状态 AWS Marketplace 管理门户，也可以使用 API 操作直接通过目录 API 来检查请求的DescribeChangeSet状态。

同步验证

以下架构验证特定于中的UpdateValidityTerms AWS Marketplace Catalog API操作。这些验证是在您致电StartChangeSet时执行的。如果请求不满足以下要求，它将失败并发出 HTTP 响应。

异步错误

以下错误特定于中的UpdateValidityTerms操作 AWS Marketplace Catalog API。当您在处理变更集DescribeChangeSet后调用时，会返回这些错误。有关使用DescribeChangeSet获取变更请求状态的更多信息，请参阅使用变更集。

更新付款计划详情

您可以在中使用目录 API 更新报价的付款计划详细信息，例如灵活的付款时间表 AWS Marketplace。

要更新报价的付款计划详情，请调用UpdatePaymentScheduleTerms变更类型StartChangeSet的 API 操作，如以下示例所示。

请求语法

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"
              }
            ]
          }
        ]
      }
    }
  ]
}

为字段提供信息以添加UpdatePaymentScheduleTerms更改类型：

响应语法

系统会为您的请求创建变更集。对该请求的响应为您提供了变更集的和，如下所示。ChangeSetId ChangeSetArn

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

变更请求将添加到队列中并进行处理。这包括验证信息以确保其符合 AWS Marketplace 准则。验证过程可能需要几分钟。

您可以通过查看请求的状态 AWS Marketplace 管理门户，也可以使用 API 操作直接通过目录 API 来检查请求的DescribeChangeSet状态。

同步验证

以下架构验证特定于中的UpdatePaymentScheduleTerms AWS Marketplace Catalog API操作。这些验证是在您致电StartChangeSet时执行的。如果请求不满足以下要求，它将失败并发出 HTTP 响应。

异步错误

以下错误特定于中的UpdatePaymentScheduleTerms操作 AWS Marketplace Catalog API。当您在处理变更集DescribeChangeSet后调用时，会返回这些错误。有关使用DescribeChangeSet获取变更请求状态的更多信息，请参阅使用变更集。

更新净付款条款

您可以使用目录 API 来设置报价的净付款条款 AWS Marketplace。净付款期限是指您指定发票开具后到期付款的天数。

要设置报价的净付款期限，请使用UpdateNetPaymentTerms更改类型调用 StartChangeSet API 操作，如以下示例所示。

请求语法

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "UpdateNetPaymentTerms",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "Terms": [
          {
            "Type": "NetPaymentTerm",
            "PaymentDuePeriod": "P30D"
          }
        ]
      }
    }
  ]
}

为字段提供信息以添加UpdateNetPaymentTerms更改类型：

响应语法

系统会为您的请求创建变更集。对该请求的响应为您提供了变更集的和，如下所示。ChangeSetId ChangeSetArn

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

变更请求将添加到队列中并进行处理。这包括验证信息以确保其符合 AWS Marketplace 准则。验证过程可能需要几分钟。

您可以通过查看请求的状态 AWS Marketplace 管理门户，也可以使用 API 操作直接通过目录 API 来检查请求的DescribeChangeSet状态。

同步验证

以下架构验证特定于中的UpdateNetPaymentTerms AWS Marketplace Catalog API操作。这些验证是在您致电StartChangeSet时执行的。如果请求不满足以下要求，它将失败并发出 HTTP 响应。

异步错误

以下错误特定于中的UpdateNetPaymentTerms操作 AWS Marketplace Catalog API。当您在处理变更集DescribeChangeSet后调用时，会返回这些错误。有关使用DescribeChangeSet获取变更请求状态的更多信息，请参阅使用变更集。

修改续订选项

您可以使用目录 API 来控制在中使用此优惠创建的协议的续订选项 AWS Marketplace。

对于通过 Catalog API 创建的报价，默认情况下自动续订将保持禁用状态，直到您调用UpdateRenewalTerms变更类型以允许自动续订为止。此变更不影响现有协议。

要控制使用此优惠创建的协议的续订选项，请使用UpdateRenewalTerms更改类型调用 StartChangeSet API 操作，如以下示例所示。

请求语法

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"
          }
        ]
      }
    }
  ]
}

为字段提供信息以添加UpdateRenewalTerms更改类型：

响应语法

系统会为您的请求创建变更集。对该请求的响应为您提供了变更集的和，如下所示。ChangeSetId ChangeSetArn

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

变更请求将添加到队列中并进行处理。这包括验证信息以确保其符合 AWS Marketplace 准则。验证过程可能需要几分钟。

您可以通过查看请求的状态 AWS Marketplace 管理门户，也可以使用 API 操作直接通过目录 API 来检查请求的DescribeChangeSet状态。

同步验证

以下架构验证特定于中的UpdateRenewalTerms AWS Marketplace Catalog API操作。这些验证是在您致电StartChangeSet时执行的。如果请求不满足以下要求，它将失败并发出 HTTP 响应。

异步错误

以下错误特定于中的UpdateRenewalTerms操作 AWS Marketplace Catalog API。当您在处理变更集DescribeChangeSet后调用时，会返回这些错误。有关使用DescribeChangeSet获取变更请求状态的更多详细信息，请参阅使用变更集。

发布报价

您可以使用 Catalog API 合并从所有更新变更类型收集的信息，然后发布报价。

在发出通知之前，Draft报价将保持ReleaseOffer不变。优惠发布后，可以在中 AWS Marketplace找到。

要发布报价，请调用ReleaseOffer变更类型StartChangeSet的 API 操作，如以下示例所示。

请求语法

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

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

为字段提供信息以添加ReleaseOffer更改类型：

响应语法

系统会为您的请求创建变更集。对该请求的响应为您提供了变更集的和，如下所示。ChangeSetId ChangeSetArn

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

变更请求将添加到队列中并进行处理。这包括验证信息以确保其符合 AWS Marketplace 准则。验证过程可能需要几分钟。

您可以通过查看请求的状态 AWS Marketplace 管理门户，也可以使用 API 操作直接通过目录 API 来检查请求的DescribeChangeSet状态。

同步验证

以下架构验证特定于中的ReleaseOffer AWS Marketplace Catalog API操作。这些验证是在您致电StartChangeSet时执行的。如果请求不满足以下要求，它将失败并发出 HTTP 响应。

异步错误

以下错误特定于中的ReleaseOffer操作 AWS Marketplace Catalog API。当您在处理变更集DescribeChangeSet后调用时，会返回这些错误。有关使用DescribeChangeSet获取变更请求状态的更多信息，请参阅使用变更集。

描述现有优惠详情

您可以使用目录 API 来描述中的现有优惠详情 AWS Marketplace。

要描述现有优惠详情，请使用Offer@1.0实体类型调用 DescribeEntity API 操作，如以下示例所示。

请求语法

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

为字段提供信息以添加DescribeEntity更改类型：

响应语法

对该请求的回复会向您提供报价详情，如下所示。

{
  "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"
      },
      {
        "Type": "NetPaymentTerm",
        "PaymentDuePeriod": "P30D"
      }
    ],
    "Rules": [
      {
        "Type": "TargetingRule",
        "PositiveTargeting": {
          "CountryCodes": [
            "US",
            "CA"
          ],
          "BuyerAccounts": [
            "444455556666"
          ]
        },
        "NegativeTargeting": {
          "CountryCodes": [
            "XX"
          ]
        }
      },
      {
        "Type": "AvailabilityRule",
        "AvailabilityEndDate": "2024-08-30T01:56:03.000Z"
      }
    ]
  }
}

以下是有关您在DescribeEntity响应中看到的字段的信息。