제품 생성 제품 세부 정보 업데이트 요금 차원 추가 요금 차원 업데이트 요금 차원 제한 대상 지정 구성 업데이트 제품 표시 여부 업데이트 제품 게시 제품 ID 찾기 설정 상태 및 오류 변경

판매자 제품 작업

를 사용하여 판매자 제품 작업을 위한 작업을 자동화AWS Marketplace Catalog API할 수 있습니다. 여기에는 제품을 생성, 업데이트, 보기, 나열 및 정렬하는 기능이 포함됩니다. 이를 통해 제품 관리를 자동화할 수 있습니다. 예를 들어에서 셀프 서비스 게시 기능을 제공할 수 있습니다AWS Marketplace Management Portal.

제품은 판매하려는 단위 또는 리소스로AWS Marketplace, 종종 기본 제품이라고 합니다. 구매자는 제품 정보, 배포 속성 및 결제 정보를 추가할 때까지 기본 제품을 사용할 수 없습니다.

제품은 판매하려는 목록의 제품 정보, 소프트웨어 배포 속성 및 결제 메커니즘을 설명합니다. 판매할 수 있고 구매자가 사용할 수 있는 거래 가능한 단위가 되려면 제품을 제안과 페어링해야 합니다AWS Marketplace.

를 사용하여 다음을 수행할 수도 있습니다AWS Marketplace Catalog API.

각 제품 유형에는 서로 다른 제품 개체가 있습니다. 엔터티는 제품 또는 제안일 수 있습니다AWS Marketplace. 지원되는 제품 유형 및 개체는 다음과 같습니다.

제품 유형	개체
Amazon Machine Image(AMI) 제품	`AmiProduct@1.0`
컨테이너 제품	`ContainerProduct@1.0`
서비스형 소프트웨어(SaaS) 제품	`SaaSProduct@1.0`
기계 학습(ML) 제품	`MachineLearningProduct@1.0`

참고

CloudFormation제품 유형, AWS Data Exchange데이터 제품 및 전문 서비스 제품이 포함된 단일 AMI는 지원되지 않습니다.

다음 주제에서는에 설명된 대로 API에 액세스할 수 있고 판매자 사전 조건을 완료했다고 가정합니다AWS Marketplace카탈로그 API에 대한 액세스 제어.

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

AWS Marketplace카탈로그 API 사용의 기본 사항을 이해하려면 섹션을 참조하세요AWS Marketplace 카탈로그 API 사용.
작업 코드 예제가 포함된 end-to-end 랩은 AWS Marketplace판매자 워크숍의 API로 제품 관리를 참조하세요.
API 요청의 코드 예제는 GitHub의 AWS샘플에서 Python 및 Java 예제를 참조하세요.

다음 주제에서는 카탈로그 API를 사용하여 단일 AMI 제품, 컨테이너 기반 제품 또는 SaaS 제품에 대한 작업을 수행하는 방법을 설명합니다.

주제

제품 생성

참고

이 변경 유형은 AWS Marketplace카탈로그에 새로운 제품 개체를 생성하려는 경우에만 필요합니다. 기존 제품을 업데이트할 때는 필요하지 않습니다.

카탈로그 API를 사용하여 식별자(제품 코드 및 제품 ID)가 포함된 AMI, 컨테이너, 기계 학습 또는 SaaS 제품 문서를 생성할 수 있습니다AWS Marketplace.

CreateProduct 변경 유형으로 StartChangeSet API 작업을 호출하여 Draft 상태의 제품을 생성합니다.

요청이 성공적으로 처리되면가 Draft 상태의 제품을 AWS Marketplace Catalog API생성합니다. 불완전한 제품이며 구매자가 볼 수 없습니다AWS Marketplace.

그런 다음 Update 변경 유형을 사용하여 제품 생성 프로세스인 UpdateInformation, UpdateDimensions, UpdateTargeting 및 UpdateVisibility를 완료합니다.

제품이 완료되면 ReleaseProduct 변경 유형을 사용하여 제품 생성 프로세스를 완료한 다음 제안을 릴리스할 수 있습니다. 이 프로세스는 전체 제품을 검증하고 제품을 Limited 상태로 이동합니다.

참고

를 사용하여 제품을 생성하는 방법에 대한 자세한 내용은 AWS Marketplace판매자 안내서의 다음 주제를 AWS Marketplace Management Portal참조하세요.

단일 AMI 제품 생성

버전의 AMI는 업데이트할 수 없습니다. AMI를 업데이트해야 하는 경우 대신 새 버전을 생성합니다.
컨테이너 제품 생성
SaaS 제품 생성
기계 학습 제품 생성

AWS Marketplace Management Portal를 사용하여 제품을 생성하는 경우 제품은 Staging 상태가 됩니다.

Draft 상태의 제품을 생성하려면 다음 예제와 같이 CreateProduct 변경 유형으로 StartChangeSet API 작업을 호출합니다.

요청 구문


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

{
"Catalog": "AWSMarketplace",
"ChangeSet": [ 
  { 
    "ChangeType":"CreateProduct",
    "Entity":{
      "Type": "SaaSProduct@1.0" // choose from ["AmiProduct@1.0", "ContainerProduct@1.0", "SaaSProduct@1.0", "MachineLearningProduct@1.0"]
     },
     "DetailsDocument": {
        "ProductTitle": "Test product title set in CreateProduct"
     }
  }
]
}

CreateProduct 변경 유형을 추가할 필드에 대한 정보를 제공합니다. 이 변경 유형은 UpdateInformation 변경 유형으로 전송된 것과 동일한 제한이 적용되는 ProductTitle 속성에 포함될 수 있습니다.

Entity (객체)(필수) - 생성 중인 명명된 객체 유형입니다.
- Type (문자열)(필수) - Type는 제품이 사용할 전송 방법(제품 유형)을 기반으로 합니다SaaSProduct@1.0. AmiProduct@1.0, ContainerProduct@1.0 MachineLearningProduct@1.0 또는 . 자세한 내용은 식별자 단원을 참조하십시오.
DetailsDocument (객체)(필수) - 비어 있을 수 있습니다.
- ProductTitle (선택 사항) - 제품의 제목이며 최대 길이는 72자입니다. 나중에 UpdateInformation 변경 유형을 통해 제품 제목을 설정하거나 업데이트할 수도 있습니다.

응답 구문

요청에 대한 변경 세트가 생성됩니다. 이 요청에 대한 응답은 변경 세트에 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) 새 ProductId가 생성됩니다.

동기 검증

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

입력 필드	검증 규칙	HTTP 코드
ProductTitle(문자열)	최대 길이: 72	400

비동기 오류

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

오류 코드	오류 메시지
INVALID_INPUT	`ProductTitle 필드에 부적절한 콘텐츠 '{InappropriateContent}'가 있습니다. ProductTitle에 부적절한 콘텐츠를 제공하지 않습니다.`

제품 세부 정보 업데이트

이미 제품이 있는 경우 카탈로그 API를 사용하여 AMIAWS Marketplace, 컨테이너, ML 또는 SaaS 제품의 제품 세부 정보를 업데이트할 수 있습니다.

참고

를 사용하여 제품 세부 정보를 업데이트하는 방법에 대한 자세한 내용은 AWS Marketplace판매자 안내서의 다음 주제를 AWS Marketplace Management Portal참조하세요.

AMI 기반 제품: 제품 정보 업데이트
컨테이너 기반 제품: 컨테이너 제품에 대한 제품 정보 생성 또는 업데이트
SaaS 기반 제품: 제품 정보 업데이트
기계 학습 제품: 제품 정보 업데이트

제품 세부 정보를 업데이트하려면 다음 예제와 같이 UpdateInformation 변경 유형과 변경하려는 세부 정보를 사용하여 StartChangeSet API 작업을 호출합니다.

요청 구문


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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateInformation",
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "AmiProduct@1.0"
      },
      "DetailsDocument":
      {
        "ProductTitle": "My Product Title",
        "ShortDescription": "My product short description.",
        "LongDescription": "My product longer description.",
        "Sku": "123example456",
        "LogoUrl": "https://awsmp-logos.s3.amazonaws.com/ca60b754fe05a24257176cdbf31c4e0d",
        "VideoUrls":
        [
          "https://example.com/my-video"
        ],
        "Highlights":
        [
          "123example45"
        ],
        "AdditionalResources":
        [
          {
            "Text": "123example456",
            "Url": "https://example.com/some-link"
          }
        ],
        "SupportDescription": "Need help? Contact our experts at support@example.com \n\nYour purchase includes 24x7 support.",
        "Categories":
        [
          "Operating Systems",
          "Network Infrastructure",
          "Application Development"
        ],
        "SearchKeywords":
        [
          "123example456"
        ]
      }
    }
  ]
}

