Se reestructuró la referencia de la API de AWS Marketplace. Para obtener más información sobre las operaciones de API compatibles, consulte la referencia de API de AWS Marketplace.
Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
Trabaje con los productos de componentes de EC2 Image Builder
Como vendedor de AWS Marketplace, puede publicar AMI-based los productos entregados a los compradores de AWS Marketplace mediante los componentes de EC2 Image Builder. Para crear su componente y publicar un AWS Marketplace listado, siga las siguientes secciones de forma secuencial.
Temas
Creación y prueba del componente Image Builder
Cree y pruebe su componente en Image Builder. Para obtener instrucciones, consulte Desarrollar componentes personalizados para su imagen de Image Builder en la Guía del usuario de Image Builder. Al crear el componente con Image Builder, asegúrese de hacer lo siguiente:
-
El componente y todas sus dependencias subyacentes, como un bucket, secretos o parámetros de Amazon Simple Storage Service (Amazon S3), deben crearse en la región de AWS de EE. UU. Este (Virginia del Norte
us-east-1) (). -
Incluya la arquitectura compatible y cualquier dependencia de software en la descripción del componente.
-
Pruebe el componente en su AWS cuenta creando una canalización de imágenes e implementando la AMI creada por la canalización.
-
Si su componente contiene instrucciones para copiar binarios, paquetes o archivos de un bucket de S3, utilice el módulo de
S3Downloadacción. En elS3Downloadmódulo, parasource, introduce la ubicación estática de tu archivo en el bucket de S3. En el siguiente ejemplo, se copia un binario de un bucket de S3 como parte de la instalación del componente.- name: DownloadMyFile action: S3Download inputs: - source: s3://amzn-s3-demo-source-bucket/path/to/package.zip destination: C:\myfolder\package.zip -
Los componentes pueden ingerir archivos de hasta 2 GB cuando utilizan la
S3Downloadacción. -
Si el componente usa parámetros, asegúrese de que todos los parámetros tengan valores predeterminados. Por ejemplo, si tiene un parámetro denominado
region, asegúrese de tener un valor predeterminado válido, comous-east-1. Estos valores predeterminados son para AWS Marketplace procesar y probar. Las pruebas pueden fallar si no incluye los valores predeterminados. -
Si el componente utiliza AWS Secrets Manager un almacén de parámetros o la capacidad de AWS Systems Manager almacenar parámetros, haga lo siguiente:
-
-
Para recuperar valores como un paso de tu componente, incorpora AWS Command Line Interface comandos en tu archivo de configuración de YAML.
-
Crea la entrada correspondiente en Secrets Manager o Parameter Store en tu AWS cuenta. Usa la clave predeterminada y proporciona un valor válido que ayude a crear el componente durante el proceso AWS Marketplace de prueba. Por ejemplo, supongamos que se llama a un parámetro
saas_tokencon un valor predeterminado detokenque usa Parameter Store. En este caso, cree un par clave-valor en Parameter Store. Úselotokencomo clave. Para el valor, introduce un token de SaaS válido para tu aplicación.Ten en cuenta que los valores guardados en tu cuenta de AWS Marketplace vendedor solo se utilizarán con fines AWS Marketplace de prueba. Estos valores no se compartirán con los compradores.
-
AWS Marketplace genera automáticamente imágenes de máquina de Amazon (AMI) para su componente en todas las versiones de sistemas operativos compatibles que elija durante el proceso de creación del componente. Al crear su componente, elija al menos una versión de sistema operativo compatible. Valide la compatibilidad de su componente con todas las versiones del sistema operativo elegidas mediante las canalizaciones de EC2 Image Builder para crear y probar las AMI.
-
Copiar el ARN del componente
Tras crear y probar el componente en Image Builder, copie y guarde el ARN del componente. Utilizará el ARN cuando publique la lista de productos mediante la API de AWS Marketplace catálogo.
Para copiar el ARN del componente Image Builder
-
Inicie sesión en la consola de administración de AWS y abra la consola de Image Builder enhttps://console.aws.amazon.com/imagebuilder/
. -
En la barra de navegación izquierda, en Recursos guardados, elija Componentes.
-
En la página de componentes, para el propietario del filtro, seleccione De mi propiedad.
-
Elija el nombre del componente.
-
En la página de detalles del componente, en la sección Resumen, copie el ARN.
Creación AWS Marketplace Políticas de IAM
Cree las siguientes políticas de IAM para conceder AWS Marketplace acceso a su componente de Image Builder y a los recursos relacionados, como los buckets y secretos de Amazon S3. Utilice las políticas de ejemplo que se proporcionan. Estas políticas se asocian a una función de AWS Marketplace IAM. Para obtener ayuda sobre la creación de políticas, consulte Creación de políticas con el editor JSON en la Guía del usuario de IAM.
-
Política de obtención de componentes de Image Builder, para permitir el acceso AWS Marketplace a su componente en Image Builder. Esta política es obligatoria. Llame a la política
mp_ib_ingest. -
Política de acceso de lectura de Amazon S3, que permite AWS Marketplace recuperar los archivos binarios de un bucket de S3. Esta política solo es necesaria si su componente usa el módulo de
S3Downloadacción y almacena los binarios asociados en un bucket de S3. Llame a la políticamp_ib_s3_read_only. -
Política de acceso de lectura de Secrets Manager, que permite AWS Marketplace recuperar los secretos almacenados en Secrets Manager. Esta política solo es necesaria si su componente usa Secrets Manager para almacenar secretos. Llame a la política
mp_ib_sm_read_only. Para restringir la política solo a su secreto, sustituya lo que está*en laResourcesección por su secreto. -
Política de acceso de lectura de Parameter Store, que permite AWS Marketplace recuperar los secretos almacenados en Parameter Store. Esta política solo es necesaria si su componente usa Parameter Store para almacenar secretos. Llame a la política
mp_ib_ssm_parameter_read_only. Para restringir la política solo a su secreto, sustituya lo que está*en laResourcesección por su secreto.
Creando el AWS Marketplace rol de IAM
Utilice el siguiente procedimiento para crear un rol de AWS Marketplace IAM con políticas que permitan el AWS Marketplace acceso a su componente y sus dependencias.
Para crear el AWS Marketplace rol de IAM
-
Inicie sesión en la consola AWS de administración y abra la consola de IAM en https://console.aws.amazon.com/iam/
. -
En la barra de navegación de la izquierda, selecciona Funciones.
-
Elija Crear rol.
-
Seleccione Política de confianza personalizada.
-
Introduzca la siguiente declaración:
-
Elija Siguiente.
-
Agregue la política de obtención de componentes de Image Builder que creó anteriormente. La política de obtención de componentes es obligatoria. Agregue las políticas pertinentes para S3, Secrets Manager y Parameter Store si su componente utiliza estos AWS servicios.
-
Elija Siguiente.
-
Introduzca un nombre de rol, como
MPEC2IBIngestion. -
Elija Crear rol.
Copiar AWS Marketplace ARN del rol de IAM
Tras crear el rol de AWS Marketplace IAM, copie y guarde el ARN del rol. Usarás el ARN cuando publiques el anuncio mediante la AWS Marketplace API de catálogo.
Para copiar el AWS Marketplace ARN del rol de IAM
-
En la consola de IAM, en la barra de navegación izquierda, seleccione Roles.
-
Elige el rol de AWS Marketplace IAM que creaste anteriormente, por ejemplo.
MPEC2IBIngestion -
En la página de detalles del rol, en la sección Resumen, copie el ARN.
Prepare su lista de componentes de Image Builder
Antes de publicar tu AWS Marketplace anuncio, asegúrate de tener lista la siguiente información:
-
Metadatos del producto: los metadatos incluyen el logotipo del producto, el título del producto, el acuerdo de licencia de usuario final, los tipos de instancia admitidos y la región de AWS.
-
Información de precios: puede ofrecer su producto de forma gratuita, por una tarifa por hora o por hora con un período de prueba gratuito inicial. No se admite la licencia «traiga su propia licencia» (BYOL).
-
Detalles del componente: los detalles incluyen el número de recurso de Amazon (ARN) del componente, los detalles de uso y la función AWS Identity and Access Management (IAM) que AWS Marketplace asumirá al procesar el componente.
Publicar la lista de productos del componente Image Builder
Este tema contiene instrucciones para publicar su lista de componentes de EC2 Image Builder sobre el AWS Marketplace uso de la API de AWS Marketplace catálogo.
Requisitos previos
Asegúrese de disponer de lo siguiente antes de publicar la lista de productos del componente Image Builder:
-
Registrarse como vendedor en AWS Marketplace. Para obtener más información, consulte Registrarse como vendedor de AWS Marketplace
. -
Usuario de IAM con
AWSMarketplaceSellerFullAccesspermiso. -
Un bucket de Amazon Simple Storage Service (Amazon S3) de acceso público para alojar el logotipo de la empresa y el CLUF, si se utilizan en el componente. Introducirás la URL del bucket de S3 en tu archivo
ChangeSetJSON. -
AWS Command Line Interface (AWS CLI). Para obtener más información, consulte ¿Qué es la interfaz de línea de comandos de AWS? en la Guía AWS Command Line Interface del usuario.
Creación de un producto componente de Image Builder en AWS Marketplace
Para crear un producto componente de EC2 Image Builder AWS Marketplace utilizando la API de catálogo, consulte. Cree un producto
Actualización de la información del producto del componente Image Builder
Puede actualizar la información sobre un producto componente de Image Builder en el portal AWS Marketplace de administración.
Para actualizar la información del producto del componente Image Builder
-
Abra el AWS Marketplace Management Portal
e inicie sesión en su cuenta de vendedor. -
En el menú Productos, seleccione Servidor.
-
En la página de productos del servidor, seleccione el producto.
-
En la página de detalles del producto, en el menú Solicitar cambios, elija el elemento que corresponda a la información que desea actualizar.
-
Tras enviar cualquier cambio, la solicitud aparecerá en la pestaña Solicitudes con el estado «En revisión» y pasará a ser «Correcto» una vez completada.
Añadir una nueva versión a un producto componente de Image Builder existente
Puede añadir una nueva versión a un producto componente de Image Builder AWS Marketplace utilizando el AWS Marketplace Catalog API.
Agregar una nueva versión
-
Desde AWS Marketplace Management Portal, obtenga el identificador del producto.
-
Abra el AWS Marketplace Management Portal
e inicie sesión en su cuenta de vendedor. -
En el menú Productos, seleccione Servidor.
-
En la página de productos del servidor, seleccione el producto.
-
En el resumen del producto, copia el identificador del producto.
-
-
Con el siguiente ejemplo de código, crea un archivo de conjunto de cambios en formato JSON. En el ejemplo,
your-product-IDsustitúyelo por el identificador del producto que obtuviste en el paso 1.new-version-nameSustitúyelo por el título de tu versión.new-delivery-option-titleSustitúyelo por el título de tu opción 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" } } } ] } } ] -
Guarda el archivo del conjunto de cambios con el nombre
addIBversion.json. -
En tu terminal o AWS CloudShell ejecuta el siguiente comando:
aws marketplace-catalog start-change-set --catalog AWSMarketplace --region us-east-1 --change-set file://addIBversion.json
El start-change-set comando devolverá un ChangeSetId valor. Para supervisar un conjunto de cambios, consulteSupervisar un conjunto de cambios.
Errores asincrónicos
Los siguientes errores son específicos de AddDeliveryOptions las acciones del. AWS Marketplace Catalog API Estos errores se devuelven cuando se llama DescribeChangeSet después de que se esté procesando un conjunto de cambios. Para obtener más información sobre cómo DescribeChangeSet utilizarlos para obtener el estado de una solicitud de cambio, consulteTrabajar con conjuntos de cambios.
nota
Los siguientes códigos de error son específicos del método de entrega de Image Builder. Para ver los mensajes de error existentes en campos como Usage InstructionsRecommended Instance type, yAccessRoleArn, consulteAgregar una nueva versión.
| Código de error | Mensaje de error |
|---|---|
ASSET_NOT_FOUND |
|
ACTIVO NO ENCONTRADO |
|
NOMBRE_DE_COMPONENTE DUPLICADO |
|
NOMBRE_DE_COMPONENTE DUPLICADO |
|
ARN DE COMPONENTES DUPLICADOS |
|
ARN DE COMPONENTES DUPLICADOS |
|
ERROR DE ESCANEO |
|
EXCEPCIÓN DE ACCESO A ACTIVOS |
|
EXCEPCIÓN DE ACCESO A ACTIVOS |
|
EXCEPCIÓN DE ACCESO A ACTIVOS |
|
EXCEPCIÓN DE ACCESO A ACTIVOS |
|
PAQUETE INVALID_IMAGE_BUILDER_COMPONENT_PACKAGE |
|
PAQUETE INVALID_IMAGE_BUILDER_COMPONENT_PACKAGE |
|
DEMASIADOS COMPONENTES DE CREACIÓN DE IMÁGENES |
|
PERFIL_PUBLIC_DE_VENDEDOR INCOMPLETO |
|
DESCRIPCIÓN_INVÁLIDA |
|
NOMBRE_COMPONENTE NO VÁLIDO |
|
VERSIÓN_DEL_SISTEMA OPERATIVO ADMITIDA_INVÁLIDA |
|
FORMATO_RUTA_NO VÁLIDO |
|
TIPO_DE_SISTEMA OPERATIVO INCOMPATIBLE |
|
EXCEPCIÓN DE ACCESO A ACTIVOS |
|
EXCEPCIÓN DE ACCESO A ACTIVOS |
|
VERSIÓN_IB_COMPONENT_BUILD_INVALIDA |
|
INVALID_IB_COMPONENT_PARAMETER |
|
PARÁMETRO_DE_COMPONENTE INVÁLIDO |
|
FALTA EL PARÁMETRO_IB_COMPONENTE |
|
INVALID_IB_COMPONENT_PARAMETER |
|
PRUEBA_LANZAMIENTO_FALLIDA |
|
SSHAuthFailedForUserAndKeypair |
|
COMPONENTE_IB_INVÁLIDO |
|
DUPLICATE_VERSION_TITLE |
|
TÍTULO_DE_VERSIÓN INVÁLIDO |
|
TÍTULO_DE_VERSIÓN INVÁLIDO |
|
INVALID_VERSION_TITLE |
|
TÍTULO_DE_VERSIÓN INVÁLIDO |
|
NOTAS_DE_VERSIÓN INVÁLIDAS |
|
NOTAS_DE_VERSIÓN INVÁLIDAS |
|
INVALID_RELEASE_NOTES |
|
NOTAS_DE_VERSIÓN INVÁLIDAS |
|
INSTRUCCIONES_DE_USO INVÁLIDAS |
|
INSTRUCCIONES_DE_USO INVÁLIDAS |
|
INSTRUCCIONES_DE USO NO VÁLIDAS |
|
TÍTULO_DE_OPCIÓN_DE_ENTREGA DUPLICADOS |
|
TÍTULOS_DE_OPCIÓN_ENTREGA NO VÁLIDOS |
|
Actualización de la información sobre una versión existente
Para actualizar la información sobre una versión existente
-
Desde AWS Marketplace Management Portal, obtenga el identificador del producto.
-
Abra el AWS Marketplace Management Portal
e inicie sesión en su cuenta de vendedor. -
En el menú Productos, seleccione Servidor.
-
En la página de productos del servidor, seleccione el producto.
-
En el resumen del producto, copie el identificador del producto.
-
-
En tu terminal, ejecuta el siguiente comando. En el comando,
your-product-IDsustitúyalo por el ID que obtuviste en el paso 1.aws marketplace-catalog describe-entity --catalog AWSMarketplace --region us-east-1 --entity-id 'your-product-ID' -
En la salida devuelta, vaya a la
DetailsDocumentVersionssección. CopieDeliveryOptionselIdvalor de la versión que desea actualizar. -
Con el siguiente ejemplo de código, crea un archivo de conjunto de cambios en formato JSON. En el ejemplo,
your-product-IDsustitúyelo por el identificador del producto que obtuviste en el paso 1.your-release-notesSustitúyelo por las notas de la versión.your-delivery-option-IDSustitúyelo por el identificador de la opción de entrega que obtuviste en el paso 3.your-usage-instructionsSustitúyalo por las instrucciones 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" } } } ] } } ] -
Guarde el archivo del conjunto de cambios con el nombre
updateVersionInfo.json. -
En tu terminal o AWS CloudShell ejecuta el siguiente comando:
aws marketplace-catalog start-change-set --catalog AWSMarketplace --region us-east-1 --change-set file://updateVersionInfo.json
El start-change-set comando devolverá un ChangeSetId valor. Para supervisar un conjunto de cambios, consulteSupervisar un conjunto de cambios.
Restringir la versión de un producto componente de Image Builder
La restricción de una versión hace que no esté disponible para los compradores. Puedes restringir el uso de la API de AWS Marketplace catálogo de una versión de tu producto componente de Image Builder. AWS Marketplace Debes mantener activa al menos una versión de tu producto sin restricciones AWS Marketplace. No puedes restringir el acceso a la única versión pública.
Para actualizar la información sobre una versión existente
-
Desde AWS Marketplace Management Portal, obtenga el identificador del producto.
-
Abra el AWS Marketplace Management Portal
e inicie sesión en su cuenta de vendedor. -
En el menú Productos, seleccione Servidor.
-
En la página de productos del servidor, seleccione el producto.
-
En el resumen del producto, copie el identificador del producto.
-
-
En tu terminal, ejecuta el siguiente comando. En el comando,
your-product-IDsustitúyalo por el ID que obtuviste en el paso 1.aws marketplace-catalog describe-entity --catalog AWSMarketplace --region us-east-1 --entity-id 'your-product-ID' -
En la salida devuelta, vaya a la
DetailsDocumentVersionssección. CopieDeliveryOptionselIdvalor de la versión que desea actualizar. -
Con el siguiente ejemplo de código, crea un archivo de conjunto de cambios en formato JSON. En el ejemplo,
your-product-IDsustitúyelo por el identificador del producto que obtuviste en el paso 1.your-delivery-option-IDSustitúyelo por el identificador de la opción de envío que obtuviste en el paso 3.[ { "ChangeType": "RestrictDeliveryOptions", "Entity": { "Identifier": "your-product-ID", "Type": "AmiProduct@1.0" }, "DetailsDocument": { "DeliveryOptionIds": [ "your-delivery-option-ID" ] } } ] -
Guarda el archivo del conjunto de cambios con el nombre
restrictec2ibversion.json. -
En tu terminal o AWS CloudShell ejecuta el siguiente comando:
aws marketplace-catalog start-change-set --catalog AWSMarketplace --region us-east-1 --change-set file://restrictec2ibversion.json
El start-change-set comando devolverá un ChangeSetId valor. Para supervisar un conjunto de cambios, consulteSupervisar un conjunto de cambios.
Supervisar un conjunto de cambios
El start-change-set comando devolverá un ChangeSetId valor. Puede supervisar el progreso del conjunto de cambios de las siguientes maneras:
-
Ejecuta el siguiente comando en tu terminal. En el comando,
changeset-IDsustitúyalo por elChangeSetIdvalor devuelto por elstart-change-setcomando.aws marketplace-catalog describe-change-set ‐‐catalog AWSMarketplace ‐‐change-set-idchangesetID -
Consulte el estado de la solicitud en la pestaña Solicitudes del portal AWS Marketplace
de administración.
Proteger las descargas de software
Para proteger la propiedad intelectual del software de los ISV y garantizar una entrega de software estable y coherente a AWS Marketplace los compradores, AWS Marketplace analice S3Download y active automáticamente los WebDownload módulos de su componente. A continuación, los archivos a los que se hace referencia se almacenan de forma segura en un bucket privado de Amazon S3 gestionado por. AWS Marketplace Para excluirse de este proceso de ingesta y gestionar las descargas de software de forma independiente, ejecute los scripts de bash que utilicen los comandos wget or curl download.