View a markdown version of this page

AWS Marketplace 契約 API の使用 - AWS Marketplace
主要なコンセプトEndpointアクセス許可

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

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

AWS Marketplace 契約 API の使用

AWS Marketplace は、お客様がサードパーティーのソフトウェア、データ、サービスを検索、購入、デプロイ、管理してソリューションを構築し、ビジネスを運営するために使用できる厳選されたデジタルカタログです。 AWS Marketplace 契約サービスは、購入者と販売者が契約のリスト、検索、フィルタリングなど、契約を管理するのに役立つ AWS Marketplace API インターフェイスを提供します。

主要なコンセプト

次の表は、 AWS Marketplace 契約 API で使用される主要な概念を示しています。

概念 説明
アクセプター 契約で提案者が延長した条件のすべてまたはサブセットを受け入れる当事者。最も一般的なユースケースでは、アクセプターは製品の購入者です。
契約 提案者 (通常、販売者/ISV またはチャネルパートナー) とアクセプタ (通常、購入者) を含む 2 つの当事者をバインドし、両者間で適用される条件を定義するドキュメント。
契約キャンセルリクエスト アクティブな契約をキャンセルするために販売者 (提案者) によって開始されたリクエスト。購入者 (アクセプタ) はキャンセルリクエストを承諾または拒否できます。承諾された場合、契約キャンセルワークフローは非同期的に実行され、契約ステータスはキャンセル済みに変わります。拒否された場合、契約は引き続き有効になり、販売者は新しいキャンセルリクエストを送信できます。
契約提案 販売者/提案者が提案した一連の条件/オファーを参照するエンティティ。
契約リクエスト 顧客アクションの結果として作成されたリソースを参照するエンティティ。契約の作成/変更パラメータ、リクエストのライフサイクル、およびリクエストの承諾時の推定結果の概要を示します。
請求可能なディメンション 製品の料金設定方法に関連する要素。例えば、Amazon マシンイメージ (AMI) 製品の Amazon Elastic Compute Cloud (Amazon EC2) インスタンス、または Software as a Service (SaaS) 製品の読み取り専用ユーザーと比較したプレミアムなどです。
チャネルパートナー (CP) 製品所有者 (ISV) が代わりに製品を再販することを承認している組織 AWS Marketplace。
独立系ソフトウェアベンダー (ISVs) 独自の製品を一覧表示して管理する販売者 AWS Marketplace。
Intent 目的は、契約の作成中に購入者が持つ動機を表します。現在サポートされているインテントは、契約作成フロー中の新規、修正、置換です。
支払いリクエスト 販売者 (提案者) が開始した、契約に関連する支払いのリクエスト。購入者 (アクセプタ) は、支払いリクエストを承諾または拒否できます。
提案者 契約の最初の条件セットを延長する当事者。通常はオファーを使用します。
Purchase Orders 組織は、購入者が発注書を使用して承認済みサプライヤーから購入し、購入内容を追跡し、支出が予測、予算編成、承認され、責任のあるコストセンター (複数可) に割り当てられるようにする必要があります。
[リソース] 販売者が販売する予定のユニットまたはリソース。多くの場合 AWS Marketplace、ベース製品と呼ばれます。基本製品は、製品情報、デプロイ属性、請求情報が追加されるまで、購入者が使用するために完了しません。製品は、販売者が販売する予定の出品の製品情報、ソフトウェアデプロイ属性、請求メカニズムを記述します。購入者が販売して使用できる取引可能なユニットになるには、製品をオファーと組み合わせる必要があります AWS Marketplace。
言葉 契約の適用方法 (料金など) を管理する契約内の単位。

Endpoint

AWS Marketplace 契約サービスには、次のエンドポイントを使用してアクセスできます。

Endpoint リージョン サポートされている IP プロトコル
agreement-marketplace.us-east-1.api.aws 米国東部 (バージニア北部) IPv4、IPv6

アクセス許可

