AWS Marketplace API 參考已重組。如需支援的 API 操作的詳細資訊，請參閱 AWS Marketplace API 參考。

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

使用 AWS MarketplaceAPIs處理私有優惠

您可以使用 AWS Marketplace Catalog API自動化使用 優惠的任務。

雖然產品說明銷售內容AWS Marketplace，但優惠說明產品如何購買和使用的條款和規則。 AWS Marketplace產品可以有多個由不同賣家銷售的優惠。不過，每個AWS Marketplace優惠只能針對一個產品建立。優惠包含雙方之間的一系列協議條款。接受的優惠條款會翻譯成協議，做為交易的證明。

有兩種類型的優惠：

請參閱下列資源：

下列主題說明如何使用目錄 API 來建立和更新優惠：

建立優惠

您可以使用 Catalog 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變更類型的欄位資訊：

回應語法

為您的請求建立變更集。對此請求的回應為您提供變更集ChangeSetIdChangeSetArn的 和 ，如下所示。

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

變更請求會新增至佇列並進行處理。

您可以透過 檢查請求的狀態AWS Marketplace 管理入口網站，或使用 API 操作直接透過目錄 DescribeChangeSet API。

如果 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變更類型的欄位資訊：

回應語法

為您的請求建立變更集。對此請求的回應為您提供變更集ChangeSetIdChangeSetArn的 和 ，如下所示。

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

變更請求會新增至佇列並進行處理。

您可以透過 檢查請求的狀態AWS Marketplace 管理入口網站，或使用 API 操作直接透過目錄 DescribeChangeSet API。

同步驗證

下列結構描述驗證專屬於 中的CreateReplacementOffer動作AWS Marketplace Catalog API。這些驗證會在您呼叫 時執行StartChangeSet。如果請求不符合下列要求，它會失敗並顯示 HTTP 回應。

非同步錯誤

下列錯誤專屬於 中的CreateReplacementOffer動作AWS Marketplace Catalog API。當您在處理變更集DescribeChangeSet之後呼叫 時，會傳回這些錯誤。如需使用 DescribeChangeSet 取得變更請求狀態的詳細資訊，請參閱 使用變更集。

更新優惠資訊

您可以使用 Catalog 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變更類型的欄位資訊：

回應語法

為您的請求建立變更集。對此請求的回應為您提供變更集ChangeSetIdChangeSetArn的 和 ，如下所示。

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

變更請求會新增至佇列並進行處理。這包括驗證資訊，以確保其符合AWS Marketplace準則。驗證程序可能需要幾分鐘的時間。

您可以透過 檢查請求的狀態AWS Marketplace 管理入口網站，或使用 API 操作直接透過目錄 DescribeChangeSet API。

同步驗證

下列結構描述驗證專屬於 中的UpdateInformation動作AWS Marketplace Catalog API。這些驗證會在您呼叫 時執行StartChangeSet。如果請求不符合下列要求，它會失敗並顯示 HTTP 回應。

非同步錯誤

下列錯誤專屬於 中的UpdateInformation動作AWS Marketplace Catalog API。當您在處理變更集DescribeChangeSet之後呼叫 時，會傳回這些錯誤。如需使用 DescribeChangeSet 取得變更請求狀態的詳細資訊，請參閱 使用變更集。

更新目標組態

您可以使用 Catalog 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變更類型的欄位資訊：

回應語法

為您的請求建立變更集。對此請求的回應為您提供變更集ChangeSetIdChangeSetArn的 和 ，如下所示。

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

變更請求會新增至佇列並進行處理。這包括驗證資訊，以確保其符合AWS Marketplace準則。驗證程序可能需要幾分鐘的時間。

您可以透過 檢查請求的狀態AWS Marketplace 管理入口網站，或使用 API 操作直接透過目錄 DescribeChangeSet API。

同步驗證

