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

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

使用 AMI 型產品

您可以使用 AWS Marketplace Catalog API自動化使用 Amazon Machine Image (AMI) 型產品的任務。

如需使用目錄 API 建立 AMI 型產品的資訊，請參閱 建立產品。

下列主題說明如何使用目錄 API 對您的 AMI 型產品執行動作：

新增新版本

您可以使用目錄 API 將新版本新增至現有的 AMI 型產品AWS Marketplace。如需使用 將新 AMI 版本新增至產品的詳細資訊AWS Marketplace 管理入口網站，請參閱《 AWS Marketplace賣方指南》中的新增新版本。

當您建立包含將新 AMI 新增至 AWS Marketplace 的請求時，必須將 AMI 複製到 AWS Marketplace 系統中，然後掃描安全問題。您必須透過建立 AWS Identity and Access Management (IAM) 角色來授予 AMI 的 AWS Marketplace 存取權，該角色具有在您的 AMI 上執行動作的許可。如需所需許可的詳細資訊，請參閱 AWS Marketplace賣方指南中的授予 AWS Marktplace 存取您的 AMI。

若要新增版本，請使用 AMI 型產品的AddDeliveryOptions變更類型呼叫 StartChangeSet API 操作，如下列範例所示。若要在不實際建立新版本的情況下測試您的 API 呼叫，請將 Intent 參數設定為 VALIDATE。如需詳細資訊，請參閱意圖。

請求語法

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "AddDeliveryOptions",
      "Entity":
      {
        "Type": "AmiProduct@1.0",
        "Identifier": "prod-example12345"
      },
      "DetailsDocument":
      {
        "Version":
        {
          "VersionTitle": "My new title",
          "ReleaseNotes": "My new Release notes"
        },
        "DeliveryOptions":
        [
          {
            "Details":
            {
              "AmiDeliveryOptionDetails":
              {
                "AmiSource":
                {
                  "AmiId": "ami-1234567890abcdef",
                  "AccessRoleArn": "arn:aws:iam::12345678901:role/AwsMarketplaceAmiIngestion",
                  "UserName": "ec2-user",
                  "OperatingSystemName": "AMAZONLINUX",
                  "OperatingSystemVersion": "Amazon Linux 2 AMI 2.0.20210126.0 x86_64 HVM gp2",
                  "AfiIds": ["afi-1234567890abcdefg", "afi-abcdefg1234567890"] //Optional (Required only for FPGA products)
                },
                "UsageInstructions": "Easy to use AMI",
                "RecommendedInstanceType": "m4.xlarge",
                "SecurityGroups":
                [
                  {
                    "IpProtocol": "tcp",
                    "FromPort": 443,
                    "ToPort": 443,
                    "IpRanges":
                    [
                      "0.0.0.0/0"
                    ]
                  }
                ]
              }
            }
          },
          {
            "DeliveryOptionTitle": "My new AMI with CFTdelivery option",
            "Details":
            {
              "DeploymentTemplateDeliveryOptionDetails":
              {
                "ShortDescription": "My new short description",
                "LongDescription": "My new long description",
                "UsageInstructions": "My new usage instructions",
                "RecommendedInstanceType": "m4.xlarge",
                "ArchitectureDiagram": "https://my-bucket.s3.amazonaws.com/my-folder/diagram.png",
                "Template": "https://my-bucket.s3.amazonaws.com/my-folder/cft.template",
                "TemplateSources":
                [
                  {
                    "ParameterName": "MyAmiParam",
                    "AmiSource":
                    {
                      "AmiId": "ami-1234567890abcdef",
                      "AccessRoleArn": "arn:aws:iam::12345678901:role/AwsMarketplaceAmiIngestion",
                      "UserName": "ec2-user",
                      "OperatingSystemName": "AMAZONLINUX",
                      "OperatingSystemVersion": "Amazon Linux 2 AMI 2.0.20210126.0 x86_64 HVM gp2"
                    }
                  }
                ]
              }
            }
          }
        ]
      }
    }
  ],
  "Intent": "APPLY"
}

下列清單提供與AddDeliveryOptions變更類型搭配使用的輸入欄位相關資訊。除非另有說明，否則所有欄位都是必要欄位。如需這些欄位的詳細資訊，請參閱《 AWS Marketplace賣方指南》中的新增版本。