필드에 대한 정보를 제공하여 UpdateInformation 변경 유형을 추가합니다.

Entity (객체)(필수) - 생성 중인 명명된 엔터티 유형입니다.
- Identifier (문자열)(필수) - 제품 ID입니다. 자세한 내용은 식별자 단원을 참조하십시오.
- Type (문자열)(필수) - Type는 제품이 사용할 전송 방법(제품 유형)을 기반으로 합니다. AmiProduct@1.0, ContainerProduct@1.0MachineLearningProduct@1.0, 또는 SaaSProduct@1.0.
DetailsDocument (객체)(필수) - 제품에 대해 업데이트하려는 정보를 포함한 요청의 세부 정보입니다. 각 필드는 선택 사항이지만 업데이트할 변경 사항을 하나 이상 포함해야 합니다.
- ProductTitle (문자열) - 구매자에게 표시할 제품의 이름입니다.
- ShortDescription (문자열) - 구매자에게 표시할 제품의 주요 측면에 대한 설명입니다. 이는 일반적으로 2~3개의 문장입니다.
- LongDescription (문자열) - 구매자에게 표시할 제품에 대한 더 긴 설명입니다. 이는 일반적으로 1~3개의 단락입니다.
- Sku (문자열 또는 null) - 사용자가 직접 사용하기 위한 참조로 정의하는 자유 형식 문자열입니다. null를 사용하여이 필드의 설정을 해제합니다.
- LogoUrl (문자열) - 공개적으로 액세스할 수 있는 Amazon Simple Storage Service(Amazon S3) 버킷의 이미지에 대한 URL입니다. 자세한 내용은 회사 및 제품 로고 요구 사항을 참조하세요.
- VideoUrls (문자열 배열) - 제품 정보에서 구매자에게 참조로 제공할 공개적으로 사용 가능한 외부 호스팅 비디오의 URLs 목록입니다.
  
  참고
  현재는 배열에서 하나의 URL을 AWS Marketplace지원합니다.
- Highlights (문자열 배열) - 주요 제품 기능에 대한 짧은 콜아웃 목록입니다.
- AdditionalResources (구조 배열) - 제품에 대해 알아볼 수 있는 추가 리소스에 대한 참조 목록입니다. 각 참조는 텍스트 이름과 URL로 구성됩니다.
  - Text (문자열) - 리소스의 이름 또는 제목입니다.
  - Url (문자열) - 구매자가 제품을 이해하는 데 도움이 될 수 있는 리소스의 URL입니다.
- SupportDescription (문자열) - 제품에 대한 지원 제공에 대한 세부 정보입니다.
- Categories (문자열 배열) - 제품을 설명하는 정의된 제품 범주 목록AWS Marketplace입니다. 자세한 내용은 AWS Marketplace 구매자 안내서의 제품 범주를 참조하세요.
- SearchKeywords (문자열 배열) - 검색 환경을 개선하기 위한 제품의 키워드 목록입니다. 판매자 이름, 제품 이름 및 제품 범주는 검색 키워드에 자동으로 포함되므로 여기에서 반복할 필요가 없습니다.

참고

Draft 제품에 대한 제품 정보(메타데이터)를 처음 채울 때는 UpdateInformation 변경 유형의 DetailsDocument 객체에 ProductTitle, , ShortDescription, LongDescription, LogoUrl, HighlightsAdditionalResources, SupportDescription, 및 Categories를 모두 제공해야 합니다SearchKeywords.

CreateProduct 변경 유형 중에 이미 제공된 경우를 생략할 ProductTitle 수 있습니다. 그러나 제품의 기존 필드를 업데이트할 때 변경 유형의 DetailsDocument 객체에 UpdateInformation 변경해야 하는 속성만 포함할 수 있습니다.

응답 구문

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


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

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

요청 상태를 확인하려면를 사용하거나 DescribeChangeSet API를 AWS Marketplace Management Portal호출합니다.

동기 검증

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

입력 필드	검증 규칙	HTTP 코드
문자열(일반)	제어 문자 "\\x00-\\x08\\x0B-\\x1F" 없음	400
ProductTitle(문자열)	최대 길이: 72 필수	400
ShortDescription(문자열)	최대 길이: 1000 필수	400
LongDescription(문자열)	최대 길이: 5000 필수	400
Sku(문자열)	최대 길이: 100 선택 사항	400
LogoUrl(문자열)	URL 패턴: ^https://(www\.)?[-a-zA-Z0- 9@.]{1,256}\.[a-zA-Z0-9()]{2,63}\b([-a-zA- Z0-9@+./]*) 필수	400
VideoUrls(문자열 배열)	URL 패턴: https://(www\\.)?[-a-zA-Z0- 9@._]{1,256}\\.[a-zA-Z0-9()]{2,63}\\b([-a-zA-Z0-9@_+.\/] 선택 사항	400
강조 표시(문자열 배열)	필수: 최소 1~최대 3	400
AdditionalResources(구조 배열)	최대 길이: 500 선택 사항	400
SupportDescription(문자열)	최대 길이: 2000 필수	400
범주(문자열 배열)	최소 1~최대 3 필수	400
SearchKeywords(문자열 배열)	최소 1~최대 15 각 항목에 대해 최대 50자 필수	400

비동기 오류

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

오류 코드	오류 메시지
누락_데이터	`업데이트를 수행하기 위해 제공된 데이터가 없습니다. 제품의 하나 이상의 필드에 대한 데이터를 제공합니다.`
INVALID_INPUT	`LogoUrl을 제공합니다.`
INVALID_INPUT	`ProductTitle을 제공합니다.`
INVALID_INPUT	`ShortDescription을 제공합니다.`
INVALID_INPUT	`LongDescription을 제공합니다.`
INVALID_INPUT	`SupportDescription을 제공합니다.`
INVALID_INPUT	`하나 이상의 검색 키워드를 제공합니다.`
INVALID_INPUT	`하나 이상의 강조 표시를 제공합니다.`
INVALID_INPUT	`1~3개의 제품 범주를 제공합니다.`
INVALID_INPUT	`ProductTitle 필드에 부적절한 콘텐츠 '{InappropriateContent}'가 있습니다. ProductTitle에 부적절한 콘텐츠를 제공하지 않습니다.`
INVALID_INPUT	`ShortDescription 필드에 부적절한 콘텐츠 '{InappropriateContent}'가 있습니다. 부적절한 콘텐츠 없이 ShortDescription을 제공합니다.`
INVALID_INPUT	`LongDescription 필드에 부적절한 콘텐츠 '{InappropriateContent}'가 있습니다. 부적절한 콘텐츠 없이 LongDescription을 제공합니다.`
INVALID_INPUT	`SupportDescription 필드에 부적절한 콘텐츠 '{InappropriateContent}'가 있습니다. 부적절한 콘텐츠 없이 SupportDescription을 제공합니다.`
INVALID_INPUT	`ProductTitle 필드가 잘못되었습니다. 상표 기호 앞에 공백을 제거합니다.`
INVALID_INPUT	`ShortDescription 필드가 잘못되었습니다. 상표 기호 앞에 공백을 제거합니다.`
INVALID_INPUT	`잘못된 LongDescription 필드입니다. 상표 기호 앞에 공백을 제거합니다.`
INVALID_INPUT	`잘못된 SupportDescription 필드입니다. 상표 기호 앞에 공백을 제거합니다.`
INVALID_INPUT	`ProductTitle 필드가 잘못되었습니다. 지원되지 않는 문자[UnsupportedCharacters 제거합니다.`
INVALID_INPUT	`ShortDescription 필드가 잘못되었습니다. 지원되지 않는 문자[UnsupportedCharacters 제거합니다.`
INVALID_INPUT	`잘못된 LongDescription 필드입니다. 지원되지 않는 문자[UnsupportedCharacters 제거합니다.`
INVALID_INPUT	`잘못된 SupportDescription 필드입니다. 지원되지 않는 문자[UnsupportedCharacters 제거합니다.`
INVALID_INPUT	`검색 키워드는 250자를 초과할 수 없습니다.`
INVALID_INPUT	`이 변경 유형에 대한 입력을 읽을 수 없습니다. 올바른 형식의 입력을 제출합니다.`
INVALID_ADDITIONAL_RESOURCES	`AdditionalResources의 잘못된 URLs: [InvalidAdditionalResourcesUrls] 유효한 URLs 제공합니다.`
INVALID_CATEGORY_NAMES	`에서 지원하는 유효한 범주 이름을 제공합니다AWS Marketplace.`
InvalidImageProperties	`확인 오류 발견: 파일이 이미지 유형이 아닙니다. 지원되는 이미지 유형: [png\|jpg\|gif].`
EXPLICIT_CONTENT	`명시적 콘텐츠: '{ExplicitContent}'가 감지되었습니다. 미디어에 명시적 콘텐츠를 제공하지 않습니다.`
INVALID_MEDIA	`잘못된 URL: {MediaUrl} S3에 저장된 미디어의 새 URL을 제공합니다.`
INVALID_MEDIA	`잘못된 URL: {MediaUrl} 2048자를 초과하지 않는 유효한 URL을 제공합니다.`
INVALID_MEDIA	`제공된 위치에 액세스할 수 없음: {MediaUrl} S3에 저장된 미디어에 대한 액세스 가능한 URL을 제공합니다.`
INVALID_MEDIA	`S3에서 미디어를 복사하는 동안 문제가 발생했습니다. 이미지 크기가 5MB를 초과합니다. 5MB 미만의 이미지를 제공합니다.`
INVALID_MEDIA	`미디어에서 맬웨어가 감지되었습니다. 맬웨어 없이 미디어를 다시 제출하십시오.`
TOO_MANY_MEDIA	`15개 이하의 미디어 항목을 제공합니다.`
DUPLICATE_MEDIA	`제품에 중복 미디어를 사용할 수 없습니다. 중복이 없는 미디어를 제공하십시오.`

