AWS Marketplace API リファレンスが再構築されました。サポートされている API オペレーションの詳細については、AWS Marketplace API リファレンスを参照してください。

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

AWS MarketplaceAPIs

を使用してAWS Marketplace Catalog API、オファーを操作するタスクを自動化できます。

製品では販売内容が説明されていますがAWS Marketplace、このオファーでは、製品の購入方法と消費方法の利用規約が説明されています。 AWS Marketplace製品では、さまざまな販売者が複数のオファーを販売できます。ただし、各AWS Marketplaceオファーは 1 つの製品に対してのみ作成できます。オファーには、2 者間の契約条項のコレクションが含まれています。承諾されたオファー条件は、取引の証明として契約に変換されます。

オファーには 2 つのタイプがあります。

以下のリソースを参照してください。

以下のトピックでは、 Catalog 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 変更タイプを追加するフィールドの情報を入力します。

レスポンスの構文

リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セットChangeSetArnの ChangeSetIdと を提供し、次のようになります。

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

変更リクエストがキューに追加され、処理されます。

リクエストのステータスは、 を通じてAWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog 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 を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください変更セットの使用。

代替オファーを作成する

Catalog API を使用して、 で代替オファー (契約ベースのオファーとも呼ばれます) を作成できますAWS Marketplace。

リクエストが正常に処理されると、 は AWS Marketplace Catalog APIDraft状態のオファーを生成します。これは不完全なオファーであり、購入者には表示されません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 変更タイプを追加するフィールドの情報を入力します。

レスポンスの構文

リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セットChangeSetArnの ChangeSetIdと を提供し、次のようになります。

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

変更リクエストがキューに追加され、処理されます。

リクエストのステータスは、 を通じてAWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog 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 変更タイプを追加するフィールドの情報を入力します。

レスポンスの構文

リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セットChangeSetArnの ChangeSetIdと を提供し、次のようになります。

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

変更リクエストがキューに追加され、処理されます。これには、AWS Marketplaceガイドラインを満たしていることを確認するための情報の検証が含まれます。検証プロセスには数分かかる場合があります。

リクエストのステータスは、 を通じてAWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog 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 変更タイプを追加するフィールドの情報を入力します。

レスポンスの構文

リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セットChangeSetArnの ChangeSetIdと を提供し、次のようになります。

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

変更リクエストがキューに追加され、処理されます。これには、AWS Marketplaceガイドラインを満たしていることを確認するための情報の検証が含まれます。検証プロセスには数分かかる場合があります。

リクエストのステータスは、 を通じてAWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog DescribeChangeSet API から直接確認できます。

同期検証

以下のスキーマ検証は、 のUpdateTargetingアクションに固有ですAWS Marketplace Catalog API。これらの検証は、 を呼び出すときに実行されますStartChangeSet。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。

非同期エラー

以下のエラーは、 のUpdateTargetingアクションに固有のものですAWS Marketplace Catalog API。これらのエラーは、変更セットの処理DescribeChangeSet後に を呼び出すと返されます。DescribeChangeSet を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください変更セットの使用。

返金ポリシーを更新する

Catalog API を使用して、オファーの返金ポリシーを更新できますAWS Marketplace。

この変更は既存の契約には影響しません。最新のリクエストに含まれていないサポート条件は、オファーから削除されます。

返金ポリシーを更新するには、次の例に示すように、UpdateSupportTermsAPI StartChangeSetオペレーションを変更タイプで呼び出します。

リクエストの構文

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 変更タイプを追加するフィールドの情報を入力します。

レスポンスの構文

リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セットChangeSetArnの ChangeSetIdと を提供し、次のようになります。

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

変更リクエストがキューに追加され、処理されます。これには、AWS Marketplaceガイドラインを満たしていることを確認するための情報の検証が含まれます。検証プロセスには数分かかる場合があります。

リクエストのステータスは、 を通じてAWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog DescribeChangeSet API から直接確認できます。

同期検証

以下のスキーマ検証は、 のUpdateSupportTermsアクションに固有ですAWS Marketplace Catalog API。これらの検証は、 を呼び出すときに実行されますStartChangeSet。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。

非同期エラー

以下のエラーは、 のUpdateSupportTermsアクションに固有のものですAWS Marketplace Catalog API。これらのエラーは、変更セットの処理DescribeChangeSet後に を呼び出すと返されます。DescribeChangeSet を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください変更セットの使用。

法的リソースの更新

Catalog 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 変更タイプを追加するフィールドの情報を入力します。

レスポンスの構文

リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セットChangeSetArnの ChangeSetIdと を提供し、次のようになります。

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

変更リクエストがキューに追加され、処理されます。これには、AWS Marketplaceガイドラインを満たしていることを確認するための情報の検証が含まれます。検証プロセスには数分かかる場合があります。

リクエストのステータスは、 を通じてAWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog DescribeChangeSet API から直接確認できます。

同期検証