回應語法

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

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

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

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

如需賣方產品變更集中錯誤的詳細資訊，請參閱 變更集狀態和錯誤。

請求完成時，會新增版本，而且任何現有的訂閱者都會收到電子郵件訊息，告知他們新版本的相關資訊。如需新增新版本程序的詳細資訊，請參閱《 AWS Marketplace賣方指南》中的新增新版本。

非同步錯誤

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

您也可以使用 建立 AMI 型產品AWS Marketplace 管理入口網站。如需詳細資訊，請參閱《 AWS Marketplace賣方指南》中的 AMI 產品。

如需示範如何自動更新 AMI 型產品的逐步解說，您也可以參閱影片，AWS Marketplace使用目錄 API (5：08) 自動更新 中的產品清單。

更新版本資訊

您可以使用目錄 API 來更新 中現有版本 AMI 產品的詳細資訊AWS Marketplace。

您無法更新 版本的 AMI。如果您需要更新 AMI，請改為建立新的版本。

若要新增新版本，請使用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": "AmiProduct@1.0"
      },
      "DetailsDocument":
      {
        "Version":
        {
          "ReleaseNotes": "*My new Release notes*"
        },
        "DeliveryOptions":
        [
          {
            "Id": "example1-2222-cccc-2222-cccccccccccc",
            "Details":
            {
              "AmiDeliveryOptionDetails":
              {
                "UsageInstructions": "Easy to use AMI"
              }
            }
          },
          {
            "Id": "example1-2222-dddd-2222-dddddddddddd",
            "Details":
            {
              "DeploymentTemplateDeliveryOptionDetails":
              {work with ami
                "DeliveryOptionTitle": "My updated delivery option title",
                "UsageInstructions": "Updated usage instructions here."
              }
            }
          }
        ]
      }
    }
  ]
}

以下是您為新增UpdateDeliveryOptions變更類型而提供的輸入欄位的相關資訊。如需這些欄位的詳細資訊，請參閱 AWS Marketplace賣方指南中的更新版本資訊。

回應語法

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

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

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

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

如需變更集的詳細資訊，請參閱使用變更集。如需賣方產品變更集中錯誤的詳細資訊，請參閱 變更集狀態和錯誤。

非同步錯誤

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

您可以在變更集開始處理後，使用 DescribeChangeSet操作來擷取UpdatePricingTerms動作。如需錯誤詳細資訊和故障診斷的詳細資訊，請參閱本指南變更集狀態和錯誤稍早的 。

限制版本

您可以使用目錄 API 來限制 AMI 型產品的版本。這可防止新買方使用該版本，但讓現有買方能夠使用該版本。從版本限制所有交付選項會限制版本。限制一或多個，但並非全部的交付選項，只會限制該版本中的交付選項。您必須擁有至少一個無限制的產品版本，因此您無法限制產品的最後一個公開版本。

若要限制版本，請使用RestrictDeliveryOptions變更類型呼叫 StartChangeSet API 操作，如下列範例所示。

請求語法

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "RestrictDeliveryOptions",
      "Entity":
      {
        "Identifier": "example1-abcd-1234-5ef6-7890abcdef12@1",
        "Type": "AmiProduct@1.0"
      },
      "DetailsDocument":
      {
        "DeliveryOptionIds":
        [
          "example1-2222-cccc-2222-cccccccccccc"
        ]
      }
    }
  ]
}

以下是您為新增RestrictDeliveryOptions變更類型而提供的輸入欄位的相關資訊：

回應語法

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

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

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

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

非同步錯誤

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

更新未來AWS 區域支援

您可以使用目錄 API 來變更 AMI 型產品的未來AWS 區域支援偏好設定AWS Marketplace。

若要變更未來的AWS 區域支援偏好設定，請使用UpdateFutureRegionSupport變更類型呼叫 StartChangeSet API 操作，如下列範例所示。

請求語法

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateFutureRegionSupport",
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "AmiProduct@1.0"
      },
      "DetailsDocument":
      {
        "FutureRegionSupport":
        {
          "SupportedRegions":
          [
            "All"
          ]
        }
      }
    }
  ]
}

提供要新增UpdateFutureRegionSupport變更類型的欄位資訊：

