AWS Marketplace API 참조가 재구성되었습니다. 지원되는 API 작업에 대한 자세한 내용은 AWS Marketplace API 참조를 참조하세요.

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

AWS MarketplaceAPIs를 사용하여 비공개 제안 작업

를 사용하여 제안 작업을 위한 작업을 자동화AWS Marketplace Catalog API할 수 있습니다.

제품은 판매 대상을 설명하지만 AWS Marketplace제안은 제품 구매 및 소비 방식에 대한 약관을 설명합니다. AWS Marketplace제품은 여러 판매자가 여러 제안을 판매할 수 있습니다. 그러나 각 AWS Marketplace제안은 하나의 제품에 대해서만 생성할 수 있습니다. 제안에는 두 당사자 간의 계약 조건 모음이 포함됩니다. 수락된 제안 조건은 거래 증명으로 계약으로 변환됩니다.

제안에는 두 가지 유형이 있습니다.

다음 리소스를 참조하세요.

다음 주제에서는 카탈로그 API를 사용하여 제안을 생성하고 업데이트하는 방법을 설명합니다.

제안 생성

카탈로그 API를 사용하여에서 새 제안을 생성할 수 있습니다AWS Marketplace. 요청이 성공적으로 처리되면는 구매자가 볼 수 Draft없는 불완전한 제안인를 AWS Marketplace Catalog API생성합니다. 제안을 완료하려면 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 Management Portal또는 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 변경 유형을 추가합니다.

응답 구문

요청에 대한 변경 세트가 생성됩니다. 이 요청에 대한 응답은 변경 세트에 ChangeSetArn 대한 ChangeSetId 및를 제공하며 다음과 같습니다.

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

변경 요청이 대기열에 추가되고 처리됩니다.

를 통해 AWS Marketplace Management Portal또는 API 작업을 사용하여 카탈로그 DescribeChangeSet API를 통해 직접 요청 상태를 확인할 수 있습니다.

동기 검증

다음 스키마 검증은의 CreateReplacementOffer 작업에 따라 다릅니다AWS Marketplace Catalog API. 이러한 검증은를 호출할 때 수행됩니다StartChangeSet. 요청이 다음 요구 사항을 충족하지 않으면 HTTP 응답으로 실패합니다.

비동기 오류

다음 오류는의 CreateReplacementOffer 작업과 관련이 있습니다AWS Marketplace Catalog API. 이러한 오류는 변경 세트가 처리된 DescribeChangeSet 후를 호출할 때 반환됩니다. 를 사용하여 변경 요청의 상태를 가져오는 DescribeChangeSet 방법에 대한 자세한 내용은 섹션을 참조하세요변경 세트 작업.

제안 정보 업데이트

카탈로그 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 Management Portal또는 API 작업을 사용하여 카탈로그 DescribeChangeSet API를 통해 직접 요청 상태를 확인할 수 있습니다.

동기 검증

다음 스키마 검증은의 UpdateInformation 작업에 따라 다릅니다AWS Marketplace Catalog API. 이러한 검증은를 호출할 때 수행됩니다StartChangeSet. 요청이 다음 요구 사항을 충족하지 않으면 HTTP 응답으로 실패합니다.

비동기 오류

다음 오류는의 UpdateInformation 작업과 관련이 있습니다AWS Marketplace Catalog API. 이러한 오류는 변경 세트가 처리된 DescribeChangeSet 후를 호출할 때 반환됩니다. 를 사용하여 변경 요청의 상태를 가져오는 DescribeChangeSet 방법에 대한 자세한 내용은 섹션을 참조하세요변경 세트 작업.

대상 지정 구성 업데이트

카탈로그 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 Management Portal또는 API 작업을 사용하여 카탈로그 DescribeChangeSet API를 통해 직접 요청 상태를 확인할 수 있습니다.

동기 검증

다음 스키마 검증은의 UpdateTargeting 작업에 따라 다릅니다AWS Marketplace Catalog API. 이러한 검증은를 호출할 때 수행됩니다StartChangeSet. 요청이 다음 요구 사항을 충족하지 않으면 HTTP 응답으로 실패합니다.

비동기 오류

다음 오류는의 UpdateTargeting 작업과 관련이 있습니다AWS Marketplace Catalog API. 이러한 오류는 변경 세트가 처리된 DescribeChangeSet 후를 호출할 때 반환됩니다. 를 사용하여 변경 요청의 상태를 가져오는 DescribeChangeSet 방법에 대한 자세한 내용은 섹션을 참조하세요변경 세트 작업.

환불 정책 업데이트

카탈로그 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 변경 유형을 추가합니다.

응답 구문

요청에 대한 변경 세트가 생성됩니다. 이 요청에 대한 응답은 변경 세트에 ChangeSetArn 대한 ChangeSetId 및를 제공하며 다음과 같습니다.

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

변경 요청이 대기열에 추가되고 처리됩니다. 여기에는 AWS Marketplace지침을 충족하는지 확인하기 위한 정보 검증이 포함됩니다. 검증 프로세스는 몇 분 정도 걸릴 수 있습니다.

