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

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

AWS Marketplace APIs を使用して SaaS 製品を操作する

を使用して AWS Marketplace Catalog API 、SaaS ベースの製品を操作するためのタスクを自動化できます。SaaS ベースの製品の作成については、「」を参照してください製品を作成する。以下のトピックでは、 Catalog API アクションを実行する方法について説明します。

SaaS 製品の無料料金モデルを設定する

SaaS 製品は、購入者が無料で製品を使用できるようにする無料料金モデルで提供できます。SaaS 製品の無料料金モデルを使用する場合は、UsageBasedPricingTerm または ConfigurableUpfrontPricingTerm のいずれかで、ゼロドル料金で料金ディメンションを設定する必要があります。

SaaS 製品の無料料金を設定するには:

オファーを設定するときは、以下を確認してください。

SaaS クイック起動オプション

クイック起動オプションの詳細については、次のリソースを参照してください。

配信オプションの追加

Catalog API を使用して、SaaS 製品の配信オプションを追加できます AWS Marketplace。API 配信オプションを使用すると、販売者は AI エージェントワークフロー用の Amazon Bedrock などのサービスと統合する API ベースの AWS サービスを提供できます。

API 配信オプションを追加するには、次の例に示すように、 AddDeliveryOptions変更タイプで StartChangeSet API オペレーションを呼び出して配信の詳細を追加します。

以下のトピックでは、 ApiDeliveryOptionDetailsおよび SaaSUrlDeliveryOptionDetailsオプションの使用を追加する方法について説明します。

ApiDeliveryOptionDetails

このセクションの例では、 ApiDeliveryOptionDetails配信オプションタイプをサポートしています。これにより、SaaS 製品の API エンドポイント、認証方法、統合プロトコルを指定できます。

リクエストの構文

POST /StartChangeSet HTTP/1.1 
Content-type: application/json
   {
  "ChangeType": "AddDeliveryOptions",
  "Entity": {
    "Identifier": "prod-1234567890123",
    "Type": "SaaSProduct@1.0"
  },
  "Details": {
    "DeliveryOptions": [
      {
        "Details": {
          "ApiDeliveryOptionDetails": {
            "ApiType": "AGENT",
            "QuickLaunchEnabled": true,
            "FulfillmentUrl": "https://example.com/fulfillment",
            "UsageInstructions": "# Getting Started\\n\\nTo use this API:\\n1. Register for an API key\\n2. Configure your endpoint\\n3. Start making requests",
            "CompatibleServices": ["Bedrock-AgentCore"],
            "Endpoints": [
              {
                "Name": "GenerateContent",
                "EndpointUrl": "https://api.example.com/v1/{tenantId}/generate",
                "EndpointType": "DYNAMIC",
                "EndpointUrlParameters": [
                  {
                    "Name": "tenantId",
                    "Description": "The unique identifier for the buyer's tenant",
                    "DefaultValue": "default"
                  }
                ],
                "Description": "Generate content using AI models",
                "AuthorizationTypes": ["API_KEY"],
                "Schemas": [{
                  "Type": "OPEN_API",
                  "SchemaUrl": "https://example.com/schemas/example-schema.json"
                }],
                "IntegrationProtocols": [
                  {
                    "Type": "MCP",
                    "UsageInstructions": "Connect using Model Context Protocol for seamless integration"
                  }
                ]
              }
            ]
          }
        }
      }
    ]
  }
}

AddDeliveryOptions 変更タイプを追加するフィールドの情報を入力します。

レスポンスの構文

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

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

同期検証

非同期エラー

配信オプションを更新する

Catalog API を使用して、 で SaaS 製品の配信オプションを更新できます AWS Marketplace。

配信オプションを更新するには、次の例に示すように、UpdateDeliveryOptions変更タイプを使用して StartChangeSet API オペレーションを呼び出します。

リクエストの構文

POST /StartChangeSet HTTP/1.1 
Content-type: application/json
{
    "Catalog": "AWSMarketplace",
    "ChangeSet": [
        {
            "ChangeType": "UpdateDeliveryOptions",
            "Entity": {
                "Identifier": "example1-abcd-1234-5ef6-7890abcdef12@1",
                "Type": "SaaSProduct@1.0"
            },
            "DetailsDocument": {
                "DeliveryOptions": [
                    {
                        "Id": "do-1234567891234567891234",
                        "Details": {
                            "ApiDeliveryOptionDetails": {
                                "ApiType": "AGENT",
                                "QuickLaunchEnabled": true,
                                "FulfillmentUrl": "https://example.com/fulfillment-updated",
                                "UsageInstructions": "# Updated Getting Started\\n\\nTo use this updated API:\\n1. Register for an API key\\n2. Configure your endpoint\\n3. Start making requests",
                                "CompatibleServices": ["Bedrock-AgentCore"],
                                "Endpoints": [
                                    {
                                        "Name": "GenerateContent",
                                        "EndpointUrl": "https://api.example.com/v2/{tenantId}/generate",
                                        "EndpointType": "DYNAMIC",
                                        "EndpointUrlParameters": [
                                            {
                                                "Name": "tenantId",
                                                "Description": "The unique identifier for the buyer's tenant",
                                                "DefaultValue": "default"
                                            }
                                        ],
                                        "Description": "Generate content using updated AI models",
                                        "AuthorizationTypes": ["API_KEY", "OAUTH2"],
                                        "Schemas": [{
                                            "Type": "OPEN_API",
                                            "SchemaUrl": "https://example.com/schemas/updated-schema.json"
                                        }],
                                        "IntegrationProtocols": [
                                            {
                                                "Type": "MCP",
                                                "UsageInstructions": "Connect using Model Context Protocol for seamless integration"
                            }
                                        ]
                                    }
                                ]
                            }
                        }
                    }
                ]
            }
        }
    ]
}