요금 차원 추가

AWS Marketplace 카탈로그 서비스 작업을 사용하여 사용자에게 AMI, 컨테이너 또는 SaaS 제품에 대한 요금을 청구할 수 있는 청구 가능한 요금 차원을 추가할 수 있습니다.

요금 차원은 판매자가 구매자에게 청구하기 위해 정의하는 측정 단위입니다. 판매자는 사용량 기반 요금 모델이든 계약 기반 요금 모델이든 상관없이 제품 사용에 대한 요금을 구매자에게 청구하도록이 정보를 설정해야 합니다. 차원 유형은 제품의 요금 모델에 따라 다릅니다.

참고

무료 요금 모델이 있는 SaaS 제품의 경우 UsageBasedPricingTerm 또는 ConfigurableUpfrontPricingTerm을 사용하여 차원을 하나 이상 생성해야 하며 모든 차원의 가격은 0.00 USD여야 합니다. 이 요구 사항은 SaaS 제품에 고유하며 AMI, 컨테이너 또는 기계 학습 제품에 적용되지 않습니다.

참고

새로운 요금 차원은 SaaS 구매자에게 다음과 같은 영향을 미칩니다.

공개 제안에서 생성된 계약이 있는 구매자의 경우 계약이 생성될 때 제안에 존재하지 않았더라도 새 차원에 대한 소비를 보고할 수 있습니다.
비공개 제안에서 생성된 계약이 있는 구매자의 경우 계약이 생성될 때 비공개 제안에 존재하지 않았기 때문에 새 차원에 대한 소비를 보고할 수 없습니다. BatchMeterUsage API 호출은 성공하지만 구매자에게 요금이 청구되지 않으므로 어떤 구매자에게 새로운 차원에 대한 요금이 청구될 수 있는지, 청구될 수 없는지 추적해야 합니다. GetAgreementTerms API를 사용하여 각 구매자 계약에 포함된 차원을 볼 수도 있습니다.

새 차원에 대한 소비를 보고하고 구매자에게 청구하려면 차원이 포함된 대체 제안을 연장해야 하며 구매자는 제안을 수락해야 합니다.

제품 요금에 대한 자세한 내용은 AWS Marketplace판매자 안내서의 다음 주제를 참조하세요.

를 사용하여 요금 차원을 추가하는 방법에 대한 자세한 내용은 AWS Marketplace판매자 안내서의 다음 주제를 AWS Marketplace Management Portal참조하세요.

AMI 기반 제품: 요금 업데이트.
컨테이너 기반 제품: 요금 차원 추가.
SaaS 기반 제품: 요금 차원을 추가합니다.
ML 제품: 지원되지 않습니다. 기계 학습 제품에는 고정 요금 차원이 있습니다. 하지만 요금을 업데이트할 수 있습니다.

요금 차원을 추가하려면 다음 예제와 같이 AddDimensions 변경 유형으로 StartChangeSet API를 호출합니다.

참고

사용량, 계약 또는 소비 계약 등 요금 모델의 유형을 지정하는 차원이 있는 첫 번째 AddDimensions 변경 유형을 제출한 후에는 AWS Marketplace판매자 운영 팀과 협력해야 합니다. 이를 통해 원래 요금 모델을 벗어나는 유형의 차원을 추가할 수 있습니다.

요청 구문


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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "AddDimensions",
      "DetailsDocument":
      [
        {
          "Description": "Description of the dimension",
          "Key": "UniqueApiKey",
          "Unit": "HostHrs",
          "Name": "First Dimension",
          "Types":
          [
            "ExternallyMetered"
          ]
        }
      ],
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "SaaSProduct@1.0"
      }
    }
  ]
}

AddDimensions 변경 유형에 대해 다음 필드를 제공합니다.

DetailsDocument (객체 배열)(필수) - 요청의 세부 정보입니다.

Description (문자열)(필수) - 구매자 보기 페이지의 긴 설명인 차원의 전체 세부 정보입니다.
Key (문자열)(필수) - 제안에서 요금을 정의하는 데 사용할 패싯에를 입력합니다. 또한 차원을 외부에서 측정할 수 없는 경우 AWS Marketplace Metering Service(MMS)에 게시된 차원을 입력합니다. 차원이 생성된 후에는 변경할 수 없습니다.
Units (문자열)(필수) - 차원의 단위 유형입니다. 가능한 단위는 사용자, 호스트, GB, MB, TB, Gbps, Mbps, 요청, 단위, UserHrs, UnitHrs, Units, HostHrs, TierHrs 및 TaskHrs.

Name (문자열)(필수) - 웹 사이트의 차원 및 고객의 청구서에 대한 표시 이름입니다.

Types (문자열 배열)(필수)(태그라고도 함) - 차원이 측정, 권한 부여 또는 외부 측정 지원을 포함하는지 여부를 나타냅니다. 차원이 생성된 후에는 변경할 수 없습니다.

Metered -이 차원에 대해 측정이 발생할 수 있도록 상거래 플랫폼 사용 유형을 생성해야 함을 나타냅니다.
ExternallyMetered - 판매자가 AWSSDK를 통해 AWS Marketplace측정할 수 있도록 게시 중에 측정 서비스(MMS) 차원을 생성해야 함을 나타냅니다.

Entitled - 제품 또는 제안 게시 중에 차원에 대한 권한을 부여할 수 있음을 나타냅니다.

다음 표에는 지원되는 요금 차원 및 제품 조합이 나열되어 있습니다.

요금 차원 유형	제품 유형
[`Metered`]	AMI
[`Metered, ExternallyMetered`]	SaaS, AMI/유연 소비 요금(FCP) `ExternallyMetered`이 나타나면 `Metered`가 마스킹/유추됩니다.
[`Entitled`]	SaaS 계약, ProServ 제품 `Entitled` 태그는 사용에 대한 소프트웨어/서비스 시작일 및 종료일을 사용할 수 있는 권한을 부여합니다. 또한 AMI 연간 제품에 대한 사용 할인을 받을 수 있는 권한을 부여합니다. 각 권한은 권한을 생성하거나 업데이트하기 AWS Marketplace Entitlement Service위해 `Dimension Key`의 로 식별됩니다.
[`Metered, ExternallyMetered, Entitled`]	차원을 선불하거나 측정할 수 있는 소비 요금이 적용되는 계약은 [`ExternallyMetered`]와 []의 조합입니다`Entitled`.

Entity (객체)(필수) - 생성 중인 명명된 엔터티 유형입니다.
- Identifier (문자열)(필수) - 제품 ID입니다. 자세한 내용은 식별자 단원을 참조하십시오.
- Type (문자열)(필수) - Type는 제품이 사용할 전송 방법(제품 유형)을 기반으로 합니다SaaSProduct@1.0. AmiProduct@1.0 또는 .

응답 구문

요청에 대한 변경 세트가 생성됩니다. 이 요청에 대한 응답은 변경 세트에 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를 통해 직접 요청 상태를 확인할 수 있습니다.

동기 검증

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

입력 필드	검증 규칙	HTTP 코드
설명	최대 길이: 1000 필수	400
Key(키)	최대 길이: 100 패턴: [A-Za-z0-9_.-]+$ 필수	400
차원 단위	최대 길이: 20 필수	400
이름	최대 길이: 500 필수	400
유형(태그)	필수: 최소 1~최대 3 입력: Entitled, Metered, ExternallyMetered 필수	400