를 통해 AWS Marketplace Management Portal또는 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 변경 유형을 추가합니다.

응답 구문

요청에 대한 변경 세트가 생성됩니다. 이 요청에 대한 응답은 변경 세트에 ChangeSetArn 대한 ChangeSetId 및를 제공하며 다음과 같습니다.

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

변경 요청이 대기열에 추가되고 처리됩니다. 여기에는 AWS Marketplace지침을 충족하는지 확인하기 위한 정보 검증이 포함됩니다. 검증 프로세스는 몇 분 정도 걸릴 수 있습니다.

를 통해 AWS Marketplace Management Portal또는 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 변경 유형을 추가합니다.

응답 구문

요청에 대한 변경 세트가 생성됩니다. 이 요청에 대한 응답은 변경 세트에 ChangeSetArn 대한 ChangeSetId 및를 제공하며 다음과 같습니다.

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

변경 요청이 대기열에 추가되고 처리됩니다. 여기에는 AWS Marketplace지침을 충족하는지 확인하기 위한 정보 검증이 포함됩니다. 검증 프로세스는 몇 분 정도 걸릴 수 있습니다.

를 통해 AWS Marketplace Management Portal또는 API 작업을 사용하여 카탈로그 DescribeChangeSet API를 통해 직접 요청 상태를 확인할 수 있습니다.

동기 검증

다음 스키마 검증은의 UpdatePricingTerms 작업에 따라 다릅니다AWS Marketplace Catalog API. 이러한 검증은를 호출할 때 수행됩니다StartChangeSet. 요청이 다음 요구 사항을 충족하지 않으면 HTTP 응답으로 실패합니다.

비동기 오류

다음 오류는의 UpdatePricingTerms 작업과 관련이 있습니다AWS Marketplace Catalog API. 이러한 오류는 변경 세트가 처리된 DescribeChangeSet 후를 호출할 때 반환됩니다. 를 사용하여 변경 요청의 상태를 가져오는 DescribeChangeSet 방법에 대한 자세한 내용은 섹션을 참조하세요변경 세트 작업.

제안 검색 가능성 업데이트

카탈로그 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 Management Portal또는 DescribeChangeSet 작업을 사용하여 카탈로그 API에서 요청 상태를 확인할 수 있습니다.

동기 검증

다음 스키마 검증은의 UpdateAvailability 작업에 따라 다릅니다AWS Marketplace Catalog API. 이러한 검증은를 호출할 때 수행됩니다StartChangeSet. 요청이 다음 요구 사항을 충족하지 않으면 HTTP 응답으로 실패합니다.

비동기 오류

다음 오류는의 UpdateAvailability 작업에만 해당됩니다AWS Marketplace Catalog API. 이러한 오류는 변경 세트가 처리된 DescribeChangeSet 후를 호출할 때 반환됩니다. 를 사용하여 변경 요청의 상태를 가져오는 DescribeChangeSet 방법에 대한 자세한 내용은 섹션을 참조하세요변경 세트 작업.

제안을 사용하여 생성된 계약의 만료 날짜 정의

카탈로그 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 Management Portal또는 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 변경 유형을 추가합니다.

응답 구문

요청에 대한 변경 세트가 생성됩니다. 이 요청에 대한 응답은 변경 세트에 ChangeSetArn 대한 ChangeSetId 및를 제공하며 다음과 같습니다.

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

변경 요청이 대기열에 추가되고 처리됩니다. 여기에는 AWS Marketplace지침을 충족하는지 확인하기 위한 정보 검증이 포함됩니다. 검증 프로세스는 몇 분 정도 걸릴 수 있습니다.

를 통해 AWS Marketplace Management Portal또는 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 변경 유형을 추가합니다.

응답 구문

요청에 대한 변경 세트가 생성됩니다. 이 요청에 대한 응답은 변경 세트에 ChangeSetArn 대한 ChangeSetId 및를 제공하며 다음과 같습니다.

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

변경 요청이 대기열에 추가되고 처리됩니다. 여기에는 AWS Marketplace지침을 충족하는지 확인하기 위한 정보 검증이 포함됩니다. 검증 프로세스는 몇 분 정도 걸릴 수 있습니다.

를 통해 AWS Marketplace Management Portal또는 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 변경 유형을 추가합니다.

응답 구문

요청에 대한 변경 세트가 생성됩니다. 이 요청에 대한 응답은 변경 세트에 ChangeSetArn 대한 ChangeSetId 및를 제공하며 다음과 같습니다.

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

변경 요청이 대기열에 추가되고 처리됩니다. 여기에는 AWS Marketplace지침을 충족하는지 확인하기 위한 정보 검증이 포함됩니다. 검증 프로세스는 몇 분 정도 걸릴 수 있습니다.

를 통해 AWS Marketplace Management Portal또는 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 응답에 표시되는 필드에 대한 정보입니다.