下列結構描述驗證專屬於 中的UpdateTargeting動作AWS Marketplace Catalog API。這些驗證會在您呼叫 時執行StartChangeSet。如果請求不符合下列要求，它會失敗並顯示 HTTP 回應。

非同步錯誤

下列錯誤專屬於 中的UpdateTargeting動作AWS Marketplace Catalog API。當您在處理變更集DescribeChangeSet之後呼叫 時，會傳回這些錯誤。如需使用 DescribeChangeSet 取得變更請求狀態的詳細資訊，請參閱 使用變更集。

更新退款政策

您可以使用 Catalog 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變更類型的欄位資訊：

回應語法

為您的請求建立變更集。對此請求的回應為您提供變更集ChangeSetIdChangeSetArn的 和 ，如下所示。

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

變更請求會新增至佇列並進行處理。這包括驗證資訊，以確保其符合AWS Marketplace準則。驗證程序可能需要幾分鐘的時間。

您可以透過 檢查請求的狀態AWS Marketplace 管理入口網站，或使用 API 操作直接透過目錄 DescribeChangeSet API。

同步驗證

下列結構描述驗證專屬於 中的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變更類型的欄位資訊：

回應語法

為您的請求建立變更集。對此請求的回應為您提供變更集ChangeSetIdChangeSetArn的 和 ，如下所示。

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

變更請求會新增至佇列並進行處理。這包括驗證資訊，以確保其符合AWS Marketplace準則。驗證程序可能需要幾分鐘的時間。

您可以透過 檢查請求的狀態AWS Marketplace 管理入口網站，或使用 API 操作直接透過目錄 DescribeChangeSet API。

同步驗證

下列結構描述驗證專屬於 中的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變更類型的欄位資訊：

回應語法

為您的請求建立變更集。對此請求的回應為您提供變更集ChangeSetIdChangeSetArn的 和 ，如下所示。

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

變更請求會新增至佇列並進行處理。這包括驗證資訊，以確保其符合AWS Marketplace準則。驗證程序可能需要幾分鐘的時間。

您可以透過 檢查請求的狀態AWS Marketplace 管理入口網站，或使用 API 操作直接透過目錄 DescribeChangeSet API。

同步驗證

下列結構描述驗證專屬於 中的UpdatePricingTerms動作AWS Marketplace Catalog API。這些驗證會在您呼叫 時執行StartChangeSet。如果請求不符合下列要求，它會失敗並顯示 HTTP 回應。

非同步錯誤

下列錯誤專屬於 中的UpdatePricingTerms動作AWS Marketplace Catalog API。當您在處理變更集DescribeChangeSet之後呼叫 時，會傳回這些錯誤。如需使用 DescribeChangeSet 取得變更請求狀態的詳細資訊，請參閱 使用變更集。

更新優惠的可探索性

您可以使用 Catalog 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準則。驗證程序可能需要幾分鐘的時間。您可以透過 AWS Marketplace 管理入口網站或在目錄 API 中使用 DescribeChangeSet動作來檢查請求的狀態。

同步驗證

下列結構描述驗證專屬於 中的UpdateAvailability動作AWS Marketplace Catalog API。這些驗證會在您呼叫 時執行StartChangeSet。如果請求不符合下列要求，它會失敗並顯示 HTTP 回應。

非同步錯誤

下列錯誤專屬於 中的UpdateAvailability動作AWS Marketplace Catalog API。當您在處理變更集DescribeChangeSet之後呼叫 時，會傳回這些錯誤。如需使用 DescribeChangeSet取得變更請求狀態的詳細資訊，請參閱 使用變更集。

定義使用優惠建立之協議的過期日期

您可以使用 Catalog 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變更類型的欄位資訊：

回應語法

為您的請求建立變更集。對此請求的回應為您提供變更集ChangeSetIdChangeSetArn的 和 ，如下所示。

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

變更請求會新增至佇列並進行處理。這包括驗證資訊，以確保其符合AWS Marketplace準則。驗證程序可能需要幾分鐘的時間。