API 配信オプションを使用してUpdateDeliveryOptions変更タイプを更新するフィールドの情報を指定します。

レスポンスの構文

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

変更リクエストがキューに追加され、処理されます。これには、 AWS Marketplace ガイドラインを満たしていることを確認するための情報の検証が含まれます。検証プロセスには数分から数時間かかる場合があります。リクエストのステータスは、 を通じて AWS Marketplace 管理ポータル、または DescribeChangeSetアクションを使用して Catalog API で確認できます。

同期検証

非同期エラー

配信オプションの可視性を更新する

Catalog API を使用して、一部のユーザーのみが SaaS 製品の可視性を変更できるようにアクセス許可を設定できます AWS Marketplace。

一部のユーザーのみが SaaS 製品の可視性を変更できるようにアクセス許可を設定するには、次の例に示すように、UpdateDeliveryOptionsVisibility変更タイプを使用して StartChangeSet API オペレーションを呼び出します。

リクエストの構文

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateDeliveryOptionsVisibility",
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "SaaSProduct@1.0"
      },
      "DetailsDocument":
      {
        "DeliveryOptions":
        [
          {
            "Id": "do-1234567891234567891234",
            "TargetVisibility": "Public"
          },
          {
            "Id": "do-43210987654321",
            "TargetVisibility": "Limited",
            "Targeting":
            {
              "PositiveTargeting":
              {
                "BuyerAccounts":
                [
                  "123456789012"
                ]
              }
            }
          }
        ]
      }
    }
  ]
}

UpdateDeliveryOptionsVisibility 変更タイプを追加するフィールドの情報を入力します。

レスポンスの構文

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

変更リクエストがキューに追加され、処理されます。これには、 AWS Marketplace ガイドラインを満たしていることを確認するための情報の検証が含まれます。検証プロセスには数分から数時間かかる場合があります。リクエストのステータスは、 を通じて AWS Marketplace 管理ポータル、または DescribeChangeSetアクションを使用して Catalog API で確認できます。

同期検証

非同期エラー

SaaSUrlDeliveryOption

次の例は、 を使用して SaaSUrlDeliveryOptionDetailsを更新する方法を示していますFulfillmentUrl。

リクエストの構文

POST /StartChangeSet HTTP/1.1 
Content-type: application/json
     
{
    "Catalog": "AWSMarketplace",
    "ChangeSet": [
        {
            "ChangeType": "UpdateDeliveryOptions",
            "Entity": {
                "Identifier": "example1-abcd-1234-5ef6-7890abcdef12@1",
                "Type": "SaaSProduct@1.0"
            },
            "DetailsDocument": {
                "DeliveryOptions": [
                    {
                        "Id": "do-1234567891234567891234",
                        "Details": {
                            "SaaSUrlDeliveryOptionDetails": {
                                "FulfillmentUrl": "https://www.aws.amazon.com/marketplace/management",
                                "LaunchUrl": "URL",
                                "UsageInstructions": "Instructions",
                                "DeploymentTemplates": [
                                    {
                                        "Title": "CloudFormation Template 123",
                                        "Description": "CloudFormation description",
                                        "IamPolicy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"s3:Get*\",\"s3:List*\"],\"Resource\":\n[\"arn:aws:s3:::amzn-s3-demo-bucket\",\"arn:aws:s3:::amzn-s3-demo-bucket/*\"]}]}"
                                    }
                                ]
                            }
                        }
                    }
                ]
            }
        }
    ]
}

AddDeliveryOptions 変更タイプを追加するフィールドの情報を入力します。

レスポンスの構文

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

変更リクエストがキューに追加され、処理されます。これには、 AWS Marketplace ガイドラインを満たしていることを確認するための情報の検証が含まれます。検証プロセスには数分から数時間かかる場合があります。リクエストのステータスは、 を通じて AWS Marketplace 管理ポータル、または DescribeChangeSetアクションを使用して Catalog API で確認できます。

同期検証

非同期エラー

配信オプションの可視性を更新する

Catalog API を使用して、一部のユーザーのみが SaaS 製品の可視性を変更できるようにアクセス許可を設定できます AWS Marketplace。

これを行うには、次の例に示すように、UpdateDeliveryOptionsVisibility変更タイプを使用して StartChangeSet API オペレーションを呼び出します。

リクエストの構文

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateDeliveryOptionsVisibility",
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "SaaSProduct@1.0"
      },
      "DetailsDocument":
      {
        "DeliveryOptions":
        [
          {
            "Id": "do-1234567891234567891234",
            "TargetVisibility": "Public"
          },
          {
            "Id": "do-43210987654321",
            "TargetVisibility": "Limited",
            "Targeting":
            {
              "PositiveTargeting":
              {
                "BuyerAccounts":
                [
                  "123456789012"
                ]
              }
            }
          }
        ]
      }
    }
  ]
}

UpdateDeliveryOptionsVisibility 変更タイプを追加するフィールドの情報を入力します。

レスポンスの構文

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

変更リクエストがキューに追加され、処理されます。これには、 AWS Marketplace ガイドラインを満たしていることを確認するための情報の検証が含まれます。検証プロセスには数分から数時間かかる場合があります。リクエストのステータスは、 を通じて AWS Marketplace 管理ポータル、または DescribeChangeSetアクションを使用して Catalog API で確認できます。

同期検証

非同期エラー