비동기 오류

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

오류 코드	오류 메시지
누락_데이터	`업데이트를 수행하기 위해 제공된 데이터가 없습니다. 1개 이상의 차원에 대한 데이터를 제공합니다.`
INVALID_DIMENSION	`차원을 200개 이하로 제공하십시오.`
INVALID_DIMENSION	`중복 차원을 추가할 수 없습니다.`
INVALID_DIMENSION	`현재 상태 '%s'에서는 차원을 추가할 수 없습니다. 차원 업데이트를 지원하는 상태는 %s입니다.`
INVALID_DIMENSION	`차원을 추가할 수 없습니다. '%s' 필드에 다른 차원의 중복 값 '%s'가 있습니다.`
INVALID_DIMENSION	`각 차원에 대해 비어 있지 않은 필드(키, 단위, 이름, 유형)를 제공합니다.`
IINVALID_TYPE	`잘못된 유형 '%s'를 제거합니다. 유효한 유형은 ["Metered", "Entitled", "ExternallyMetered"]입니다.`
INVALID_UNIT	`잘못된 단위 '%s'를 제거합니다. 유효한 단위는 ["GB", "Gbps", "HostHrs", "Hosts", "MB", "Mbps", "Requests", "TaskHrs", "TB", "TierHrs", "UnitHrs", "Units", "UserHrs", "Users"]입니다.`
INVALID_INPUT	`%s 필드에 부적절한 '%s' 콘텐츠가 있습니다. %s에 부적절한 콘텐츠를 제공하지 않습니다.`
INVALID_INPUT	`'%s' 필드가 잘못되었습니다. 상표 기호 앞에 공백을 제거합니다.`
INVALID_INPUT	`'%s' 필드가 잘못되었습니다. 지원되지 않는 문자 %s를 제거합니다.`
INVALID_DIMENSION	`잘못된 차원 유형 조합 %s를 제거합니다. 허용되는 값은 %s입니다.`
INVALID_DIMENSION	`측정된 차원에 대해 잘못된 차원 키 '%s'를 제거합니다.`
INVALID_DIMENSION	`productCode '%s'에 대해 '%s'라는 차원이 AWS Marketplace측정 서비스 검증 %s를 통과하지 못했습니다.`
INVALID_DIMENSION	`productCode '%s'에 대해 '%s'라는 차원에는 측정 서비스에 측정 레코드가 없습니다. 제품이 테스트를 위해 시작된 적이 없거나 잘못 구성되었으며 AWS Marketplace측정 서비스에 적절한 호출을 하지 않습니다.`

요금 차원 업데이트

카탈로그 API를 사용하여 AMI, 컨테이너 또는 SaaS 제품의 기존 요금 차원을 업데이트할 수 있습니다AWS Marketplace.

각 차원은 업데이트를 수행할 차원 키 및 차원 유형으로 고유하게 식별됩니다. 차원을 업데이트해도 원래 차원이 생성한 활성 제안이나 고객에게는 영향을 주지 않습니다.

참고

를 사용하여 요금 차원을 업데이트하는 방법에 대한 자세한 내용은 AWS Marketplace판매자 안내서의 다음 주제를 AWS Marketplace Management Portal참조하세요.

AMI 기반 제품: 요금 업데이트
컨테이너 기반 제품: 차원 정보 업데이트
SaaS 기반 제품: 요금 차원 업데이트
기계 학습 제품: 제품 요금 업데이트

요금 차원을 업데이트하려면 다음 예제와 같이 UpdateDimensions 변경 유형으로 StartChangeSet API 작업을 호출합니다.

요청 구문


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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateDimensions",
      "DetailsDocument":
      [
        {
          "Key": "UniqueApiKey",
          "Types":
          [
            "ExternallyMetered"
          ],
          "Name": "First Dimension",
          "Description": "Description of the dimension"
        }
      ],
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "SaaSProduct@1.0"
      }
    }
  ]
}

다음 필드를 UpdateDimensions 변경 유형과 함께 사용합니다.

DetailsDocument (객체 배열)(필수) - 요청의 세부 정보입니다.

Key (문자열)(필수) - 제품에서 기존 차원의 키를 제공하여 설명과 이름을 변경합니다. 의 경우 UpdateDimension이 필드는 변경할 차원을 식별하기 위한 것입니다.

Types (문자열 배열)(필수)(태그라고도 함) - 차원이 측정, 권한 부여 또는 외부 측정 지원을 포함하는지 여부를 나타냅니다. 차원이 생성된 후에는 변경할 수 없습니다.

Metered -이 차원에 대해 측정이 발생할 수 있도록 상거래 플랫폼 사용 유형을 생성해야 함을 나타냅니다.
ExternallyMetered - 판매자가 AWSSDK를 통해 측정할 수 있도록 게시 중에 AWS Marketplace Metering Service(MMS) 차원을 생성해야 함을 나타냅니다.

Entitled - 제품/제안 게시 중에 차원에 대한 권한을 부여할 수 있음을 나타냅니다.

유효한 요금 차원 유형 조합
요금 차원 유형	제품
[`Metered`]	AMI
[`ExternallyMetered`]	SaaS, AMI/유연 소비 요금(FCP) `ExternallyMetered`가 나타나면 측정됨이 마스킹/유추됩니다.
[`Entitled`]	SaaS 계약, ProServe 제품 `Entitled` 태그는 사용에 대한 소프트웨어/서비스 세트 시작 및 종료 날짜를 사용할 수 있는 권한을 부여합니다. 또한 AMI 연간 제품에 대한 사용 할인을 받을 수 있는 권한을 부여합니다. 각 권한은 권한을 생성하거나 업데이트하기 AWS Marketplace Entitlement Service위해의 차원 키로 식별됩니다.
[`ExternallyMetered, Entitled`]	차원을 선불하거나 측정할 수 있는 소비 요금이 적용되는 계약은 [`ExternallyMetered`]와 []의 조합입니다`Entitled`.

Description (문자열) (선택 사항 - 구매자 보기 페이지의 긴 설명인 차원에 대한 전체 설명입니다.
Name (문자열) 선택 사항 - 웹 사이트의 차원 및 고객의 청구서에 대한 DIsplay 이름입니다.

Entity (객체)(필수) - 생성 중인 명명된 엔터티 유형입니다.
- Identifier (문자열)(필수) - 제품 ID입니다. 자세한 내용은 식별자 단원을 참조하십시오.
- Type (문자열)(필수) - Type는 제품이 사용할 전송 방법(제품 유형)을 기반으로 합니다SaaSProduct@1.0. AmiProduct@1.0 또는 .

응답 구문

요청에 대한 변경 세트가 생성됩니다. 이 요청에 대한 응답은 변경 세트에 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를 통해 직접 요청 상태를 확인할 수 있습니다.

동기 검증

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

입력 필드	검증 규칙	HTTP 코드
설명	최대 길이: 1000 필수	400
Key(키)	최대 길이: 100 패턴: [A-Za-z0-9_.-]+$ 필수	400
이름	최대 길이: 5 필수	400
유형(태그)	필수: 최소 1~최대 3 입력: `Entitled`, `Metered`, `ExternallyMetered` 필수	422

비동기 오류

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

오류 코드	오류 메시지
INVALID_INPUT	`'%s' 필드가 잘못되었습니다. 상표 기호 앞에 공백을 제거합니다.`
INVALID_INPUT	`'%s' 필드가 잘못되었습니다. 지원되지 않는 문자 %s를 제거합니다.`
INVALID_DIMENSION	`각 차원에 대해 비어 있지 않은 필드(Key, Types Name 및/또는 Description)를 제공합니다.`
INVALID_DIMENSION	`차원을 업데이트할 수 없습니다. 필드에 다른 차원의 중복 값 '%s'Name가 있습니다.`
INVALID_DIMENSION	`동일한 요청에서 키 '%s' 및 유형 '%s'로 동일한 차원을 여러 번 업데이트할 수 없습니다.`
INVALID_DIMENSION	`차원을 제한할 수 없습니다. 유형이 '%s'인 차원 키 '%s'가 존재하지 않습니다.`
INVALID_DIMENSION	`차원을 업데이트할 수 없습니다. 차원 키 '%s'는 입니다Metered.`
INVALID_DIMENSION	`이미 제한된 차원에 대해서는 차원을 업데이트할 수 없습니다.`

요금 차원 제한

카탈로그 API를 사용하여 AMI 또는 SaaS 제품의 기존 요금 차원을 제한할 수 있습니다AWS Marketplace.

각 차원은 업데이트를 수행할 차원 키 및 차원 유형으로 고유하게 식별됩니다. 차원을 제한해도 원래 차원이 생성한 활성 제안이나 고객에게는 영향을 주지 않습니다.

요금 차원을 제한하려면 RestrictDimensions 변경 유형으로 StartChangeSet API를 호출합니다.

참고

요금 차원 제한은 제품이 초안 상태인 경우에만 사용할 수 있습니다. 제품이 제한 또는 공개 상태로 전환되면 변경이 허용되지 않습니다.

다음 예제에서는 SaaS 제품의 Entitled차원을 제한하는 방법을 보여줍니다.

요청 구문


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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "RestrictDimensions",
      "DetailsDocument":
      [
        {
          "Key": "UniqueApiKey",
          "Types": ["Entitled"]
        }
      ],
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "SaaSProduct@1.0"
      }
    }
  ]
}