回應語法

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

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

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

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

非同步錯誤

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

新增支援的AWS 區域

您可以使用目錄 API 在 中新增 AMI AWS 區域型產品支援的新 AWS Marketplace。

若要新增支援的區域，請使用AddRegions變更類型呼叫 StartChangeSet API 操作，如下列範例所示。

請求語法

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "AddRegions",
      "DetailsDocument": {
        "Regions": [
          "us-east-1",
          "ap-northeast-2"
        ]
      },
      "Entity": {
        "Identifier": "prod-123456@1",
        "Type": "AmiProduct@1.0"
      }
    }
  ]
}

提供要新增AddRegions變更類型的欄位資訊。

回應語法

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

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

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

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

非同步錯誤

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

限制AWS 區域

您可以使用目錄 API 來限制先前AWS 區域支援的 AMI 型產品AWS Marketplace。

若要限制先前支援的 區域，請使用 RestrictRegions 變更類型呼叫 StartChangeSet API 操作，如下列範例所示。

請求語法

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "RestrictRegions",
      "DetailsDocument": {
        "Regions": [
          "us-east-1",
          "ap-northeast-2"
        ]
      },
      "Entity": {
        "Identifier": "prod-123456@1",
        "Type": "AmiProduct@1.0"
      }
    }
  ]
}

提供要新增AddRegions變更類型的欄位資訊。

回應語法

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

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

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

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

非同步錯誤

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

新增執行個體類型

您可以使用 Catalog API 為您的 AMI 型產品新增新的執行個體類型AWS Marketplace。

AddInstanceTypes 在建立產品時， 會將新的執行個體類型新增至現有產品和新建立的產品。變更類型會使用新的執行個體類型更新產品文件中的所有版本。

新增限制執行個體類型時，可以從限制清單中移除執行個體類型，並新增至可用的執行個體類型清單。這可讓賣方有更多控制權來變更其產品限制。執行個體類型清單是可互換的，並非產品的永久限制狀態。

對於內部計量產品，賣方需要呼叫個別的變更類型UpdatePricingTerms，AddDimensions並更新執行個體類型的定價。

若要新增執行個體類型，請使用RestrictRegions變更類型呼叫 StartChangeSet API 操作，如下列範例所示。

請求語法

只有AddInstanceTypes變更類型如下所示。雖然內部計量的 AMI 賣方需要為其 AMI 呼叫AddInstanceTypes和UpdatePricingTerms變更類型。

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "AddInstanceTypes",
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "AmiProduct@1.0"
      },
      "DetailsDocument":
      {
        "InstanceTypes":
        [
          "m1.medium"
        ]
      }
    }
  ]
}

提供要新增AddInstanceTypes變更類型的欄位資訊：

回應語法

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

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

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

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

同步驗證

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

非同步錯誤

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

限制執行個體類型

您可以使用目錄 API 來限制或限制 AMI 型產品的可用執行個體類型AWS Marketplace。

現有的訂閱者不會受到此變更的影響，而且他們能夠使用受限制的執行個體類型。不過，任何新買方都無法使用受限制的執行個體類型。若要停止目前的執行個體類型訂閱 （執行個體類型受到限制後），您必須聯絡AWS Marketplace賣方營運團隊。

RestrictInstanctTypes 會將執行個體類型限制為產品文件中的所有版本。在AddInstanceTypes變更類型中，您要更新產品的所有版本。您將無法限制建議的執行個體類型。建議的執行個體類型位於版本層級，因此賣方可能無法限制多個執行個體類型。

對於內部計量產品，您需要在呼叫 時呼叫個別的變更類型RestrictDimensions。這可防止針對受限執行個體類型建立新的優惠。

若要限制或以 AMI 為基礎的產品可用的執行個體類型，請使用RestrictInstanceTypes變更類型呼叫 StartChangeSet API 操作，如下列範例所示。

請求語法

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "RestrictInstanceTypes",
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "AmiProduct@1.0"
      },
      "DetailsDocument":
      {
        "InstanceTypes":
        [
          "m1.medium"
        ]
      }
    }
  ]
}

提供要新增RestrictInstanceTypes變更類型的欄位資訊。

回應語法

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

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

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

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

同步驗證

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

非同步錯誤

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