以下のスキーマ検証は、 のUpdateLegalTermsアクションに固有ですAWS Marketplace Catalog API。これらの検証は、 を呼び出すときに実行されますStartChangeSet。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。

非同期エラー

以下のエラーは、 のUpdateLegalTermsアクションに固有のものですAWS Marketplace Catalog API。これらのエラーは、変更セットの処理DescribeChangeSet後に を呼び出すと返されます。DescribeChangeSet を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください変更セットの使用。

料金を更新する

Catalog 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 変更タイプを追加するフィールドの情報を入力します。

レスポンスの構文

リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セットChangeSetArnの ChangeSetIdと を提供し、次のようになります。

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

変更リクエストがキューに追加され、処理されます。これには、AWS Marketplaceガイドラインを満たしていることを確認するための情報の検証が含まれます。検証プロセスには数分かかる場合があります。

リクエストのステータスは、 を通じてAWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog 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 管理ポータル、または DescribeChangeSetアクションを使用して Catalog API で確認できます。

同期検証

以下のスキーマ検証は、 の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 変更タイプを追加するフィールドの情報を入力します。

レスポンスの構文

リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セットChangeSetArnの ChangeSetIdと を提供し、次のようになります。

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

変更リクエストがキューに追加され、処理されます。これには、AWS Marketplaceガイドラインを満たしていることを確認するための情報の検証が含まれます。検証プロセスには数分かかる場合があります。

リクエストのステータスは、 を通じてAWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog DescribeChangeSet API から直接確認できます。

同期検証

以下のスキーマ検証は、 のUpdateValidityTermsアクションに固有ですAWS Marketplace Catalog API。これらの検証は、 を呼び出すときに実行されますStartChangeSet。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。

非同期エラー

以下のエラーは、 のUpdateValidityTermsアクションに固有のものですAWS Marketplace Catalog API。これらのエラーは、変更セットの処理DescribeChangeSet後に を呼び出すと返されます。DescribeChangeSet を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください変更セットの使用。

支払いスケジュールの詳細を更新する

Catalog 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 変更タイプを追加するフィールドの情報を入力します。

レスポンスの構文

リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セットChangeSetArnの ChangeSetIdと を提供し、次のようになります。

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

変更リクエストがキューに追加され、処理されます。これには、AWS Marketplaceガイドラインを満たしていることを確認するための情報の検証が含まれます。検証プロセスには数分かかる場合があります。

リクエストのステータスは、 を通じてAWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog DescribeChangeSet API から直接確認できます。

同期検証

以下のスキーマ検証は、 のUpdatePaymentScheduleTermsアクションに固有ですAWS Marketplace Catalog API。これらの検証は、 を呼び出すときに実行されますStartChangeSet。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。

非同期エラー

以下のエラーは、 のUpdatePaymentScheduleTermsアクションに固有のものですAWS Marketplace Catalog API。これらのエラーは、変更セットの処理DescribeChangeSet後に を呼び出すと返されます。DescribeChangeSet を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください変更セットの使用。

更新オプションを変更する

Catalog 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 変更タイプを追加するフィールドの情報を入力します。

レスポンスの構文

リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セットChangeSetArnの ChangeSetIdと を提供し、次のようになります。

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

変更リクエストがキューに追加され、処理されます。これには、AWS Marketplaceガイドラインを満たしていることを確認するための情報の検証が含まれます。検証プロセスには数分かかる場合があります。

リクエストのステータスは、 を通じてAWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog DescribeChangeSet API から直接確認できます。

同期検証

以下のスキーマ検証は、 のUpdateRenewalTermsアクションに固有ですAWS Marketplace Catalog API。これらの検証は、 を呼び出すときに実行されますStartChangeSet。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。

非同期エラー

以下のエラーは、 のUpdateRenewalTermsアクションに固有のものですAWS Marketplace Catalog API。これらのエラーは、変更セットの処理DescribeChangeSet後に を呼び出すと返されます。DescribeChangeSet を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください変更セットの使用。

オファーを公開する

Catalog 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 変更タイプを追加するフィールドの情報を入力します。

レスポンスの構文

リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セットChangeSetArnの ChangeSetIdと を提供し、次のようになります。

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

変更リクエストがキューに追加され、処理されます。これには、AWS Marketplaceガイドラインを満たしていることを確認するための情報の検証が含まれます。検証プロセスには数分かかる場合があります。

リクエストのステータスは、 を通じてAWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog DescribeChangeSet API から直接確認できます。

同期検証

以下のスキーマ検証は、 のReleaseOfferアクションに固有ですAWS Marketplace Catalog API。これらの検証は、 を呼び出すときに実行されますStartChangeSet。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。

非同期エラー

以下のエラーは、 のReleaseOfferアクションに固有のものですAWS Marketplace Catalog API。これらのエラーは、変更セットの処理DescribeChangeSet後に を呼び出すと返されます。DescribeChangeSet を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください変更セットの使用。

既存のオファーの詳細を記述する

Catalog 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レスポンスに表示されるフィールドに関する情報です。