您可以透過 檢查請求的狀態AWS Marketplace 管理入口網站，或使用 API 操作直接透過目錄 DescribeChangeSet API。

同步驗證

下列結構描述驗證專屬於 中的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變更類型的欄位資訊：

回應語法

為您的請求建立變更集。對此請求的回應為您提供變更集ChangeSetIdChangeSetArn的 和 ，如下所示。

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

變更請求會新增至佇列並進行處理。這包括驗證資訊，以確保其符合AWS Marketplace準則。驗證程序可能需要幾分鐘的時間。

您可以透過 檢查請求的狀態AWS Marketplace 管理入口網站，或使用 API 操作直接透過目錄 DescribeChangeSet API。

同步驗證

下列結構描述驗證專屬於 中的UpdatePaymentScheduleTerms動作AWS Marketplace Catalog API。這些驗證會在您呼叫 時執行StartChangeSet。如果請求不符合下列要求，它會失敗並顯示 HTTP 回應。

非同步錯誤

下列錯誤專屬於 中的UpdatePaymentScheduleTerms動作AWS Marketplace Catalog API。當您在處理變更集DescribeChangeSet之後呼叫 時，會傳回這些錯誤。如需使用 DescribeChangeSet 取得變更請求狀態的詳細資訊，請參閱 使用變更集。

修改續約選項

您可以使用目錄 API 來控制使用此優惠建立之協議的續約選項AWS Marketplace。

對於透過目錄 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變更類型的欄位資訊：

回應語法

為您的請求建立變更集。對此請求的回應為您提供變更集ChangeSetIdChangeSetArn的 和 ，如下所示。

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

變更請求會新增至佇列並進行處理。這包括驗證資訊，以確保其符合AWS Marketplace準則。驗證程序可能需要幾分鐘的時間。

您可以透過 檢查請求的狀態AWS Marketplace 管理入口網站，或使用 API 操作直接透過目錄 DescribeChangeSet API。

同步驗證

下列結構描述驗證專屬於 中的UpdateRenewalTerms動作AWS Marketplace Catalog API。這些驗證會在您呼叫 時執行StartChangeSet。如果請求不符合下列要求，它會失敗並顯示 HTTP 回應。

非同步錯誤

下列錯誤專屬於 中的UpdateRenewalTerms動作AWS Marketplace Catalog API。當您在處理變更集DescribeChangeSet之後呼叫 時，會傳回這些錯誤。如需使用 DescribeChangeSet取得變更請求狀態的詳細資訊，請參閱 使用變更集。

發佈優惠

您可以使用目錄 API 來合併從所有更新變更類型收集的資訊，然後發佈優惠。

在ReleaseOffer呼叫 之前，優惠會保持 Draft 狀態。優惠發佈後，即可探索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變更類型的欄位資訊：

回應語法

為您的請求建立變更集。對此請求的回應為您提供變更集ChangeSetIdChangeSetArn的 和 ，如下所示。

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

變更請求會新增至佇列並進行處理。這包括驗證資訊，以確保其符合AWS Marketplace準則。驗證程序可能需要幾分鐘的時間。

您可以透過 檢查請求的狀態AWS Marketplace 管理入口網站，或使用 API 操作直接透過目錄 DescribeChangeSet API。

同步驗證

下列結構描述驗證專屬於 中的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"
      }
    ],
    "Rules": [
      {
        "Type": "TargetingRule",
        "PositiveTargeting": {
          "CountryCodes": [
            "US",
            "CA"
          ],
          "BuyerAccounts": [
            "444455556666"
          ]
        },
        "NegativeTargeting": {
          "CountryCodes": [
            "XX"
          ]
        }
      },
      {
        "Type": "AvailabilityRule",
        "AvailabilityEndDate": "2024-08-30T01:56:03.000Z"
      }
    ]
  }
}

以下是您在DescribeEntity回應中看到的欄位的相關資訊。