다음 필드를 RestrictDimensions 변경 유형과 함께 사용합니다.

DetailsDocument (객체 배열)(필수) - 요청의 세부 정보입니다.
- Key (문자열)(필수) - 설명과 이름을 변경할 제품의 기존 차원의 키를 제공합니다. 의 경우 RestrictDimensions이 필드는 변경할 차원을 식별하기 위한 것입니다.
- Types (문자열 배열)(필수)(태그라고도 함) - 차원이 측정, 권한 부여 또는 외부 측정 지원을 포함하는지 여부를 나타냅니다. 차원이 생성된 후에는 변경할 수 없습니다.
  - ["ExternallyMetered", "Entitled"] - SaaS 계약에 대한 이러한 유형만 차원을 선불하거나 측정할 수 있는 소비 요금과 결합할 수 있습니다.
  - ["Metered"] - AMI 제품의 시간당 요금 차원입니다. 이 차원에 대해 측정이 이루어질 수 있도록 상거래 플랫폼 사용 유형을 생성해야 함을 나타냅니다.
  - ["ExternallyMetered"] - AMI, 컨테이너 및 SaaS 제품의 유연한 소비 요금 차원(사용자 지정 측정이라고도 함)입니다. 판매자가AWS SDK를 통해AWS 측정할 수 있도록 게시 중에 Marketplace 측정 서비스(MMS) 차원을 생성해야 함을 나타냅니다.
  - ["Entitled"] - SaaS 계약 및 전문 서비스 제품의 계약 요금 차원. 이 태그는 소프트웨어 또는 서비스를 사용할 수 있는 권한을 부여하고, 사용 시작 및 종료 날짜를 설정하고, AMI 연간 제품에 대한 사용 할인 권한을 부여합니다. 각 권한은 권한을 생성하고 업데이트하기 AWS Marketplace Entitlement Service위해의 차원 키로 식별됩니다. 키는 제품 및 제안 게시 중에 차원에 대한 권한을 부여할 수 있음을 나타냅니다.
Entity (객체)(필수) - 생성 중인 명명된 엔터티 유형입니다.
- Identifier (문자열)(필수) - 제품 ID입니다. 자세한 내용은 식별자 단원을 참조하십시오.
- Type (문자열)(필수) - Type는 제품의 제공 방법(제품 유형): AmiProduct@1.0 또는를 기반으로 합니다SaaSProduct@1.0.

응답 구문

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


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

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

를 통해 AWS Marketplace Management Portal또는 DescribeChangeSet API를 호출하여 요청 상태를 확인할 수 있습니다.

동기 검증

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

입력 필드	검증 규칙	HTTP 코드
설명	최대 길이: 1000 필수	400
Key(키)	최대 길이: 100 패턴: [A-Za-z0-9_.-]+$ 필수	400
이름	최대 길이: 5 필수	400
유형(태그)	필수: 최소 1~최대 3 입력: `Entitled`, `Metered`, `ExternallyMetered` 필수	400

비동기 오류

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

오류 코드	오류 메시지
INVALID_INPUT	`'%s' 필드가 잘못되었습니다. 상표 기호 앞에 공백을 제거합니다.`
INVALID_INPUT	`'%s' 필드가 잘못되었습니다. 지원되지 않는 문자 %s를 제거합니다.`
INVALID_DIMENSION	`유형이 '%s'인 차원 키 '%s'가 이미 제한되었습니다.`
INVALID_DIMENSION	`차원을 제한할 수 없습니다. 유형이 '%s'인 차원 키 '%s'가 존재하지 않습니다.`
INVALID_DIMENSION	`중복 차원을 제한할 수 없습니다.`
INVALID_DIMENSION	`모든 권한 있는 차원은 제한할 수 없습니다. 하나 이상의 활성 권한 있는 차원이 있어야 합니다.`
INVALID_DIMENSION	`유형이 '%s'인 차원 키 '%s'는 유형이 '%s'인 다른 차원과 연결됩니다. 동일한 키의 두 차원을 동시에 제한해야 유효합니다.`

대상 지정 구성 업데이트

Catalog API를 사용하여 UpdateTargeting 변경 유형을 호출하여 Public 상태로 이동하기 AWS Marketplace전에에서 AMI, 컨테이너, ML 또는 SaaS 제품을 볼 수 있는 AWS 계정IDs를 추가할 수 있습니다.

새 제품이 생성되면 관리형 카탈로그 작업(MCO) 계정이 허용된 계정 목록에 자동으로 추가됩니다. 이러한 MCO 계정은 허용된 계정을 볼 때 AWS Marketplace관리 포털(AMMP)과 DescribeEntity API 응답의 Targeting 섹션에서 판매자에게 표시됩니다.

참고

를 사용하여 AWS 계정IDs 추가하는 방법에 대한 자세한 내용은 AWS Marketplace판매자 안내서의 다음 주제를 AWS Marketplace Management Portal참조하세요.

AMI, 컨테이너, ML 또는 SaaS 제품을 볼 수 있는 AWS 계정IDs를 추가하려면 다음 예제와 같이 UpdateTargeting 변경 유형을 사용하여 StartChangeSet API 작업을 호출합니다.

요청 구문


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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateTargeting",
      "Entity":
      {
        "Type": "SaaSProduct@1.0",
        "Identifier": "prod-example12345"
      },
      "DetailsDocument":
      {
        "PositiveTargeting":
        {
          "BuyerAccounts":
          [
            "1112223334444"
          ]
        }
      }
    }
  ]
}

다음 필드를 UpdateTargeting 변경 유형과 함께 사용합니다.

Entity (객체)(필수) - 생성 중인 명명된 엔터티 유형입니다.
- Identifier (문자열)(필수) - 제품 ID입니다. 자세한 내용은 식별자 단원을 참조하십시오.
- Type (문자열)(필수) - Type는 제품이 사용할 전송 방법(제품 유형)을 기반으로 합니다SaaSProduct@1.0. AmiProduct@1.0, MachineLearningProduct@1.0또는 .
DetailsDocument (객체)(필수) - ChangeSet를 실행하는 데 필요한 세부 정보입니다.
- PositiveTargeting (객체) (선택 사항) - 긍정적인 타겟팅은 구매자의 프로필이 제안에 액세스할 수 있도록 허용하기 위해 충족해야 하는 기준을 정의합니다. 이 필드는 선택 사항이지만이 필드가 있는 경우 하나 이상의 대상 지정 옵션을 제공해야 합니다.
  - BuyerAccounts (문자열 배열)(선택 사항) - AWS 계정을 기반으로 대상 지정을 허용하는 옵션으로 나열합니다(프라이빗 제안이라고도 함). AWS 계정에 대한 제안을 대상으로 지정하지 않으려는 경우이 필드를 생략해야 합니다.

응답 구문

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


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

요청 상태를 확인하려면를 사용하거나 DescribeChangeSet API를 AWS Marketplace Management Portal호출합니다.

요청이 완료되면(가 Status인 경우SUCCEEDED) 새 ProductId가 생성됩니다.

동기 검증

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

대상 지정 유형 유효한 현재 가시성 상태 BuyerAccounts(입력) Check]를 선택합니다

긍정적:

대상 지정 유형	유효한 현재 가시성 상태	BuyerAccounts(입력)	Check]를 선택합니다
긍정적:	퍼블릭, `Limited`또는 `Draft`	12자리 AWS 계정ID 문자열 배열입니다. 최소 크기: 0. 최대 크기: 5000.	입력은 현재 문서 대상 계정과 달라야 합니다. 입력이 유효한 상태여야 합니다AWS 계정.

퍼블릭, Limited또는 Draft

12자리 AWS 계정ID 문자열 배열입니다.

최소 크기: 0.

최대 크기: 5000.

입력은 현재 문서 대상 계정과 달라야 합니다.

입력이 유효한 상태여야 합니다AWS 계정.

비동기 오류

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

