A referência da API do AWS Marketplace foi reestruturada. Para obter mais informações sobre as operações de API suportadas, consulte a Referência de API do AWS Marketplace.
As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
Trabalhe com produtos componentes do EC2 Image Builder
Como vendedor do AWS Marketplace, você pode listar AMI-based produtos entregues aos compradores do AWS Marketplace usando componentes do EC2 Image Builder. Para criar seu componente e publicar uma AWS Marketplace listagem, siga sequencialmente as seções a seguir.
Tópicos
Criando e testando seu componente Image Builder
Crie e teste seu componente no Image Builder. Para obter instruções, consulte Desenvolver componentes personalizados para sua imagem do Image Builder no Guia do usuário do Image Builder. Ao criar seu componente usando o Image Builder, certifique-se de fazer o seguinte:
-
O componente e todas as suas dependências subjacentes, como um bucket, segredos ou parâmetros do Amazon Simple Storage Service (Amazon S3), devem ser criados na região Leste dos EUA (Norte da Virgínia) () da AWS.
us-east-1 -
Inclua a arquitetura suportada e quaisquer dependências de software na descrição do componente.
-
Teste seu componente em sua AWS conta criando um pipeline de imagens e implantando a AMI criada pelo pipeline.
-
Se seu componente contiver instruções para copiar binários, pacotes ou arquivos de um bucket do S3, use o módulo de
S3Downloadação. NoS3Downloadmódulo, parasource, insira a localização estática do seu arquivo no bucket do S3. O exemplo a seguir copia um binário de um bucket do S3 como parte da instalação do componente.- name: DownloadMyFile action: S3Download inputs: - source: s3://amzn-s3-demo-source-bucket/path/to/package.zip destination: C:\myfolder\package.zip -
Os componentes podem ingerir arquivos de até 2 GB ao usar a
S3Downloadação. -
Se seu componente usa parâmetros, certifique-se de que todos os parâmetros tenham valores padrão. Por exemplo, se você tiver um parâmetro chamado
region, certifique-se de ter um valor padrão válido, comous-east-1. Esses valores padrão são para AWS Marketplace processamento e teste. O teste pode falhar se você não incluir valores padrão. -
Se seu componente usa AWS Secrets Manager, Parameter Store ou uma capacidade de AWS Systems Manager armazenar parâmetros, faça o seguinte:
-
-
Para recuperar valores como uma etapa em seu componente, incorpore AWS Command Line Interface comandos em seu arquivo de configuração YAML.
-
Crie uma entrada correspondente no Secrets Manager ou no Parameter Store em sua AWS conta. Use a chave padrão e forneça um valor válido que ajudará na criação do componente durante o processo AWS Marketplace de teste. Por exemplo, digamos que você tenha um parâmetro chamado
saas_tokencom um valor padrãotokenque usa Parameter Store. Nesse caso, crie um par de valores-chave no Parameter Store. Usetokencomo chave. Para o valor, insira um token SaaS válido para seu aplicativo.Observe que os valores armazenados na sua conta de AWS Marketplace vendedor serão usados somente para fins AWS Marketplace de teste. Esses valores não serão compartilhados com os compradores.
-
AWS Marketplace gera automaticamente Amazon Machine Images (AMIs) para seu componente em todas as versões compatíveis do sistema operacional que você escolher durante o processo de criação do componente. Ao criar seu componente, escolha pelo menos uma versão de sistema operacional compatível. Valide a compatibilidade do seu componente com todas as versões escolhidas do sistema operacional usando os pipelines do EC2 Image Builder para criar e testar AMIs.
-
Copiando o ARN do componente
Depois de criar e testar o componente no Image Builder, copie e salve o ARN do componente. Você usará o ARN ao publicar a lista de produtos usando a API do AWS Marketplace catálogo.
Para copiar o ARN do componente Image Builder
-
Faça login no AWS Management Console e abra o console do Image Builder emhttps://console.aws.amazon.com/imagebuilder/
. -
Na barra de navegação à esquerda, em Recursos salvos, escolha Componentes.
-
Na página Componentes, em Proprietário do filtro, escolha Proprietário meu.
-
Escolha o nome do componente.
-
Na página de detalhes do componente, na seção Resumo, copie o ARN.
Criando AWS Marketplace Políticas do IAM
Crie as seguintes políticas do IAM para conceder AWS Marketplace acesso ao seu componente do Image Builder e recursos relacionados, como buckets e segredos do Amazon S3. Use os exemplos de políticas fornecidos. Você anexa essas políticas a uma função AWS Marketplace do IAM. Para obter ajuda na criação de políticas, consulte Como criar políticas usando o editor JSON no Guia do usuário do IAM.
-
Política de obtenção de componentes do Image Builder, para permitir o acesso AWS Marketplace ao seu componente no Image Builder. Essa política é obrigatória. Atribua o nome
mp_ib_ingestà política. -
Política de acesso de leitura do Amazon S3, para permitir a recuperação de binários de AWS Marketplace um bucket do S3. Essa política só é necessária se seu componente usa o módulo de
S3Downloadação e armazena os binários associados em um bucket do S3. Atribua o nomemp_ib_s3_read_onlyà política. -
Política de acesso de leitura do Secrets Manager, para permitir AWS Marketplace a recuperação de segredos armazenados no Secrets Manager. Essa política só é necessária se seu componente usa o Secrets Manager para armazenar segredos. Atribua o nome
mp_ib_sm_read_onlyà política. Para restringir a política apenas ao seu segredo, substitua o*naResourceseção pelo seu segredo. -
Política de acesso de leitura do Parameter Store, para permitir AWS Marketplace a recuperação de segredos armazenados no Parameter Store. Essa política só é necessária se seu componente usa o Parameter Store para armazenar segredos. Atribua o nome
mp_ib_ssm_parameter_read_onlyà política. Para restringir a política apenas ao seu segredo, substitua o*naResourceseção pelo seu segredo.
Criando o AWS Marketplace Perfil do IAM
Use o procedimento a seguir para criar uma função AWS Marketplace do IAM com políticas para conceder AWS Marketplace acesso ao seu componente e suas dependências.
Para criar o AWS Marketplace Perfil do IAM
-
Faça login no AWS Management Console e abra o console do IAM em https://console.aws.amazon.com/iam/
. -
Na barra de navegação esquerda, escolha Funções.
-
Selecione Criar perfil.
-
Selecione Política de confiança personalizada.
-
Insira a seguinte declaração:
-
Escolha Próximo.
-
Adicione a política get-component do Image Builder que você criou anteriormente. A política get-component é obrigatória. Adicione as políticas relevantes para S3, Secrets Manager e Parameter Store se seu componente usar esses AWS serviços.
-
Escolha Próximo.
-
Insira um nome de função, como
MPEC2IBIngestion. -
Selecione Criar perfil.
Copiar AWS Marketplace ARN do perfil do IAM
Depois de criar a função AWS Marketplace do IAM, copie e salve o ARN da função. Você usará o ARN ao publicar a listagem usando a API do AWS Marketplace catálogo.
Para copiar o AWS Marketplace ARN do perfil do IAM
-
No console do IAM, na barra de navegação esquerda, escolha Roles.
-
Escolha a função AWS Marketplace do IAM que você criou anteriormente, como
MPEC2IBIngestion. -
Na página de detalhes da função, na seção Resumo, copie o ARN.
Prepare sua lista de componentes do Image Builder
Antes de publicar seu AWS Marketplace anúncio, certifique-se de ter as seguintes informações em mãos:
-
Metadados do produto — Os metadados incluem o logotipo do produto, o título do produto, o contrato de licença do usuário final, os tipos de instância compatíveis e a região da AWS.
-
Informações sobre preços — Você pode oferecer seu produto gratuitamente, por hora ou por hora com um período inicial de teste gratuito. Não há suporte para trazer sua própria licença (BYOL).
-
Detalhes do componente — Os detalhes incluem o componente Amazon Resource Number (ARN), detalhes de uso e a função AWS Identity and Access Management (IAM) que AWS Marketplace assumirá para processar seu componente.
Publicando sua lista de produtos do componente Image Builder
Este tópico contém instruções para publicar sua lista de componentes do EC2 Image Builder AWS Marketplace sobre AWS Marketplace o uso da API de catálogo.
Pré-requisitos
Certifique-se de ter o seguinte antes de publicar sua lista de produtos do componente Image Builder:
-
Registro como vendedor em AWS Marketplace. Para obter mais informações, consulte Registre-se como vendedor do AWS Marketplace
. -
Um usuário do IAM com
AWSMarketplaceSellerFullAccesspermissão. -
Um bucket do Amazon Simple Storage Service (Amazon S3) acessível ao público para hospedar o logotipo e o EULA da sua empresa, se usado em seu componente. Você inserirá a URL do bucket do S3 em seu arquivo
ChangeSetJSON. -
AWS Command Line Interface (AWS CLI). Para obter mais informações, consulte O que é a interface de linha de comando da AWS? no Guia do AWS Command Line Interface usuário.
Criando um produto componente do Image Builder em AWS Marketplace
Para criar um produto AWS Marketplace componente do EC2 Image Builder usando a API do Catalog, consulteCrie um produto.
Atualização das informações do produto do componente Image Builder
Você pode atualizar as informações sobre um produto componente do Image Builder no Portal AWS Marketplace de Gerenciamento.
Para atualizar as informações do produto do componente Image Builder
-
Abra o Portal de gerenciamento do AWS Marketplace
e faça login na conta de vendedor. -
No menu Produtos, escolha Servidor.
-
Na página de produtos de servidor, selecione o produto.
-
Na página de detalhes do produto, no menu Solicitar alterações, escolha o item que corresponde às informações que você deseja atualizar.
-
Depois de enviar qualquer alteração, a solicitação aparecerá na guia Solicitações no status “Em análise” e mudará para “Bem-sucedida” depois de concluída.
Adicionar uma nova versão a um produto componente existente do Image Builder
Você pode adicionar uma nova versão a um produto componente do Image Builder AWS Marketplace usando AWS Marketplace Catalog API o.
Para adicionar uma nova versão
-
A partir do Portal de gerenciamento do AWS Marketplace, obtenha a ID do produto.
-
Abra o Portal de gerenciamento do AWS Marketplace
e faça login na conta de vendedor. -
No menu Produtos, escolha Servidor.
-
Na página de produtos de servidor, selecione o produto.
-
No resumo do produto, copie a ID do produto.
-
-
Usando o exemplo de código a seguir, crie um arquivo de conjunto de alterações no formato JSON. No exemplo,
your-product-IDsubstitua pela ID do produto que você obteve na etapa 1.new-version-nameSubstitua pelo título da sua versão.new-delivery-option-titleSubstitua pelo título da opção de entrega.[ { "ChangeType": "AddDeliveryOptions", "Entity": { "Identifier": "your-product-ID", "Type": "AmiProduct@1.0" }, "DetailsDocument": { "Version": { "VersionTitle": "new-version-name", "ReleaseNotes": "Release notes goes here." }, "DeliveryOptions": [ { "DeliveryOptionTitle": "new title", "Details": { "Ec2ImageBuilderComponentDeliveryOptionDetails": { "UsageInstructions": "Test usage instructions for IB", "AccessRoleArn": "arn:aws:iam::123456789:role/sample", "ComponentArn": "arn:aws:imagebuilder:us-east-1:123456789:component/sample/2.0.0/1" } } } ] } } ] -
Salve o arquivo do conjunto de alterações com o nome.
addIBversion.json -
No seu terminal ou AWS CloudShell, execute o seguinte comando:
aws marketplace-catalog start-change-set --catalog AWSMarketplace --region us-east-1 --change-set file://addIBversion.json
O start-change-set comando retornará um ChangeSetId valor. Para monitorar um conjunto de alterações, consulteMonitorando um conjunto de alterações.
Erros assíncronos
Os erros a seguir são específicos AddDeliveryOptions das ações no AWS Marketplace Catalog API. Esses erros são retornados quando você liga DescribeChangeSet após o processamento de um conjunto de alterações. Para obter mais informações sobre como usar DescribeChangeSet para obter o status de uma solicitação de alteração, consulteTrabalhando com conjuntos de alterações.
nota
Os códigos de erro a seguir são específicos do método de entrega do Image Builder. Para mensagens de erro existentes em campos como Usage InstructionsRecommended Instance type, eAccessRoleArn, consulteAdicionar uma nova versão.
| Código de erro | Mensagem de erro |
|---|---|
ATIVO NÃO ENCONTRADO |
|
ATIVO NÃO ENCONTRADO |
|
NOME_DO_COMPONENTE_DUPLICADO |
|
NOME_DO_COMPONENTE_DUPLICADO |
|
FILAMENTO_COMPONENT_DUPLICADO |
|
FILAMENTO_COMPONENT_DUPLICADO |
|
ERRO_DE_DIGITALIZAÇÃO |
|
EXCEÇÃO DE ACESSO A ATIVOS |
|
EXCEÇÃO DE ACESSO A ATIVOS |
|
EXCEÇÃO DE ACESSO A ATIVOS |
|
EXCEÇÃO DE ACESSO A ATIVOS |
|
PACOTE_COMPONENT_IMAGE_BUILDER_INVÁLIDO |
|
PACOTE_COMPONENT_IMAGE_BUILDER_INVÁLIDO |
|
MUITOS_IMAGE_BUILDER_COMPONENTS |
|
PERFIL_PUBLIC_INCOMPLETO DO VENDEDOR |
|
DESCRIÇÃO_INVÁLIDA |
|
NOME_DO_COMPONENTE_INVÁLIDO |
|
VERSÃO_OS_SUPORTADA INVÁLIDA |
|
FORMATO_CAMINHO_DE_PERCURSO INVÁLIDO |
|
TIPO_DO_SISTEMA OPERACIONAL INCOMPATÍVEL |
|
EXCEÇÃO DE ACESSO A ATIVOS |
|
EXCEÇÃO DE ACESSO A ATIVOS |
|
INVALID_IB_COMPONENT_BUILD_VERSION |
O |
PARÂMETRO_IB_COMPONENT_INVÁLIDO |
|
PARÂMETRO_IB_COMPONENT_INVÁLIDO |
|
PARÂMETRO_IB_COMPONENT_INEXISTENTE |
|
PARÂMETRO_IB_COMPONENT_INVÁLIDO |
|
TESTE_DE_LANÇAMENTO FALHADO |
|
SSHAuthFailedForUserAndKeypair |
|
INVALID_IB_COMPONENT |
|
TÍTULO DA VERSÃO_DUPLICADO |
|
TÍTULO_DE_VERSÃO INVÁLIDA |
|
TÍTULO_DE_VERSÃO INVÁLIDA |
|
TÍTULO_DE_VERSÃO INVÁLIDA |
|
TÍTULO_DE_VERSÃO INVÁLIDA |
|
NOTAS_DE_LANÇAMENTO INVÁLIDAS |
|
NOTAS_DE_LANÇAMENTO INVÁLIDAS |
|
NOTAS_DE_LANÇAMENTO INVÁLIDAS |
|
NOTAS_DE_LANÇAMENTO INVÁLIDAS |
|
INSTRUÇÕES_DE_USO INVÁLIDAS |
|
INSTRUÇÕES_DE_USO INVÁLIDAS |
|
INSTRUÇÕES_DE_USO INVÁLIDAS |
|
TÍTULOS_OPÇÕES_DE_ENTREGA_DUPLICADOS |
|
TÍTULOS_OPÇÕES_DE_ENTREGA INVÁLIDOS |
|
Atualizando informações sobre uma versão existente
Para atualizar informações sobre uma versão existente
-
A partir do Portal de gerenciamento do AWS Marketplace, obtenha a ID do produto.
-
Abra o Portal de gerenciamento do AWS Marketplace
e faça login na conta de vendedor. -
No menu Produtos, escolha Servidor.
-
Na página de produtos de servidor, selecione o produto.
-
No resumo do produto, copie a ID do produto.
-
-
No seu terminal, execute o comando a seguir. No comando,
your-product-IDsubstitua pela ID que você obteve na etapa 1.aws marketplace-catalog describe-entity --catalog AWSMarketplace --region us-east-1 --entity-id 'your-product-ID' -
Na saída retornada, vá para a
DetailsDocumentVersionsseção. Copie oIdvalorDeliveryOptions, para a versão que você deseja atualizar. -
Usando o exemplo de código a seguir, crie um arquivo de conjunto de alterações no formato JSON. No exemplo,
your-product-IDsubstitua pela ID do produto que você obteve na etapa 1.your-release-notesSubstitua por suas notas de lançamento.your-delivery-option-IDSubstitua pelo ID da opção de entrega que você obteve na etapa 3.your-usage-instructionsSubstitua por suas instruções de uso.[ { "ChangeType": "UpdateDeliveryOptions", "Entity": { "Identifier": "your-product-ID", "Type": "AmiProduct@1.0" }, "DetailsDocument": { "Version": { "ReleaseNotes": "your-release-notes" }, "DeliveryOptions": [ { "Id": "your-delivery-option-ID", "Details": { "Ec2ImageBuilderComponentDeliveryOptionDetails": { "UsageInstructions": "your-usage-instructions" } } } ] } } ] -
Salve o arquivo do conjunto de alterações com o nome.
updateVersionInfo.json -
No seu terminal ou AWS CloudShell, execute o seguinte comando:
aws marketplace-catalog start-change-set --catalog AWSMarketplace --region us-east-1 --change-set file://updateVersionInfo.json
O start-change-set comando retornará um ChangeSetId valor. Para monitorar um conjunto de alterações, consulteMonitorando um conjunto de alterações.
Restringindo uma versão do produto componente Image Builder
Restringir uma versão faz com que ela fique indisponível para os compradores. Você pode restringir uma versão do seu produto componente do Image Builder ao AWS Marketplace uso da API de AWS Marketplace catálogo. Você deve manter pelo menos uma versão do seu produto sem restrições AWS Marketplace. Você não pode restringir o acesso à única versão pública.
Para atualizar informações sobre uma versão existente
-
A partir do Portal de gerenciamento do AWS Marketplace, obtenha a ID do produto.
-
Abra o Portal de gerenciamento do AWS Marketplace
e faça login na conta de vendedor. -
No menu Produtos, escolha Servidor.
-
Na página de produtos de servidor, selecione o produto.
-
No resumo do produto, copie a ID do produto.
-
-
No seu terminal, execute o comando a seguir. No comando,
your-product-IDsubstitua pela ID que você obteve na etapa 1.aws marketplace-catalog describe-entity --catalog AWSMarketplace --region us-east-1 --entity-id 'your-product-ID' -
Na saída retornada, vá para a
DetailsDocumentVersionsseção. Copie oIdvalorDeliveryOptions, para a versão que você deseja atualizar. -
Usando o exemplo de código a seguir, crie um arquivo de conjunto de alterações no formato JSON. No exemplo,
your-product-IDsubstitua pela ID do produto que você obteve na etapa 1.your-delivery-option-IDSubstitua pelo ID da opção de entrega que você obteve na etapa 3.[ { "ChangeType": "RestrictDeliveryOptions", "Entity": { "Identifier": "your-product-ID", "Type": "AmiProduct@1.0" }, "DetailsDocument": { "DeliveryOptionIds": [ "your-delivery-option-ID" ] } } ] -
Salve o arquivo do conjunto de alterações com o nome.
restrictec2ibversion.json -
No seu terminal ou AWS CloudShell, execute o seguinte comando:
aws marketplace-catalog start-change-set --catalog AWSMarketplace --region us-east-1 --change-set file://restrictec2ibversion.json
O start-change-set comando retornará um ChangeSetId valor. Para monitorar um conjunto de alterações, consulteMonitorando um conjunto de alterações.
Monitorando um conjunto de alterações
O start-change-set comando retornará um ChangeSetId valor. Você pode monitorar o progresso do conjunto de alterações das seguintes formas:
-
Execute o comando a seguir no seu terminal. No comando.
changeset-IDsubstitua peloChangeSetIdvalor retornado pelostart-change-setcomando.aws marketplace-catalog describe-change-set ‐‐catalog AWSMarketplace ‐‐change-set-idchangesetID -
Visualize o status da solicitação na guia Solicitações no Portal AWS Marketplace de Gerenciamento
.
Protegendo downloads de software
Para proteger a propriedade intelectual do software ISV e garantir a entrega estável e consistente do software aos AWS Marketplace compradores, analisa S3Download e WebDownload executa AWS Marketplace automaticamente os módulos em seu componente. Os arquivos referenciados são então armazenados com segurança em um bucket privado do Amazon S3 gerenciado pela. AWS Marketplace Para optar por não participar desse processo de ingestão e gerenciar downloads de software de forma independente, execute scripts bash que usem os comandos wget ou curl download.