AWS Marketplace API 참조가 재구성되었습니다. 지원되는 API 작업에 대한 자세한 내용은 AWS Marketplace API 참조를 참조하세요.
기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.
AMI 기반 제품 작업
를 사용하여 Amazon Machine Image(AMI) 기반 제품 작업을 위한 작업을 자동화AWS Marketplace Catalog API할 수 있습니다.
카탈로그 API를 사용하여 AMI 기반 제품을 생성하는 방법에 대한 자세한 내용은 섹션을 참조하세요제품 생성.
다음 주제에서는 카탈로그 API를 사용하여 AMI 기반 제품에 대한 작업을 수행하는 방법을 설명합니다.
새 버전 추가
카탈로그 API를 사용하여 기존 AMI 기반 제품에 새 버전을 추가할 수 있습니다AWS Marketplace. 를 사용하여 제품에 새 AMI 버전을 추가하는 방법에 대한 자세한 내용은 AWS Marketplace판매자 안내서의 새 버전 추가를 AWS Marketplace Management Portal참조하세요.
AWS Marketplace에 새 AMI를 추가하는 요청이 포함된 요청을 생성할 때는 AMI를 AWS Marketplace 시스템에 복사한 다음 보안 문제를 스캔해야 합니다. AMI에서 작업을 수행할 권한이 있는 AWS Identity and Access Management(IAM) 역할을 생성하여 AWS Marketplace에 AMI에 대한 액세스 권한을 부여해야 합니다. 필요한 권한에 대한 자세한 내용은 AWS Marketplace판매자 안내서의 AWS Marktplace에 AMI에 대한 액세스 권한 부여를 참조하세요.
새 버전을 추가하려면 다음 예제와 같이 AMI 기반 제품의 AddDeliveryOptions 변경 유형으로 StartChangeSet API 작업을 호출합니다. 실제로 새 버전을 생성하지 않고 API 호출을 테스트하려면 Intent 파라미터를 로 설정합니다VALIDATE. 자세한 내용은 의도를 참조하세요.
참고
AMI 제품의 경우 버전은 하나 이상의 전송 옵션으로 구성됩니다. 동일한 버전의 모든 전송 옵션은 동일한 세부 정보를 가진 동일한 AmiSource 객체를 가져야 합니다. 버전을 생성할 때 모든 전송 옵션을 버전에 추가해야 합니다. 기존 버전에는 전송 옵션을 추가할 수 없습니다.
요청 구문
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판매자 안내서의 새 버전 추가를 참조하세요.
-
DeliveryOptions(객체 배열) - 각 객체의 세부 정보를 포함한 전송 옵션 객체 목록입니다. 하나 이상을 포함해야 합니다.
-
AMI(독립 실행형) 전송 옵션에서 다음 세부 정보가 포함된 객체를 지정합니다. 이 유형의 전송 옵션은 하나만 가질 수 있습니다.
-
세부 정보(객체) -이 전송 옵션의 세부 정보를 보유합니다. 이 중첩된 세부 정보 객체는 이중 이스케이프할 필요가 없습니다.
-
AmiDeliveryOptionDetails(객체) -를 사용하여 각 AMI 전송 옵션의 세부 정보를 제공합니다.
-
AmiSource(객체) - 추가된 버전에 사용할 AMI에 대한 세부 정보입니다.
-
AmiId(문자열) - API가 호출되는 AWS 리전에 있는 소스 AMI의 ID입니다. 카탈로그 API를 사용할 수 있는 유일한 리전이므로 항상 미국 동부(버지니아 북부)여야 합니다. 호출자 계정에 속해야 합니다.
-
AccessRoleArn(문자열) -가 제공된 AMI에 액세스하는 AWS Marketplace데 사용하는 IAM 역할 Amazon 리소스 이름(ARN)입니다. 이 ARN 생성 및 사용에 대한 자세한 내용은 AWS Marketplace판매자 안내서의 AMI에 대한 AWS Marketplace 액세스 권한 부여를 참조하세요.
-
UserName(문자열) - 사용자 이름으로 로그인하여 AMI의 운영 체제(OS)에 액세스합니다. 일반적으로 Linux AMIs용 ec2-user 또는 Windows용 관리자.
-
ScanningPort(정수) - OS에 액세스하는 데 사용되는 SSH 또는 RDP 포트입니다. 제공된 AMI에서 보안 취약성을 스캔하는 데 사용됩니다. 기본값은 22입니다.
-
OperatingSystemName(문자열) - 구매자에게 표시되는 운영 체제의 이름입니다.
-
OperatingSystemVersion(문자열) - 구매자에게 표시되는 운영 체제 버전 문자열입니다.
-
AfiIds문자열 배열)(선택 사항) -이 버전에 대한 FPGA 지원을 활성화하는 Amazon FPGA 이미지(AFI) IDs. 제공되면 FPGA 지원 F2 인스턴스 유형에서 제품을 실행할 수 있습니다. 버전당 최대 15개의 AFI IDs를 제공할 수 있습니다. 제공하는 모든 AFI ID는 미국 동부(버지니아 북부) 리전에서 시작하여 AWS Marketplace 판매자 계정 내에 있어야 하며, 제공된 IAM 액세스 역할에는 이 AFI를 AWS Marketplace와 공유할 수 있는 권한이 있어야 합니다. 필요한 권한에 대한 자세한 내용은 AWS Marketplace판매자 안내서의 FPGA 이미지에 대한 액세스 권한 AWS Marketplace 부여를 참조하세요.
-
-
UsageInstructions(문자열) - AMI 사용에 대한 지침 또는 AMI에 대한 자세한 정보 링크입니다.
-
AccessEndpointUrl(객체)(선택 사항) - AMI를 사용한 후 AMI에 액세스할 경로를 생성하는 데 사용됩니다.
-
포트(문자열) - AMI에서 실행되는 서비스에 액세스하는 데 사용되는 포트 번호입니다.
-
프로토콜(문자열) - AMI에서 실행되는 서비스에 액세스하는 데 사용되는 프로토콜(http 또는 https)입니다.
-
RelativePath(문자열) - AMI에서 실행되는 서비스에 액세스하기 위한 웹 루트의 경로입니다(예: /index.html).
-
-
RecommendedInstanceType(문자열) - AMI로 서비스를 실행하는 데 권장되는 인스턴스 유형으로, 원클릭 서비스 설치의 기본값입니다. 인스턴스 유형 목록은 Linux 인스턴스용 Amazon Elastic Compute Cloud 사용 설명서의 인스턴스 유형을 참조하세요.
-
SecurityGroups(객체 배열) - 버전에 대해 자동으로 생성된 그룹의 수신 규칙을 나타내는 객체 목록입니다.
-
IpProtocol(문자열) - 사용할 프로토콜(tcp 또는 udp).
-
FromPort(정수) - 소스 포트입니다.
-
ToPort(정수) - 대상 포트입니다.
-
IpRanges(문자열 배열) - CIDR 형식(xxx.xxx.xxx.xxx/nn 형식, 예:
192.0.2.0/24)으로 허용할 IP 범위입니다.
-
-
-
-
-
CloudFormation 전송 옵션이 있는 AMI의 경우 다음 세부 정보가 포함된 객체를 지정합니다. 이 유형의 전송 옵션은 최대 3개까지 가능합니다.
-
DeliveryOptionTitle(문자열) - 전송 옵션의 제목입니다.
-
세부 정보(객체) - AMI 전송 옵션의 세부 정보를 보유합니다. 이 중첩된 세부 정보 객체는 이중 이스케이프할 필요가 없습니다.
-
DeploymentTemplateDeliveryOptionDetails(객체) -를 사용하여 각 CFT 전송 옵션의 세부 정보를 제공합니다.
-
ShortDescription(문자열) - CloudFormation 템플릿 전송 옵션에 대한 간략한 설명입니다.
-
LongDescription(문자열) - CloudFormation 템플릿 전송 옵션에 대한 자세한 설명입니다.
-
UsageInstructions(문자열) - AMI 사용에 대한 지침 또는 AMI에 대한 자세한 정보 링크입니다.
-
RecommendedInstanceType(문자열) - AMI로 서비스를 실행하는 데 권장되는 인스턴스 유형으로, 원클릭 서비스 설치의 기본값입니다. 인스턴스 유형 목록은 Linux 인스턴스용 Amazon Elastic Compute Cloud 사용 설명서의 인스턴스 유형을 참조하세요.
-
ArchitectureDiagram(문자열) - Amazon S3의 아키텍처 다이어그램 위치에 대한 URL입니다.
-
템플릿(문자열) - Amazon S3의 CloudFormation 템플릿 위치에 대한 URL입니다.
-
TemplateSources(객체 배열)
-
ParameterName(문자열) -이 버전의 AMI를 전달해야 하는 CloudFormation 템플릿의 파라미터 이름입니다. 자세한 내용은 AMI 세부 정보에 대한 요구 사항을 참조하세요.
-
AmiSource(객체)
-
AmiId(문자열) - API가 호출되는에 있는 소스 AMI의 ID입니다(현재는 카탈로그 API를 사용할 수 AWS 리전있는 유일한 리전이므로 항상 미국 동부(버지니아 북부)여야 함). 호출자 계정에 속해야 합니다.
-
AccessRoleArn(문자열) -에서 제공된 AMI에 액세스하는 AWS 리전데 사용하는 IAM 역할 Amazon 리소스 이름(ARN)입니다. 이 ARN 생성 및 사용에 대한 자세한 내용은 AWS Marketplace판매자 안내서의 AWS Marketplace에 AMI에 대한 액세스 권한 부여를 참조하세요.
-
UserName(문자열) - 사용자 이름으로 로그인하여 AMI의 운영 체제(OS)에 액세스합니다. 일반적으로
ec2-userLinux AMIs.Administrator -
OperatingSystemName(문자열) - 구매자에게 표시되는 운영 체제의 이름입니다.
-
OperatingSystemVersion(문자열) - 구매자에게 표시되는 운영 체제 버전 문자열입니다.
-
-
-
-
-
-
응답 구문
요청에 대한 변경 세트가 생성됩니다. 이 요청에 대한 응답은 변경 세트에 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를 통해 직접 요청 상태를 확인할 수 있습니다.
판매자 제품 변경 세트의 오류에 대한 자세한 내용은 섹션을 참조하세요설정 상태 및 오류 변경.
요청이 완료되면 버전이 추가되고 기존 구독자는 새 버전에 대해 알리는 이메일 메시지를 받게 됩니다. 새 버전을 추가하는 프로세스에 대한 자세한 내용은 AWS Marketplace판매자 안내서의 새 버전 추가를 참조하세요.
비동기 오류
다음 오류는의 AddDeliveryOptions 작업과 관련이 있습니다AWS Marketplace Catalog API. 이러한 오류는 변경 세트가 처리된 DescribeChangeSet 후를 호출할 때 반환됩니다. 를 사용하여 변경 요청의 상태를 가져오는 DescribeChangeSet 방법에 대한 자세한 내용은 섹션을 참조하세요변경 세트 작업.
| 오류 코드 | 오류 메시지 |
|---|---|
| INVALID_AMI_NAME | AMI 이름의 접두사(x)가 잘못되었습니다. 회사 또는 브랜드 이름을 접두사로 사용하여 새 이름을 입력합니다. |
|
INVALID_PRODUCT |
기존의 제한 또는 공개 제품을 사용합니다. |
|
DUPLICATE_VERSION_TITLE |
버전 제목은이 제품의 다른 버전 제목과 달라야 합니다. |
|
INVALID_VERSION_TITLE |
상표 기호 앞에 공백을 제거합니다. |
|
INVALID_VERSION_TITLE |
지원되지 않는 문자 제거: [x, y, z] |
|
INVALID_VERSION_TITLE |
버전 제목의 시작 부분에서 공백을 제거합니다. |
|
INVALID_VERSION_TITLE |
[x]자 미만의 버전 제목을 제공합니다. |
|
INVALID_RELEASE_NOTES |
상표 기호 앞에 공백을 제거합니다. |
|
INVALID_RELEASE_NOTES |
지원되지 않는 문자 제거: [x, y, z] |
|
INVALID_RELEASE_NOTES |
릴리스 정보 시작 부분에서 공백을 제거합니다. |
|
INVALID_RELEASE_NOTES |
(x)자 미만의 릴리스 정보를 제공합니다. |
|
INVALID_USAGE_INSTRUCTIONS |
상표 기호 앞에 공백을 제거합니다. |
|
INVALID_USAGE_INSTRUCTIONS |
지원되지 않는 문자 제거: [x, y, z] |
|
INVALID_USAGE_INSTRUCTIONS |
릴리스 정보 시작 부분에서 공백을 제거합니다. |
|
INVALID_USAGE_INSTRUCTIONS |
(x)자 미만의 사용 지침을 제공합니다. |
|
RECOMMENDED_INSTANCE_TYPE_NOT_AVAILABLE |
사용 가능한 기존 인스턴스 유형을 제공합니다. |
|
INVALID_RECOMMENDED_INSTANCE_TYPE |
유효한 인스턴스 유형을 입력합니다. |
|
INVALID_SECURITY_GROUP |
보안 그룹 포트는 1에서 [최대] 사이여야 합니다. |
|
INVALID_SECURITY_GROUP |
CIDR IP 범위의 값을 제공합니다. |
|
INVALID_SECURITY_GROUP |
종료 포트보다 크지 않은 보안 그룹 시작 포트를 제공합니다. |
|
INVALID_SECURITY_GROUP_PROTOCOL |
보안 그룹 프로토콜은 'tcp' 또는 'udp'여야 합니다. |
|
INVALID_CIDR_IP |
표준 CIDR IP 범위를 '0.0.0.0/0' 형식으로 제공합니다. |
|
INVALID_ACCESS_ENDPOINT_PORT |
[x] 미만의 엔드포인트 포트를 제공합니다. |
|
INVALID_ACCESS_ENDPOINT_PORT |
1에서 [최대] 사이의 엔드포인트 포트를 제공합니다. |
|
INVALID_ACCESS_ENDPOINT_PORT |
엔드포인트 포트를 제공합니다. |
|
INVALID_ACCESS_ENDPOINT_RELATIVE_PATH |
상대 경로에서 공백을 제거합니다. |
|
INVALID_ACCESS_ENDPOINT_RELATIVE_PATH |
상대 경로에서 이전 '/'를 제거합니다. |
|
INCOMPATIBLE_OPERATING_SYSTEM |
인스턴스 유형과 호환되는 운영 체제 이름 및 버전 제공: [x] |
|
INCOMPATIBLE_OPERATING_SYSTEM_NAME |
(x)자 미만의 이름을 입력합니다. |
|
INCOMPATIBLE_OPERATING_SYSTEM_NAME |
지원되는 운영 체제 이름을 입력합니다. |
|
INCOMPATIBLE_OPERATING_SYSTEM_VERSION |
(x)자 미만의 버전을 제공합니다. |
|
INVALID_SCANNING_PORT |
1에서 [최대] 사이의 스캔 포트를 제공합니다. |
|
INVALID_AMI_ID |
유효한 AMI ID를 입력합니다. |
|
기존_AMI_PRODUCT_CODE |
이미지 X에 연결된 제품 코드를 제거합니다. |
|
INVALID_AMI_ARCHITECTURE |
새 AMI에 아키텍처 [x]를 제공합니다. |
|
INVALID_AMI_VIRTUALIZATION_TYPE |
가상화 유형 [x]로 새 AMI를 제공합니다. |
|
INVALID_AMI_VIRTUALIZATION_TYPE |
이미지 [x]에 예상 [z] 볼륨을 제공합니다. |
|
INCOMPATIBLE_AMI |
[y]의 아키텍처 [x]가 다음 인스턴스 유형에서 지원되지 않으므로 새 AMI 제공: [z] |
|
INCOMPATIBLE_AMI |
[y]의 가상화 유형 [x]는 다음 인스턴스 유형에서 지원되지 않으므로 새 AMI를 제공합니다. [z] |
|
INCOMPATIBLE_AMI |
다음 인스턴스 유형에는 ENA 지원이 필요하므로 이미지 x에 대한 ENA 지원을 활성화합니다. [y] |
|
ASSET_NOT_FOUND |
[account-id]의 us-east-1 리전에 [ami-id]가 있고AWS 계정 |
|
ASSET_ACCESS_EXCEPTION |
AMI [x]를 계정에 복사할 수AWS Marketplace 없습니다. |
|
SCAN_ERROR |
이미지 [x]의 보안 취약성 [y]를 수정합니다. |
|
ASSET_NOT_FOUND |
[account-id]의 us-east-1 리전에 [afi-id]가 있고 |
|
ASSET_ACCESS_EXCEPTION |
AFI에 액세스할 수 없습니다. AccessARN 제공 [ARN]에이 AFI를와 공유할 수 있는 권한이 AWS Marketplace있고 액세스 역할 계정이 AFI 소유자인지 확인합니다. |
|
MISSING_FPGA_인스턴스_유형 |
FPGA 기반 인스턴스 유형을 찾을 수 없습니다. AddInstanceTypes 변경 유형을 사용하여 FPGA 기반 인스턴스 유형을 추가합니다. |
를 사용하여 AMI 기반 제품을 생성할 수도 있습니다AWS Marketplace Management Portal. 자세한 내용은 AWS Marketplace판매자 안내서의 AMI 제품을 참조하세요.
AMI 기반 제품 업데이트를 자동화하는 방법을 보여주는 연습은 카탈로그 API(5:08)AWS Marketplace를 사용하여의 제품 목록에 대한 업데이트 자동화
버전 정보 업데이트
카탈로그 API를 사용하여 AMI 기반 제품의 기존 버전에 대한 세부 정보를 업데이트할 수 있습니다AWS Marketplace.
참고
를 사용하여 버전 정보를 업데이트하는 방법에 대한 자세한 내용은 AWS Marketplace판매자 안내서의 버전 정보 업데이트를 AWS Marketplace Management Portal참조하세요.
버전의 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판매자 안내서의 버전 정보 업데이트를 참조하세요.
-
개체(객체)(필수) - AMI 기반 제품.
-
식별자(문자열)(필수) - 제품 ID입니다. 자세한 내용은 식별자 단원을 참조하십시오.
-
유형(문자열)(필수) -
Type는 제품이 사용할 제공 방법(제품 유형)을 기반으로 합니다AmiProduct@1.0.
-
-
DetailsDocument(객체)(필수) - 요청의 세부 정보입니다. 여기에는 업데이트하려는 AMI 기반 제품의 버전에 대한 모든 정보가 포함됩니다. 포함된 필드는 모두 선택 사항이지만 업데이트할 필드를 하나 이상 포함해야 합니다.
-
버전(객체) - 소프트웨어 버전에 대한 세부 정보입니다.
-
ReleaseNotes(문자열) - 구매자가 한 버전에서 다음 버전으로의 변경 사항을 알리기 위한 참고 사항입니다.
-
-
DeliveryOptions(객체 배열) - 전송 옵션 객체 목록입니다. 업데이트하려는 전송 옵션만 포함합니다.
-
AMI(독립 실행형) 전송 옵션에서 다음 세부 정보가 포함된 객체를 지정합니다. 업데이트하려는 필드만 포함합니다. 달리 명시되지 않는 한 모든 필드는 선택 사항입니다.
-
Id(문자열)(필수) - 전송 옵션의 고유 식별자입니다(업데이트하려는 제품에 대한
DescribeEntity작업을 호출하여 전송 옵션의 고유 식별자를 가져올 수 있음). -
세부 정보(객체) - AMI 전송 옵션의 세부 정보를 보유합니다. 이 중첩된 세부 정보 객체는 이중 이스케이프할 필요가 없습니다.
-
AmiDeliveryOptionDetails(객체) - 하나의 AMI 전송 옵션에 대한 세부 정보입니다.
-
UsageInstructions(문자열) - AMI 사용에 대한 지침 또는 AMI에 대한 자세한 정보 링크입니다.
-
AccessEndpointUrl(객체) - AMI를 사용한 후 AMI에 액세스할 경로를 생성하는 데 사용됩니다.
-
포트(문자열) - AMI에서 실행되는 서비스에 액세스하는 데 사용되는 포트 번호입니다.
-
프로토콜(문자열) - AMI에서 실행되는 서비스에 액세스하는 데 사용되는 프로토콜(
http또는https)입니다. -
RelativePath(문자열) - AMI에서 실행되는 서비스에 액세스하기 위한 웹 루트의 경로입니다(예:
/index.html).
-
-
RecommendedInstanceType(문자열) - AMI로 서비스를 실행하는 데 권장되는 인스턴스 유형으로, 원클릭 서비스 설치의 기본값입니다.
-
SecurityGroups(객체 배열) - 버전에 대해 자동으로 생성된 그룹의 수신 규칙을 나타내는 객체 목록입니다.
-
FromPort(정수) - 소스 포트입니다.
-
IpProtocol(문자열) - 사용할 프로토콜(
tcp또는idp). -
IpRanges(문자열 배열) - CIDR 형식(xxx.xxx.xxx.xxx/nn 형식, 예:
192.0.2.0/24)으로 허용할 IP 범위입니다. -
ToPort(정수) - 대상 포트입니다.
-
-
-
-
-
CloudFormation 제공 옵션이 있는 AMI의 경우 다음 세부 정보가 포함된 객체를 지정합니다. 업데이트하려는 필드만 포함합니다. 달리 명시되지 않는 한 모든 필드는 선택 사항입니다.
-
Id(문자열)(필수) - 전송 옵션의 고유 식별자입니다(업데이트하려는 제품에 대한
DescribeEntity작업을 호출하여 전송 옵션의 고유 식별자를 가져올 수 있음). -
세부 정보(객체) - AMI 전송 옵션의 세부 정보를 보유합니다. 이 중첩된 세부 정보 객체는 이중 이스케이프할 필요가 없습니다.
-
DeploymentTemplateDeliveryOptionDetails(객체) -를 사용하여 각 CFT 전송 옵션의 세부 정보를 제공합니다.
-
DeliveryOptionTitle(문자열) - 전송 옵션의 제목입니다.
-
ShortDescription(문자열) - CloudFormation 템플릿 전송 옵션에 대한 간단한 설명입니다.
-
LongDescription(문자열) - CloudFormation 템플릿 전송 옵션에 대한 자세한 설명입니다.
-
UsageInstructions(문자열) - AMI 사용에 대한 지침 또는 AMI에 대한 자세한 정보 링크입니다.
-
RecommendedInstanceType(문자열) - AMI로 서비스를 실행하는 데 권장되는 인스턴스 유형으로, 원클릭 서비스 설치의 기본값입니다. 인스턴스 유형 목록은 Linux 인스턴스용 Amazon Elastic Compute Cloud 사용 설명서의 인스턴스 유형을 참조하세요.
-
ArchitectureDiagram(문자열) - Amazon S3의 아키텍처 다이어그램 위치에 대한 URL입니다.
-
템플릿(문자열) - Amazon S3의 CloudFormation 템플릿 위치에 대한 URL입니다.
-
TemplateSources(객체 배열)
-
ParameterName(문자열) -이 버전의 AMI를 전달해야 하는 CloudFormation 템플릿의 파라미터 이름입니다. 자세한 내용은 AMI 세부 정보에 대한 요구 사항을 참조하세요.
-
AmiSource(객체)
-
AmiId(문자열) - API가 호출되는에 있는 소스 AMI의 ID입니다(현재는 카탈로그 API를 사용할 수 AWS 리전있는 유일한 리전이므로 항상 미국 동부(버지니아 북부)여야 함). 호출자 계정에 속해야 합니다.
-
AccessRoleArn(문자열) -에서 제공된 AMI에 액세스하는 AWS 리전데 사용하는 IAM 역할 Amazon 리소스 이름(ARN)입니다. 이 ARN 생성 및 사용에 대한 자세한 내용은 AWS Marketplace판매자 안내서의 AMI에 대한 AWS Marketplace 액세스 권한 부여를 참조하세요.
-
UserName(문자열) - 사용자 이름으로 로그인하여 AMI의 운영 체제(OS)에 액세스합니다. 일반적으로
ec2-userLinux AMIs.Administrator -
OperatingSystemName(문자열) - 구매자에게 표시되는 운영 체제의 이름입니다.
-
OperatingSystemVersion(문자열) - 구매자에게 표시되는 운영 체제 버전 문자열입니다.
-
-
-
-
-
-
-
응답 구문
요청에 대한 변경 세트가 생성됩니다. 이 요청에 대한 응답은 변경 세트에 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를 통해 직접 요청 상태를 확인할 수 있습니다.
변경 세트에 대한 자세한 내용은 변경 세트 작업의 내용을 참조하세요. 판매자 제품 변경 세트의 오류에 대한 자세한 내용은 섹션을 참조하세요설정 상태 및 오류 변경.
비동기 오류
다음 오류는의 UpdateDeliveryOptions 작업에만 해당됩니다AWS Marketplace Catalog API. 이러한 오류는 변경 세트가 처리된 DescribeChangeSet 후를 호출할 때 반환됩니다. 를 사용하여 변경 요청의 상태를 가져오는 DescribeChangeSet 방법에 대한 자세한 내용은 섹션을 참조하세요변경 세트 작업.
변경 세트가 처리를 시작한 후 DescribeChangeSet 작업을 사용하여 UpdatePricingTerms 작업을 검색할 수 있습니다. 오류 세부 정보 및 문제 해결에 대한 자세한 내용은이 가이드 설정 상태 및 오류 변경앞부분의 섹션을 참조하세요.
| 오류 코드 | 오류 메시지 |
|---|---|
| INVALID_PRODUCT | 기존 제한 또는 공개 제품을 사용합니다. |
| MISSING_DELIVERY_OPTION_IDS | 하나 이상의 전송 옵션 ID를 제공합니다. |
| INVALID_DELIVERY_OPTION_IDS | 제품에서 찾을 수 있는 전송 옵션 IDs를 제공합니다. IDs 찾을 수 없음: [x] |
| INVALID_DELIVERY_OPTIONS | 동일한 버전에 속하는 전송 옵션 IDs를 제공합니다. |
버전 제한
카탈로그 API를 사용하여 AMI 기반 제품의 버전을 제한할 수 있습니다. 이렇게 하면 신규 구매자가 해당 버전을 사용하지 못하지만 기존 구매자가 계속 사용할 수 있습니다. 버전에서 모든 전송 옵션을 제한하면 버전이 제한됩니다. 버전에서 전부는 아니지만 하나 이상의 전송 옵션을 제한하면 해당 버전의 전송 옵션만 제한됩니다. 항상 사용 가능한 제품의 무제한 버전이 하나 이상 있어야 합니다. 따라서 제품의 마지막 공개적으로 사용 가능한 버전을 제한할 수 없습니다.
참고
를 AWS Marketplace통해에서 AMI 버전을 제한하는 방법에 대한 자세한 내용은 AWS Marketplace판매자 안내서의 버전 제한을 AWS Marketplace Management Portal참조하세요. https://docs.aws.amazon.com/marketplace/latest/userguide/ami-single-ami-products.html#single-ami-restricting-version
버전을 제한하려면 다음 예제와 같이 RestrictDeliveryOptions 변경 유형으로 StartChangeSet API 작업을 호출합니다.
참고
모든 구독자는 제한 상태에 관계없이 현재 버전을 사용할 수 있습니다. AWS Marketplace지침에 따라 버전을 제한한 후 90일 동안 기존 구매자에게 지원을 계속 제공해야 합니다. 버전이 제한되면 AMI는 더 이상 사용되지 않는 것으로 표시됩니다. 자세한 내용은 Windows 인스턴스용 Amazon Elastic Compute Cloud 사용 설명서의 AMI 사용 중지를 참조하세요.
요청 구문
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 변경 유형을 추가하기 위해 제공하는 입력 필드에 대한 정보입니다.
-
개체(객체)(필수) - AMI 기반 제품.
-
식별자(문자열)(필수) - 제품 ID입니다. 자세한 내용은 식별자 단원을 참조하십시오.
-
유형(문자열)(필수) -
Type는 제품이 사용할 전송 방법(제품 유형)을 기반으로 합니다AmiProduct@1.0.
-
-
DetailsDocument(객체)(필수) - 요청의 세부 정보입니다. 여기에는 제한하려는 AMI 기반 제품의 버전에 대한 IDs가 포함됩니다.
-
DeliveryOptionIds(객체 배열) - 제한하려는 버전의
DeliveryOptionIDs. 제한하려는 버전에서DescribeEntity작업을 호출DeliveryOption하여의 고유 식별자를 가져올 수 있습니다.
-
응답 구문
요청에 대한 변경 세트가 생성됩니다. 이 요청에 대한 응답은 변경 세트에 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를 통해 직접 요청 상태를 확인할 수 있습니다.
비동기 오류
다음 오류는의 RestrictDeliveryOptions 작업에만 해당됩니다AWS Marketplace Catalog API. 이러한 오류는 변경 세트가 처리된 DescribeChangeSet 후를 호출할 때 반환됩니다. 를 사용하여 변경 요청의 상태를 가져오는 DescribeChangeSet 방법에 대한 자세한 내용은 섹션을 참조하세요변경 세트 작업.
| 오류 코드 | 오류 메시지 |
|---|---|
|
INVALID_PRODUCT |
기존 퍼블릭 제품을 사용합니다. |
|
MISSING_DELIVERY_OPTION_IDS |
하나 이상의 전송 옵션 ID를 제공합니다. |
|
INVALID_DELIVERY_OPTION_IDS |
제품에서 찾을 수 있는 전송 옵션 IDs를 제공합니다. IDs 찾을 수 없음: [x] |
|
INVALID_DELIVERY_OPTION |
퍼블릭 상태인 전송 옵션 IDs를 제공합니다. 퍼블릭 상태가 아닌 IDs: [x] |
|
ALL_DELIVERY_OPTIONS_RESTRICTED |
하나 이상의가 퍼블릭 상태로 유지되어야 하므로 제한할 전송 옵션을 더 적게 제공합니다. |
향후 AWS 리전지원 업데이트
카탈로그 API를 사용하여에서 AMI 기반 제품에 대한 향후 AWS 리전지원 기본 설정을 변경할 수 있습니다AWS Marketplace.
참고
를 사용하여 향후 리전 지원을 변경하는 방법에 대한 자세한 내용은 AWS Marketplace 판매자 안내서의 향후 AWS 리전에 대한 지원 업데이트를 AWS Marketplace Management Portal참조하세요. https://docs.aws.amazon.com/marketplace/latest/userguide/ami-single-ami-products.html#single-ami-updating-future-region-support
참고
UpdateFutureRegionSupport 변경 유형은 에서만 사용할 수 있습니다AmiProduct@1.0.
향후 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 변경 유형을 추가합니다.
-
Entity(객체)(필수) - AMI 기반 제품.-
Identifier(문자열)(필수) - 제품 ID입니다. 자세한 내용은 식별자 단원을 참조하십시오. -
Type(문자열)(필수) -Type는 제품이 사용할 제공 방법(제품 유형)을 기반으로 합니다AmiProduct@1.0.
-
-
DetailsDocument(객체)(필수) - ChangeSet를 실행하는 데 필요한 세부 정보입니다.-
FutureRegionSupport- 객체-
SupportedRegions- 문자열의 단일 요소 배열요소 지원 값: [
"All","US","None"] 중 하나
-
-
응답 구문
요청에 대한 변경 세트가 생성됩니다. 이 요청에 대한 응답은 변경 세트에 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를 통해 직접 요청 상태를 확인할 수 있습니다.
비동기 오류
다음 오류는의 UpdateFutureRegionSupport 작업과 관련이 있습니다AWS Marketplace Catalog API. 이러한 오류는 변경 세트가 처리된 DescribeChangeSet 후를 호출할 때 반환됩니다. 를 사용하여 변경 요청의 상태를 가져오는 DescribeChangeSet 방법에 대한 자세한 내용은 섹션을 참조하세요변경 세트 작업.
| 오류 코드 | 오류 메시지 |
|---|---|
| TOO_MANY_REGIONS | 현재 FutureRegionSupport: All, US 또는 None에는 1개의 값만 지원됩니다. |
| INVALID_REGIONS | 요청된 리전[a, b, c]이 유효하지 않거나 사용할 수 없습니다. 지원되는 값만 [x, y, z]입니다. |
| INVALID_INPUT | SupportedRegions은 비워둘 수 없습니다. |
지원되는 추가AWS 리전
카탈로그 API를 사용하여 AMI 기반 제품에 AWS 리전지원되는 새를 추가할 수 있습니다AWS Marketplace.
참고
를 사용하여 지원되는 새 리전을 추가하는 방법에 대한 자세한 내용은 AWS Marketplace판매자 안내서의 AWS 리전 추가를 AWS Marketplace Management Portal참조하세요.
참고
AddRegions 변경 유형은 에서만 사용할 수 있습니다AmiProduct@1.0.
지원되는 새 리전을 추가하려면 다음 예제와 같이 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 변경 유형을 추가할 필드에 대한 정보를 제공합니다.
-
Entity(객체)(필수) - AMI 기반 제품.-
Identifier(문자열)(필수) - 제품 ID입니다. 자세한 내용은 식별자 단원을 참조하십시오. -
Type(문자열)(필수) -Type는 제품이 사용할 제공 방법(제품 유형)을 기반으로 합니다AmiProduct@1.0.
-
-
예
DetailsDocument(object) (required) – The details required to execute the ChangeSet.-
Regions: 문자열 배열요소 지원 값: 유효한 AWS 리전코드 문자열입니다.
예: [
"us-east- 1"].
-
응답 구문
요청에 대한 변경 세트가 생성됩니다. 이 요청에 대한 응답은 변경 세트에 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를 통해 직접 요청 상태를 확인할 수 있습니다.
-
변경 세트 실행 상태가 인 경우
SUCCEEDED: 새 개체Identifier(또는EntityId)가 생성됩니다. 제품 개체에서DescribeEntityAPI 작업을 사용하여 결과를 확인할 수 있습니다. -
변경 세트 실행 상태가 인 경우
CLIENT_ERROR:DescribeChangeSet응답은 오류에 대한 세부 정보와 오류를 해결하기 위해 수행할 해당 작업을 제공합니다.
비동기 오류
다음 오류는의 AddRegions 작업과 관련이 있습니다AWS Marketplace Catalog API. 이러한 오류는 변경 세트가 처리된 DescribeChangeSet 후를 호출할 때 반환됩니다. 를 사용하여 변경 요청의 상태를 가져오는 DescribeChangeSet 방법에 대한 자세한 내용은 섹션을 참조하세요변경 세트 작업.
| 오류 코드 | 오류 메시지 |
|---|---|
| INVALID_REGIONS | 요청된 리전[a, b, c]이 유효하지 않거나 사용할 수 없습니다. 지원되는 값만 [x, y, z]입니다. |
| INVALID_INPUT | 리전은 비워둘 수 없습니다. |
제한AWS 리전
카탈로그 API를 사용하여 AMI 기반 제품에 AWS 리전대해 이전에 지원되는를 제한할 수 있습니다AWS Marketplace.
참고
를 사용하여 이전에 지원되는 리전을 제한하는 방법에 대한 자세한 내용은 AWS Marketplace판매자 안내서의 AWS 리전 제한을 AWS Marketplace Management Portal참조하세요.
참고
RestrictRegions 변경 유형은 에서만 사용할 수 있습니다AmiProduct@1.0.
이전에 지원되는 리전을 제한하려면 다음 예제와 같이 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 변경 유형을 추가할 필드에 대한 정보를 제공합니다.
-
Entity(객체)(필수) - AMI 기반 제품.-
Identifier(문자열)(필수) - 제품 ID입니다. 자세한 내용은 식별자 단원을 참조하십시오. -
Type(문자열)(필수) -Type는 제품이 사용할 제공 방법(제품 유형)을 기반으로 합니다AmiProduct@1.0.
-
-
DetailsDocument(객체)(필수) - ChangeSet를 실행하는 데 필요한 세부 정보입니다.
-
Regions- 문자열 배열요소 지원 값:와 같은 유효한 AWS 리전코드 문자열입니다
"us-east-1".
-
응답 구문
요청에 대한 변경 세트가 생성됩니다. 이 요청에 대한 응답은 변경 세트에 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를 통해 직접 요청 상태를 확인할 수 있습니다.
-
변경 세트 실행 상태가 인 경우
SUCCEEDED- 새 엔터티Identifier(또는EntityId)가 생성됩니다. 제품 개체DescribeEntity에서를 사용하여 결과를 확인할 수 있습니다. 자세한 내용은DescribeEntity단원을 참조하십시오. -
변경 세트 실행 상태가 인 경우
CLIENT_ERROR:DescribeChangeSet응답은 오류에 대한 세부 정보와 오류를 해결하기 위해 수행할 해당 작업을 제공합니다.
비동기 오류
다음 오류는의 AddRegions 작업과 관련이 있습니다AWS Marketplace Catalog API. 이러한 오류는 변경 세트가 처리된 DescribeChangeSet 후를 호출할 때 반환됩니다. 를 사용하여 변경 요청의 상태를 가져오는 DescribeChangeSet 방법에 대한 자세한 내용은 섹션을 참조하세요변경 세트 작업.
| 오류 코드 | 오류 메시지 |
|---|---|
| INVALID_REGIONS | 요청된 리전[a, b, c]이 유효하지 않거나 사용할 수 없습니다. 지원되는 값만 [x, y, z]입니다. |
| INVALID_INPUT | 리전은 비워둘 수 없습니다. |
새 인스턴스 유형 추가
카탈로그 API를 사용하여 AMI 기반 제품의 새 인스턴스 유형을 추가할 수 있습니다AWS Marketplace.
참고
를 사용하여 인스턴스 유형을 추가하는 방법에 대한 자세한 내용은 AWS Marketplace판매자 안내서의 인스턴스 추가를 AWS Marketplace Management Portal참조하세요.
AddInstanceTypes는 제품을 생성할 때 기존 제품과 새로 생성된 제품에 새 인스턴스 유형을 추가합니다. 변경 유형은 제품 문서의 모든 버전을 새 인스턴스 유형으로 업데이트합니다.
참고
AddInstanceTypes 변경 유형은 에서만 사용할 수 있습니다AmiProduct@1.0.
제한된 인스턴스 유형을 추가할 때 인스턴스 유형을 제한 목록에서 제거하고 사용 가능한 인스턴스 유형 목록에 추가할 수 있습니다. 이를 통해 판매자는 제품 제한을 변경할 수 있습니다. 인스턴스 유형 목록은 교체 가능하며 제품의 영구 제한 상태가 아닙니다.
내부적으로 측정된 제품의 경우 판매자는 별도의 변경 유형을 호출AddDimensions하고 인스턴스 유형에 대한 요금을 UpdatePricingTerms 업데이트해야 합니다.
새 인스턴스 유형을 추가하려면 다음 예제와 같이 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 변경 유형을 추가합니다.
-
Entity(객체)(필수) - AMI 기반 제품.-
Identifier(문자열)(필수) - 제품 ID입니다. 자세한 내용은 식별자 단원을 참조하십시오. -
Type(문자열)(필수) -Type는 제품이 사용할 제공 방법(제품 유형)을 기반으로 합니다AmiProduct@1.0.
-
-
DetailsDocument(객체)(필수) -
ChangeSet이 경우를 실행하는 데 필요한 세부 정보입니다InstanceTypes.-
InstanceTypes(문자열 배열)(필수) - 제품에InstanceTypes추가할 목록입니다. 이러한 인스턴스는 기존에 추가됩니다InstanceTypes.
-
응답 구문
요청에 대한 변경 세트가 생성됩니다. 이 요청에 대한 응답은 변경 세트에 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를 통해 직접 요청 상태를 확인할 수 있습니다.
동기 검증
다음 스키마 검증은의 AddInstanceTypes 작업에 따라 다릅니다AWS Marketplace Catalog API. 이러한 검증은를 호출할 때 수행됩니다StartChangeSet. 요청이 다음 요구 사항을 충족하지 않으면 HTTP 응답으로 실패합니다.
| 입력 필드 | 검증 규칙 | HTTP |
|---|---|---|
| InstanceTypes | 필수 | 422 |
| InstanceTypes | 비어 있으면 안 됩니다. | 422 |
| InstanceTypes | 항목은 1~24자여야 합니다. ^[A-Za-z0-9_.-]+$와 일치해야 합니다. | 422 |
| InstanceTypes | 항목은 고유해야 합니다. | 422 |
| InstanceTypes | 항목이 1,500개 이하여야 합니다. | 422 |
| 알 수 없는 속성 | 추가 속성은 허용되지 않습니다. | 422 |
비동기 오류
다음 오류는의 AddInstanceTypes 작업과 관련이 있습니다AWS Marketplace Catalog API. 이러한 오류는 변경 세트가 처리된 DescribeChangeSet 후를 호출할 때 반환됩니다. 를 사용하여 변경 요청의 상태를 가져오는 DescribeChangeSet 방법에 대한 자세한 내용은 섹션을 참조하세요변경 세트 작업.
| 오류 코드 | 오류 메시지 |
|---|---|
| INVALID_INSTANCE_TYPES | [x] 인스턴스 유형이 유효하지 않습니다. |
| INVALID_INSTANCE_가상화 | 제품의 가상화는 [x]입니다. [x] 인스턴스 유형에서는 지원되지 않습니다. |
| INVALID_AMI_ARCHITECTURE | 제품의 CPU 아키텍처는 '%s'입니다.' + "[x] 인스턴스 유형에서는 지원되지 않습니다. |
| INCOMPATIBLE_OPERATING_SYSTEM | 인스턴스 유형은 제품에 정의된 OS와 호환되지 않습니다. 제품에 정의된 OS와 호환되는 인스턴스 유형을 제공합니다. |
| INVALID_PRODUCT_TYPE | 기존 단일 AMI 제품을 사용합니다. |
| INVALID_ENA_SETTING | 제품은 ENA를 지원하지 않습니다. ENA 지원은 [x] 인스턴스 유형에 필요합니다. |
| INVALID_DIMENSIONS | 인스턴스 유형에 대해 내부적으로 측정된 차원을 찾을 수 없음: [x] |
| 누락_차원 | 제품에 대한 차원을 찾을 수 없습니다. AddInstanceTypes 앞에 AddDimensionsAddInstanceTypes 필요합니다. |
| UPDATE_PRICING_REQUIRED | 제품에서 내부적으로 측정된 차원을 사용할 수 있는 경우 UpdatePricingTerms 변경 유형이 필요합니다. |
인스턴스 유형 제한
카탈로그 API를 사용하여 AMI 기반 제품에 사용할 수 있는 인스턴스 유형을 제한할 수 있습니다AWS Marketplace.
참고
를 사용하여 사용 가능한 인스턴스 유형을 제한하는 방법에 대한 자세한 내용은 AWS Marketplace판매자 안내서의 인스턴스 제한을 AWS Marketplace Management Portal참조하세요.
기존 구독자는이 변경의 영향을 받지 않으며 제한된 인스턴스 유형을 사용할 수 있습니다. 그러나 새로운 구매자는 제한된 인스턴스 유형을 사용할 수 없습니다. 현재 인스턴스 유형 구독을 중지하려면(인스턴스 유형이 제한되면) AWS Marketplace판매자 운영 팀에 문의해야 합니다.
RestrictInstanctTypes는 인스턴스 유형을 제품 문서의 모든 버전으로 제한합니다. AddInstanceTypes 변경 유형에서 제품의 모든 버전을 업데이트합니다. 권장 인스턴스 유형을 제한할 수 없습니다. 권장 인스턴스 유형은 버전 수준이므로 판매자가 여러 인스턴스 유형을 제한하지 못할 수 있습니다.
내부적으로 측정된 제품의 경우를 호출할 때 별도의 변경 유형을 호출해야 합니다RestrictDimensions. 이렇게 하면 제한된 인스턴스 유형에 대한 새 제안이 생성되지 않습니다.
참고
RestrictInstanceTypes 변경 유형은 에서만 사용할 수 있습니다AmiProduct@1.0.
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 변경 유형을 추가할 필드에 대한 정보를 제공합니다.
-
Entity(객체)(필수) - AMI 기반 제품.-
Identifier(문자열)(필수) - 제품 ID입니다. 자세한 내용은 식별자 단원을 참조하십시오. -
Type(문자열)(필수) -Type는 제품이 사용할 제공 방법(제품 유형)을 기반으로 합니다AmiProduct@1.0.
-
-
DetailsDocument(객체)(필수) -
ChangeSet이 경우를 실행하는 데 필요한 세부 정보입니다InstanceTypes.-
InstanceTypes(문자열 배열)(필수) - 제품으로 제한InstanceTypes할 목록입니다. 이러한 인스턴스는 현재 (또는 기존 인스턴스 유형이 없는 경우 추가됨)에 제한된에 추가됩니다InstanceTypes.
-
응답 구문
요청에 대한 변경 세트가 생성됩니다. 이 요청에 대한 응답은 변경 세트에 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를 통해 직접 요청 상태를 확인할 수 있습니다.
동기 검증
다음 스키마 검증은의 RestrictInstanceTypes 작업에 따라 다릅니다AWS Marketplace Catalog API. 이러한 검증은를 호출할 때 수행됩니다StartChangeSet. 요청이 다음 요구 사항을 충족하지 않으면 HTTP 응답으로 실패합니다.
| 입력 필드 | 검증 규칙 | HTTP |
|---|---|---|
| InstanceTypes | 필수 | 422 |
| InstanceTypes | 비어 있으면 안 됩니다. | 422 |
| InstanceTypes | 항목은 1~24자여야 합니다. ^[A-Za-z0-9_.-]+$와 일치해야 합니다. | 422 |
| InstanceTypes | 항목은 고유해야 합니다. | 422 |
| InstanceTypes | 항목이 1,500개 이하여야 합니다. | 422 |
| 알 수 없는 속성 | 추가 속성은 허용되지 않습니다. | 422 |
비동기 오류
다음 오류는의 RestrictInstanceTypes 작업과 관련이 있습니다AWS Marketplace Catalog API. 이러한 오류는 변경 세트가 처리된 DescribeChangeSet 후를 호출할 때 반환됩니다. 를 사용하여 변경 요청의 상태를 가져오는 DescribeChangeSet 방법에 대한 자세한 내용은 섹션을 참조하세요변경 세트 작업.
| 오류 코드 | 오류 메시지 |
|---|---|
| INVALID_ INSTANCE_TYPES | [x] 인스턴스 유형이 유효하지 않습니다. |
| INVALID_ PRODUCT_TYPE | 기존 단일 AMI 제품을 사용합니다. |
| DUPLICATE_INSTANCE_TYPE | 중복이 없는 인스턴스 유형을 제공합니다. |
| UNAVAILABLE_INSTANCE_TYPE | 사용 가능한 인스턴스 유형을 제공합니다. |
| RECOMMENDED_INSTANCE_TYPE_RESTRICTED | 다음 인스턴스 유형은 제한할 수 없습니다. 권장 인스턴스 유형은 제한하기 전에 다른 인스턴스 유형으로 변경해야 합니다. 전송 옵션 ID [X] 인스턴스 유형[X] |
| DIMENSIONS_NOT_RESTICTED | 내부적으로 측정된 인스턴스 유형을 제한하기 전에 차원 제한: [x] |
| REGION_NO_INSTANCES | 제한된 인스턴스 유형으로 인해 리전에서 제품 시작 실패가 발생합니다. X. 인스턴스 수를 제한하는 것이 좋습니다. |
| INCOMPATIBLE_RESTRICTION | 제한된 인스턴스 유형으로 인해 AFIs에 대한 FPGA 기반 인스턴스 유형이 없는 제품이 발생합니다. 제품은 하나 이상의 FPGA 기반 인스턴스 유형을 지원해야 합니다. |