오류 코드	오류 메시지
INVALID_PRODUCT_VISIBILITY	`기존 퍼블릭 Limited 또는 Draft 제품을 사용합니다.`
INVALID_AWS_ACCOUNT_IDS	`validAWS 계정IDs.AWS 계정not found를 제공합니다. [x, y, z].`
ValidationException	`전문 서비스 제품에는 허용 목록이 없습니다. 다른 제품 유형과 달리 제한된 상태의 전문 서비스 제품은 허용 목록 없이 모든 구매자에게 확장할 수 있습니다.`

제품 표시 여부 업데이트

카탈로그 API를 사용하여 AMI, 컨테이너, ML 또는 SaaS 제품의 가시성(수명 주기 상태라고도 함)을 업데이트할 수 있습니다AWS Marketplace.

참고

를 사용하여 제품 가시성을 업데이트하는 자세한 내용은 AWS Marketplace판매자 안내서의 다음 주제를 AWS Marketplace Management Portal참조하세요.

AMI 기반 제품: 제품 가시성 업데이트
컨테이너 기반 제품: 제품 가시성 업데이트
SaaS 기반 제품: 제품 가시성 업데이트
기계 학습 제품: 제품 가시성 업데이트

허용되는 대상 수명 주기 상태는 Limited, Public또는 입니다Restricted.

Limited: 제품이 완료되고 ReleaseProduct가 성공적으로 완료되었습니다ChangeType. 판매자는이 상태의 제품 세부 정보를 볼 수 있습니다. 제품은 공개되지 않습니다. 그러나 판매자는가 제품을 미리 볼 수 있도록 특정 구매자를 대상으로 지정할 수 있습니다.
Public: 제품이에 표시됩니다AWS Marketplace. 구매자는 제품을 보고 구독할 수 있습니다.
Restricted: 제품은 더 이상 일반에 공개되지 않으며 새 구독자를 수락하지 않습니다. 기존 구독자는 구독이 만료될 때까지이 제품을 계속 사용할 수 있습니다.

참고

UpdateVisibility 변경 유형을 사용하려면 AWS Marketplace판매자 운영 팀의 수동 검토가 필요하므로 실행 시간이 길어집니다. 자체 변경 세트에서 UpdateVisibility 별도로 사용합니다.

제품의 가시성을 업데이트하려면 다음 예제와 같이 UpdateVisibility 변경 유형으로 StartChangeSet API 작업을 호출합니다.

요청 구문

TargetVisibility가 Public 또는 인 경우 Limited.


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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateVisibility",
      "Entity":
      {
        "Type": "SaaSProduct@1.0",
        "Identifier": "prod-example12345"
      },
      "DetailsDocument":
      {
        "TargetVisibility": "Public"
      }
    }
  ]
}

TargetVisibility가 인 경우 입니다Restricted.


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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateVisibility",
      "Entity":
      {
        "Type": "SaaSProduct@1.0",
        "Identifier": "prod-example12345"
      },
      "DetailsDocument":
      {
        "TargetVisibility": "Restricted",
        "ReplacementProductId": "prod-example54321"
      }
    }
  ]
}

UpdateVisibility 변경 유형을 추가할 필드에 대한 정보를 제공합니다.

Entity (객체)(필수) - 생성 중인 명명된 엔터티 유형입니다.
- Identifier (문자열)(필수) - 제품 ID입니다. 자세한 내용은 식별자 단원을 참조하십시오.
- Type (문자열)(필수) - Type는 제품이 사용할 전송 방법(제품 유형)을 기반으로 합니다MachineLearningProduct@1.0. AmiProduct@1.0, SaaSProduct@1.0, ContainerProduct@1.0, . 자세한 내용은 식별자 단원을 참조하십시오.
DetailsDocument (객체)(필수) -를 실행하는 데 필요한 세부 정보입니다ChangeSet.
- - TargetVisibility - 제품의 의도한 새로운 가시성입니다.
    
    가능한 값: Public, Limited 및 Restricted
  - ReplacementProductId (문자열) (선택 사항) - 제품의 대체 제품 ID가 입니다Restricted. 현재 구독자에게 제품 제한에 대해 알리는 데 사용됩니다.
    
    에 Restricted 대해서만를 허용합니다TargetVisibility.

동기 검증

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

대상 지정 유형	유효한 현재 상태	ReplacementProductId(입력)	검증 검사
퍼블릭	`Limited` 및 `Restricted`	허용되지 않음	유효한 현재 상태
`Limited`	퍼블릭 및 `Restricted`	허용되지 않음	유효한 현재 상태
`Restricted`	퍼블릭 및 `Limited`	문자열(선택 사항)	ReplacementProductId는 기존 `Limited` 또는 퍼블릭 제품에 속해야 합니다.

이 변경 유형을 트리거한 후 완료하는 데 최대 37일이 걸릴 수 있습니다. 여기에는 AWS Marketplace판매자 운영 팀이 검토, 감사 및 승인해야 하는 시간이 포함됩니다. 제품을 제한할 때 AWS Marketplace판매자 운영 팀이 감사를 시작하기 CancelChangeSet전에를 호출하여 24시간 동안 마음이 바뀌어야 합니다. 자세한 내용은 CancelChangeSet 단원을 참조하십시오.

응답 구문

요청에 대한 변경 세트가 생성됩니다. 이 요청에 대한 응답은 변경 세트에 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) 새 ProductId가 생성됩니다.

비동기 오류

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

오류 코드	오류 메시지
INVALID_PRODUCT_STATE	`기존 Public, Limited또는 Restricted 제품을 사용합니다.`
INVALID_TARGET_VISIBILITY	`유효한 대상 가시성 상태 Public, Limited또는를 제공합니다Restricted.`
EMPTY_TARGET_VISIBILITY	`유효한 대상 가시성 상태 Public, 또는 Limited를 제공합니다Restricted.`
INVALID_REPLACEMENT_PRODUCT_ID	`기존 Public 또는 Limited 제품을 대체품으로 사용합니다.`
INVALID_REPLACEMENT_PRODUCT_ID	`대체 제품 ID는 제품을 제한할 때만 유효합니다.`
감사_오류	`MCO 수동 검토에 따라 다릅니다.`
MISSING_SELLER_PROFILE_INFORMATION	제품을 퍼블릭으로 업데이트하려면 먼저 판매자 계정에 퍼블릭 프로필을 추가해야 합니다.

제품 게시

카탈로그 API를 사용하여 Draft AMI, 컨테이너, ML 또는 SaaS 제품을 Limited 상태로 게시할 수 있습니다AWS Marketplace.

참고

AmiProduct@1.0 및 SaaSProduct@1.0의 경우 ReleaseProduct 변경 유형에는이 제품에 대해 생성된 해당 초안 퍼블릭 Offer@1.0엔터티의 ReleaseOffer 변경 유형이 포함되어야 합니다.

제품을 게시하려면 다음 예제와 같이 ReleaseProduct 변경 유형으로 StartChangeSet API 작업을 호출합니다.

요청 구문


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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "ReleaseProduct",
      "Entity":
      {
        "Type": "SaaSProduct@1.0",
        "Identifier": "prod-example12345"
      },
      "DetailsDocument": {}
    }
  ]
}

ReleaseProduct 변경 유형에 추가할 필드에 대한 정보를 제공합니다. 이 변경 유형은 파라미터 페이로드를 사용하지 않습니다.

Entity (객체)(필수) - 생성 중인 명명된 엔터티 유형입니다.
- Identifier (문자열)(필수) - 제품 ID입니다. 자세한 내용은 식별자 단원을 참조하십시오.
- Type (문자열)(필수) - Type는 제품이 사용할 전송 방법(제품 유형)을 기반으로 합니다MachineLearningProduct@1.0. AmiProduct@1.0, SaaSProduct@1.0, ContainerProduct@1.0, . 자세한 내용은 식별자 단원을 참조하십시오.
DetailsDocument (객체) (필수) - 빈 객체여야 합니다. 변경 유형은 세부 정보를 허용하지 ReleaseProduct 않습니다.

응답 구문

요청에 대한 변경 세트가 생성됩니다. 이 요청에 대한 응답은 변경 세트에 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를 통해 직접 요청 상태를 확인할 수 있습니다.

요청이 완료되면(가 Status인 경우SUCCEEDED) 새 ProductId가 생성됩니다.

비동기 오류

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

오류 코드	오류 메시지
VALIDATION_FAILED	`설명 정보를 제공합니다.`
VALIDATION_FAILED	`버전 정보를 제공합니다.`
VALIDATION_FAILED	`차원 정보를 제공합니다.`
VALIDATION_FAILED	`설명\|PromotionalResources\|SupportInformation 정보를 제공합니다.`

제품 ID 찾기