Agreements API は、標準の AWS Signature Version 4 (SigV4) 認証を使用します。API を呼び出すには、有効な AWS 認証情報と適切な IAM アクセス許可が必要です。詳細については、「AWS Marketplace 契約 API のアクセスコントロール」を参照してください。

エラーコード

AWS Marketplace Agreement Service アクションには、次のエラーコードが適用されます。複数のユースケースで 1 つのエラーコードが返される場合があります。各エラーコードが発生する特定のシナリオを特定するには、以下の説明を参照してください。このリストは網羅的なものではなく、新機能がリリースされると更新される可能性があります。

ValidationException

エラーコード 説明
INVALID_SOURCE_AGREEMENT_IDENTIFIER ソース契約識別子が予想される形式と一致しない場合、またはソース契約識別子を必要としないインテント (NEW など) にソース契約識別子が指定されている場合に返されます。
MISSING_SOURCE_AGREEMENT_IDENTIFIER ソース契約識別子が必要なインテント (REPLACE や AMEND など) に対してソース契約識別子が指定されていない場合に返されます。
INVALID_REQUESTED_TERM_CONFIGURATION

リクエストされた用語設定が有効でない場合に返されます。考えられるシナリオ:

  • 設定は、それを受け入れない用語に対して提供されます。

  • 必要な設定がありません。

  • セレクタ値は契約提案に属していません。

  • 複数のディメンション選択が許可されていない場合、ディメンションには 1 つのディメンションのみを含めることができます。

  • ディメンションキーは、契約提案または承諾された条件では認識されません。

  • ディメンション値は、ディメンションに対して数量設定が有効になっていない場合にのみ 1 にすることができます。

  • 設定には、重複するディメンションキーが含まれています。

  • 設定はソース契約とは異なります。
INVALID_AGREEMENT_PROPOSAL_IDENTIFIER 契約提案識別子が予想される形式と一致しない場合、または契約提案識別子を必要としないインテント (AMEND など) に対して契約提案識別子が指定された場合に返されます。
MISSING_AGREEMENT_PROPOSAL_IDENTIFIER 契約提案識別子を必要とするインテント (NEW や REPLACE など) に契約提案識別子が指定されていない場合に返されます。
INVALID_FILTER_NAME 指定されたフィルター名が認識されなかった場合、または重複するフィルター名がリクエストに含まれている場合に返されます。
INVALID_FILTER_VALUES フィルター値が無効、重複、空、最大許容数を超えた場合、または日付範囲フィルターがBeforeEndTime値の前にAfterEndTime値を指定する場合に返されます。
INVALID_NEXT_TOKEN ページ分割トークンの形式が正しくない場合、期限切れの場合、復号できない場合、またはページ分割呼び出し間でリクエストパラメータが変更された場合に返されます。
DUPLICATE_CHARGES リクエストに重複する料金識別子が含まれている場合、または同じ料金識別子に対して異なる発注書値が指定されている場合に返されます。
UNSUPPORTED_FILTERS 指定されたフィルターの組み合わせがサポートされていない場合に返されます。サポートされているフィルターの組み合わせは、パーティのタイプによって異なります。パブリックドキュメントでサポートされている組み合わせを確認してください。
INVALID_PURCHASE_ORDER_REFERENCE 発注書リファレンスが形式要件を満たしていない場合、またはアカウント管理者が設定したとおりに必要な発注書が提供されていない場合に返されます。
INVALID_CHARGE_AMOUNT