카탈로그 API를 사용하여 제품을 수정하려면 먼저 제품의 제품 ID를AWS Marketplace 가져와야 합니다. 서버 제품의 제품 ID를 찾는 방법에는 두 가지가 있습니다.

를 열고 판매자 계정으로 AWS Marketplace Management Portal로그인합니다. 제품 메뉴에서 서버 제품을 선택한 다음 관심 있는 제품을 선택합니다. 제품 ID는 제품 요약 섹션에 나열되어 있습니다.
EntityType AmiProduct 또는 ContainerProduct, MachineLearningProduct, 또는 SaaSProduct와 함께 ListEntities 작업을 사용하여 카탈로그 API를 통해 제품 IDs를 포함한 제품 목록을 DataProduct 가져옵니다.는 엔터티 유형의 버전(예: AmiProduct@1.0)을 포함하지 않도록 ListEntities 요구합니다.

참고

제품 ID는 제품이 게시된 후에만 사용할 수 있으며 최소한 사용자가 볼 수 있습니다AWS Marketplace. 제품을 처음 생성할 때 제품을 검토하고 완전히 생성하는 데 며칠이 걸릴 수 있습니다. 이 기간 동안에는 제품 ID를 사용할 수 없습니다.

다음 주제에서는 엔터티 ID, 제품 제목, 마지막 수정 날짜 또는 가시성을 기준으로 필터링하여 제품을 찾는 방법을 설명합니다.

제품 제목을 기반으로 제품 찾기

요청


POST /ListEntities HTTP/1.1
Content-Type: application/json
      
{
    "Catalog": "AWSMarketplace",
    "EntityType": "AmiProduct",
    "MaxResults": 10,
    "EntityTypeFilters": {
        "AmiProductFilters": {
            "ProductTitle": {
                "WildCardValue": "XYZ"
            }
        }
    }
}

응답



HTTP/1.1 200
Content-type: application/json

{ 
  "EntitySummaryList": [ 
    { 
      "EntityArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/AmiProduct/example-abcd-1234",
      "EntityId": "example1-abcd-1234-5ef6-7890abcdef12@1",
      "EntityType": "AmiProduct",
      "LastModifiedDate": "2018-02-27T13:45:22Z",
       "AmiProductSummary": {
            "ProductTitle": "ABC-XYZ-123",
            "Visibility": "Public"
       }
    } 
  ],
  "NextToken": "" 
}

마지막 수정 날짜를 기준으로 제품 찾기

요청


POST /ListEntities HTTP/1.1
Content-Type: application/json
      
{
    "Catalog": "AWSMarketplace",
    "EntityType": "AmiProduct",
    "MaxResults": 10,
    "EntityTypeFilters": {
        "AmiProductFilters": {
            "LastModifiedDate": {
                "DateRange": {
                    "BeforeValue": "2018-03-27T13:45:22Z",
                    "AfterValue": "2018-01-27T13:45:22Z"
                }
            }
        }
    }
}

응답



HTTP/1.1 200
Content-type: application/json

{ 
  "EntitySummaryList": [ 
    { 
      "EntityArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/AmiProduct/example-abcd-1234",
      "EntityId": "example1-abcd-1234-5ef6-7890abcdef12@1",
      "EntityType": "AmiProduct",
      "LastModifiedDate": "2018-02-27T13:45:22Z",
       "AmiProductSummary": {
            "ProductTitle": "ABC-XYZ-123",
            "Visibility": "Public"
       }
    } 
  ],
  "NextToken": "" 
}

제품 가시성을 기반으로 제품 찾기

요청


POST /ListEntities HTTP/1.1
Content-Type: application/json
      
{
    "Catalog": "AWSMarketplace",
    "EntityType": "AmiProduct",
    "MaxResults": 10,
    "EntityTypeFilters": {
        "AmiProductFilters": {
            "Visibility": {
                "ValueList": [
                    "Public"
                ]
            }
        }
    }
}

응답



HTTP/1.1 200
Content-type: application/json

{ 
  "EntitySummaryList": [ 
    { 
      "EntityArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/AmiProduct/example-abcd-1234",
      "EntityId": "example1-abcd-1234-5ef6-7890abcdef12@1",
      "EntityType": "AmiProduct",
      "LastModifiedDate": "2018-02-27T13:45:22Z",
       "AmiProductSummary": {
            "ProductTitle": "ABC-XYZ-123",
            "Visibility": "Public"
       }
    } 
  ],
  "NextToken": "" 
}

제품 제목, 마지막 수정 날짜 및 제품 가시성을 기반으로 제품 찾기

요청


POST /ListEntities HTTP/1.1
Content-Type: application/json
      
{
    "Catalog": "AWSMarketplace",
    "EntityType": "AmiProduct",
    "MaxResults": 10,
    "EntityTypeFilters": {
        "AmiProductFilters": {
            "LastModifiedDate": {
                "DateRange": {
                    "BeforeValue": "2018-03-27T13:45:22Z",
                    "AfterValue": "2018-01-27T13:45:22Z"
                }
            },
            "Visibility": {
                "ValueList": [
                    "Public"
                ]
            },
            "ProductTitle": {
                "ValueList": [
                    "ABC-XYZ-123"
                ]
            }
        }
    }
}

응답



HTTP/1.1 200
Content-type: application/json

{ 
  "EntitySummaryList": [ 
    { 
      "EntityArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/AmiProduct/example-abcd-1234",
      "EntityId": "example1-abcd-1234-5ef6-7890abcdef12@1",
      "EntityType": "AmiProduct",
      "LastModifiedDate": "2018-02-27T13:45:22Z",
       "AmiProductSummary": {
            "ProductTitle": "ABC-XYZ-123",
            "Visibility": "Public"
       }
    } 
  ],
  "NextToken": "" 
}

제품에 대한 추가 세부 정보 가져오기

DescribeEntity 작업과 함께 개체 ID를 사용하여 제품에 대한 추가 세부 정보를 얻을 수 있습니다.

요청


GET /DescribeEntity?catalog=AWSMarketplace&entityId=example-abcd-1234 HTTP/1.1

응답


HTTP/1.1 200
Content-type: application/json

{
   "DetailsDocument": {
        "ProductTitle": "ABC-XYZ-123",
        "ShortDescription": "My product short description.", 
        "LongDescription": "My product longer description.", 
        "Sku": "123example456", 
        "SupportDescription": "Need help? Contact our experts at support@example.com \n\nYour purchase includes 24x7 support.", 
        "Categories": [ 
            "Operating Systems", 
            "Network Infrastructure", 
            "Application Development" 
            ] 
   }
    "EntityArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/AmiProduct/example-abcd-1234",
    "EntityId": "example1-abcd-1234-5ef6-7890abcdef12@1",
    "EntityType": "AmiProduct",
    "LastModifiedDate": "2018-02-27T13:45:22Z",
}

설정 상태 및 오류 변경

AWS Marketplace카탈로그 API에서 판매자 제품을 변경하려면 변경하려는 변경 사항을 설명하는 변경 세트를 생성한 다음 StartChangeSet 작업을 사용하여 변경 사항을 시작합니다. 요청에 따라 요청 변경 사항을 완료하는 데 몇 분에서 몇 시간 또는 그 이상 걸릴 수 있습니다. 이 요청에 대한 응답은 다음과 같습니다.


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

변경 요청은 대기열에 추가되고 처리되며, 여기에는 제품 AWS Marketplace지침을 충족하는지 확인하기 위한 파일 및 정보 스캔이 포함됩니다. 변경 요청에 따라이 프로세스는 몇 분에서 며칠 정도 걸릴 수 있습니다. 를 통해 AWS Marketplace Management Portal또는 DescribeChangeSet 작업을 사용하여 카탈로그 API에서 요청 상태를 확인할 수 있습니다. 변경 세트에 대한 자세한 내용은 변경 세트 작업의 내용을 참조하세요.

요청 상태를 확인하려면 DescribeChangeSet 작업을 사용합니다.


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

{
   "Catalog": "AWSMarketplace",
   "ChangeSetID": "example123456789012abcdef"
}

이 호출의 결과는 다음과 같습니다(이 경우 컨테이너 제품에 새 버전을 추가하는 경우).


{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef",
  "ChangeSetName": "Submitted by 123456789012",
  "StartTime": "2020-10-27T22:21:26Z",
  "EndTime": "2020-10-27T22:32:19Z",
  "Status": "SUCCEEDED",
  "ChangeSet":
  [
    {
      "ChangeType": "AddDeliveryOptions",
      "Entity":
      {
        "Type": "ContainerProduct@1.0",
        "Identifier": "example-1234-abcd-56ef-abcdef12345678@4"
      },
      "Details": "{\"Version\": {\"VersionTitle\": \"1.1\",\"ReleaseNotes\": \"Minor bug fix\"},\"DeliveryOptions\": [{\"DeliveryOptionTitle\": \"EKSDelivery\",\"Details\": {\"EcrDeliveryOptionDetails\" : {\"ContainerImages\": [\"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1\"],\"DeploymentResources\": [{\"Name\": \"HelmDeploymentTemplate\",\"Url\": \"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1\"}],\"CompatibleServices\": [\"EKS\"],\"Description\": \"Sample Description\",\"UsageInstructions\":\"helm pull 111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1\"}}},{\"DeliveryOptionTitle\": \"HelmChartDeliveryOption\",\"Details\": {\"HelmDeliveryOptionDetails\": {\"CompatibleServices\": [\"EKS\", \"EKS-Anywhere\"],\"ContainerImages\": [\"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1\"],\"HelmChartUri\": \"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:helmchart1.1\",\"Description\": \"Helm chart description\",\"UsageInstructions\": \"Usage instructions\",\"MarketplaceServiceAccountName\": \"Service account name\",\"ReleaseName\": \"Optional release name\",\"Namespace\": \"Optional Kubernetes namespace\",\"OverrideParameters\": [{\"Key\": \"HelmKeyName1\",\"DefaultValue\": \"${AWSMP_LICENSE_SECRET}\"},{\"Key\": \"HelmKeyName2\",\"DefaultValue\": \"${AWSMP_SERVICE_ACCOUNT}\"}]}}}]}",
      "DetailsDocument":
      {
        "Version":
        {
          "VersionTitle": "1.1",
          "ReleaseNotes": "Minor bug fix"
        },
        "DeliveryOptions":
        [
          {
            "DeliveryOptionTitle": "EKSDelivery",
            "Details":
            {
              "EcrDeliveryOptionDetails":
              {
                "ContainerImages":
                [
                  "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1"
                ],
                "DeploymentResources":
                [
                  {
                    "Name": "HelmDeploymentTemplate",
                    "Url": "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1"
                  }
                ],
                "CompatibleServices":
                [
                  "EKS"
                ],
                "Description": "Sample Description",
                "UsageInstructions": "helm pull 111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1"
              }
            }
          },
          {
            "DeliveryOptionTitle": "HelmChartDeliveryOption",
            "Details":
            {
              "HelmDeliveryOptionDetails":
              {
                "CompatibleServices":
                [
                  "EKS",
                  "EKS-Anywhere"
                ],
                "ContainerImages":
                [
                  "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1"
                ],
                "HelmChartUri": "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:helmchart1.1",
                "Description": "Helm chart description",
                "UsageInstructions": "Usage instructions",
                "MarketplaceServiceAccountName": "Service account name",
                "ReleaseName": "Optional release name",
                "Namespace": "Optional Kubernetes namespace",
                "OverrideParameters":
                [
                  {
                    "Key": "HelmKeyName1",
                    "DefaultValue": "${AWSMP_LICENSE_SECRET}"
                  },
                  {
                    "Key": "HelmKeyName2",
                    "DefaultValue": "${AWSMP_SERVICE_ACCOUNT}"
                  }
                ]
              }
            }
          }
        ]
      },
      "ErrorDetailList":
      []
    }
  ]
}

Status 필드에는 요청의 현재 상태가 표시됩니다.이 경우 입니다SUCCEEDED.

실패하는 경우 결과에 두 가지 유형의 오류가 포함될 수 있습니다. 대부분의 오류의 경우 오류 메시지가 직접 포함됩니다. 그러나 제품에서 보안 취약성을 스캔하는 동안 발견된 오류에는 ErrorMessage 필드에 발견된 모든 오류를 나열하는 파일의 URL이 포함됩니다. 스캔 중에 발견된 오류는 ErrorCode "SCAN_ERROR"입니다.


{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef",
  "ChangeSetName": "Submitted by 123456789012",
  "StartTime": "2020-10-27T22:21:26Z",
  "EndTime": "2020-10-27T22:32:19Z",
  "Status": "FAILED",
  "FailureDescription": "Change set preparation has failed. For details see 'ErrorDetailList'.",
  "ChangeSet":
  [
    {
      "ChangeType": "AddDeliveryOptions",
      "Entity":
      {
        "Type": "ContainerProduct@1.0",
        "Identifier": "example-1234-abcd-56ef-abcdef12345678@4"
      },
      "Details": "{\"Version\": {\"VersionTitle\": \"1.1\",\"ReleaseNotes\": \"Minor bug fix\"},\"DeliveryOptions\": [{\"DeliveryOptionTitle\": \"EKSDelivery\",\"Details\": {\"EcrDeliveryOptionDetails\" : {\"ContainerImages\": [\"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1\"],\"DeploymentResources\": [{\"Name\": \"HelmDeploymentTemplate\",\"Url\": \"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1\"}],\"CompatibleServices\": [\"EKS\"],\"Description\": \"Sample Description\",\"UsageInstructions\":\"helm pull 111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1\"}}},{\"DeliveryOptionTitle\": \"HelmChartDeliveryOption\",\"Details\": {\"HelmDeliveryOptionDetails\": {\"CompatibleServices\": [\"EKS\", \"EKS-Anywhere\"],\"ContainerImages\": [\"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1\"],\"HelmChartUri\": \"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:helmchart1.1\",\"Description\": \"Helm chart description\",\"UsageInstructions\": \"Usage instructions\",\"MarketplaceServiceAccountName\": \"Service account name\",\"ReleaseName\": \"Optional release name\",\"Namespace\": \"Optional Kubernetes namespace\",\"OverrideParameters\": [{\"Key\": \"HelmKeyName1\",\"DefaultValue\": \"${AWSMP_LICENSE_SECRET}\"},{\"Key\": \"HelmKeyName2\",\"DefaultValue\": \"${AWSMP_SERVICE_ACCOUNT}\"}]}}}]}",
      "DetailsDocument":
      {
        "Version":
        {
          "VersionTitle": "1.1",
          "ReleaseNotes": "Minor bug fix"
        },
        "DeliveryOptions":
        [
          {
            "DeliveryOptionTitle": "EKSDelivery",
            "Details":
            {
              "EcrDeliveryOptionDetails":
              {
                "ContainerImages":
                [
                  "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1"
                ],
                "DeploymentResources":
                [
                  {
                    "Name": "HelmDeploymentTemplate",
                    "Url": "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1"
                  }
                ],
                "CompatibleServices":
                [
                  "EKS"
                ],
                "Description": "Sample Description",
                "UsageInstructions": "helm pull 111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1"
              }
            }
          },
          {
            "DeliveryOptionTitle": "HelmChartDeliveryOption",
            "Details":
            {
              "HelmDeliveryOptionDetails":
              {
                "CompatibleServices":
                [
                  "EKS",
                  "EKS-Anywhere"
                ],
                "ContainerImages":
                [
                  "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1"
                ],
                "HelmChartUri": "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:helmchart1.1",
                "Description": "Helm chart description",
                "UsageInstructions": "Usage instructions",
                "MarketplaceServiceAccountName": "Service account name",
                "ReleaseName": "Optional release name",
                "Namespace": "Optional Kubernetes namespace",
                "OverrideParameters":
                [
                  {
                    "Key": "HelmKeyName1",
                    "DefaultValue": "${AWSMP_LICENSE_SECRET}"
                  },
                  {
                    "Key": "HelmKeyName2",
                    "DefaultValue": "${AWSMP_SERVICE_ACCOUNT}"
                  }
                ]
              }
            }
          }
        ]
      },
      "ErrorDetailList":
      [
        {
          "ErrorCode": "DUPLICATE_VERSION_TITLE",
          "ErrorMessage": "The version title must be different from any other version titles of this product."
        },
        {
          "ErrorCode": "SCAN_ERROR",
          "ErrorMessage": "https://123sample456.cloudfront.net/example-1234-abcd-5678-abcdef12345678/1234abcdef567890"
        }
      ]
    }
  ]
}

이 예제에서는 직접 보고된 오류(DUPLICATE_VERSION_TITLE)가 하나 있습니다. 다른 오류에는 오류 메시지가 있는 파일이 있습니다(단일 에는 연결된 파일에서 발견된 오류가 여러 개 있을 SCAN_ERROR 수 있음).

참고

에 반환된 링크ErrorMessage는 60일 동안 유효합니다.

javascript가 브라우저에서 비활성화되거나 사용이 불가합니다.

AWS 설명서를 사용하려면 Javascript가 활성화되어야 합니다. 지침을 보려면 브라우저의 도움말 페이지를 참조하십시오.

문서 규칙

API를 판매자로 사용

AMI 기반 제품 작업