請求額が有効でない場合に返されます。考えられるシナリオ:

  • 請求金額が期間の最大合計請求金額を超えています。

  • 請求金額の形式が通貨要件と一致しません (小数点以下が多すぎるなど）。

  • 契約が最大合計請求額に達したため、残額は利用できません。
UNSUPPORTED_ACTION

リクエストされたオペレーションがリソースの現在の状態でサポートされていない場合に返されます。特定のシナリオは API によって異なります。

  • UpdatePurchaseOrders – 請求日が過去のものであり、自動更新が無効になっている、請求日が 3 時間以内である、請求が返金料金である、請求リビジョンが最新ではない、発注書がすべて同じ契約に属していない、または契約がアクティブでない。

  • CreateAgreementRequest – 将来の日付の契約の修正はサポートされていない、リソースタイプと期間タイプの組み合わせがリクエストされたインテントをサポートしていない、有効な契約を将来の日付の契約に置き換えることは許可されていない、修正中に契約期間を変更できない、現時点で契約を更新できない (保留中のエンタイトルメントが存在するなど）、契約提案はソース契約と同じリソースを参照する必要がある、契約提案はソース契約とは異なる必要がある、または契約タイプがこのアクションをサポートしていない。

  • AcceptAgreementRequest – リソースタイプと期間タイプの組み合わせは、このアクションをサポートしていないか、契約タイプはこのアクションをサポートしていないか、同じリソースにアクティブな契約が既に存在するか、現時点では契約を更新できません。

  • CancelAgreement – 契約に保留中のエンタイトルメントがある場合、契約タイプがキャンセルをサポートしていない場合、 ConfigurableUpfrontPricingTerm または との契約PaymentScheduleTermが同じリソースでアクティブな間は との契約をキャンセルUsageBasedPricingTermできない場合、またはリソースタイプと期間タイプの組み合わせがキャンセルをサポートしていない場合。

  • GetBillingAdjustmentRequest – 契約が非購入契約タイプであるか、発信者が契約のアクセプターです。

  • SendAgreementCancellationRequest – 契約タイプはこのアクションをサポートしていません。

  • AcceptAgreementCancellationRequest – 契約タイプはこのアクションをサポートしていません。

  • RejectAgreementCancellationRequest – 契約タイプはこのアクションをサポートしていません。

  • CancelAgreementCancellationRequest – 契約タイプはこのアクションをサポートしていません。

  • GetAgreementCancellationRequest – 契約は非購入契約タイプです。

ResourceNotFoundException

ResourceNotFoundException には、見つからないリソースを識別する フィールドresourceTypeと resourceIdフィールドが含まれます。次の表は、リソースタイプごとにこの例外を引き起こす可能性のあるシナリオを示しています。

注記

セキュリティ上の理由から、リソースが存在しないか、呼び出し元がそのリソースにアクセスできない場合にも、同じエラーが返されます。これにより、有効なリソース識別子の列挙が防止されます。

リソースタイプ 考えられるシナリオ
AgreementProposal

  • 指定された識別子の契約提案が見つかりませんでした。

  • オファーはアクセプターを対象としていません。

  • このオファーは、アクセプタの国では利用できません。
Agreement

  • 指定された識別子の契約が見つかりませんでした。

  • 発信者は、契約の受諾者でも提案者でもありません。
AgreementRequest

  • 指定された識別子に対する契約リクエストが見つかりませんでした。

  • 契約リクエストは別の発信者に属します。

  • 契約リクエストの有効期限が切れています。

  • 契約リクエストは、同じ製品またはオファーに対する後続の承諾されたリクエストに置き換えられました。

  • オファーの再公開またはオファーの有効期限のため、 CreateAgreementRequestと のAcceptAgreementRequest呼び出しの間で契約提案が非アクティブになりました。
Charge

  • 指定された識別子に対する料金は見つかりません。

  • 料金は指定された契約に属していません。
BillingAdjustmentRequest

  • 指定された識別子に対する請求調整リクエストが見つかりませんでした。

  • 発信者は、調整に関連する契約の受諾者でも提案者でもありません。
AgreementCancellationRequest

  • 指定された識別子に対する契約キャンセルリクエストが見つかりませんでした。

  • 発信者は、キャンセルリクエストに関連付けられた契約のアクセプタでも提案者でもありません。
PaymentRequest

  • 指定された識別子の支払いリクエストが見つかりませんでした。

  • 発信者は、支払いリクエストに関連付けられた契約のアクセプタでも提案者でもありません。