Se reestructuró la referencia de 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 componentes de EC2 Image Builder
Como vendedor de AWS Marketplace, puede publicar AMI-based productos entregados a compradores de AWS Marketplace mediante 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 Desarrollo de componentes personalizados para la imagen de Image Builder en la Guía del usuario de Image Builder. Al crear el componente mediante Image Builder, asegúrese de hacer lo siguiente:
-
El componente y todas sus dependencias subyacentes, como un bucket, los secretos o los 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 del 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, introduzca la ubicación estática del 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 al utilizar 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 nombre para un parámetro
region, asegúrese de tener un valor predeterminado válido, comous-east-1. Estos valores predeterminados son para el AWS Marketplace procesamiento y las pruebas. Las pruebas pueden fallar si no incluye los valores predeterminados. -
Si su 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, inserta AWS Command Line Interface los comandos en tu archivo de configuración YAML.
-
Cree la entrada correspondiente en Secrets Manager o Parameter Store en su AWS cuenta. Utilice la clave predeterminada y proporcione un valor válido que ayude a construir el componente durante el proceso de AWS Marketplace prueba. Por ejemplo, supongamos que tiene un parámetro llamado
saas_tokencon un valor predeterminado detokenque utiliza Parameter Store. En este caso, cree un par clave-valor en el almacén de parámetros. Úselotokencomo clave. Para el valor, introduzca un token de SaaS válido para su aplicación.Ten en cuenta que los valores almacenados 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 Amazon Machine Images (AMI) para su componente en todas las versiones de sistemas operativos compatibles que elija durante el proceso de creación del componente. Al crear el 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ás el ARN cuando publiques 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 Componentes, en Propietario del filtro, selecciona 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 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 un rol de AWS Marketplace IAM. Si necesitas ayuda para crear políticas, consulta Cómo crear 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 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 a Secrets Manager, que permite AWS Marketplace recuperar los secretos almacenados en Secrets Manager. Esta política solo es necesaria si el componente usa Secrets Manager para almacenar secretos. Llame a la política
mp_ib_sm_read_only. Para restringir la política únicamente a su secreto, sustituya lo que*aparece en laResourcesección por su secreto. -
Política de acceso de lectura a Parameter Store, que permite AWS Marketplace recuperar los secretos almacenados en Parameter Store. Esta política solo es necesaria si el componente utiliza Parameter Store para almacenar secretos. Llame a la política
mp_ib_ssm_parameter_read_only. Para restringir la política únicamente a su secreto, sustituya lo que*aparece 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 izquierda, selecciona Roles.
-
Elija Crear rol.
-
Selecciona Política de confianza personalizada.
-
Introduce la siguiente declaración:
-
Elija Siguiente.
-
Agregue la política de obtención de componentes de Image Builder que creó anteriormente. Se requiere la política de obtención de componentes. 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 función, por ejemplo
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. Utilizarás el ARN cuando publiques el listado mediante la API de AWS Marketplace catálogo.
Para copiar el AWS Marketplace ARN del rol de IAM
-
En la consola de IAM, en la barra de navegación izquierda, elija Roles.
-
Elija el rol AWS Marketplace de IAM que creó anteriormente, por ejemplo.
MPEC2IBIngestion -
En la página de detalles del rol, en la sección Resumen, copia 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 instancias compatibles y la región de AWS.
-
Información sobre precios: puede ofrecer su producto de forma gratuita, con una tarifa por hora o con un período de prueba inicial gratuito. No se admite la licencia Bring Your Own License (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 de los componentes de Image Builder
Este tema contiene instrucciones para publicar la lista de componentes de EC2 Image Builder AWS Marketplace sobre el uso de AWS Marketplace la API de catálogo.
Requisitos previos
Asegúrese de disponer de lo siguiente antes de publicar la lista de productos de los componentes de Image Builder:
-
Registro como vendedor en AWS Marketplace. Para obtener más información, consulte Registrarse como vendedor de AWS Marketplace
. -
Usuario de IAM con
AWSMarketplaceSellerFullAccesspermiso. -
Un depósito de Amazon Simple Storage Service (Amazon S3) de acceso público para alojar el logotipo de su empresa y el EULA, si se utiliza en su componente. Introducirá la URL del bucket de S3 en su 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 mediante AWS Marketplace la API de catálogo, consulteCree 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 de los componentes de 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 para servidores, seleccione el producto.
-
En la página de detalles del producto, en el menú Solicitar cambios, selecciona el artículo que corresponda a la información que deseas actualizar.
-
Tras enviar cualquier cambio, la solicitud aparecerá en la pestaña Solicitudes con el estado «En revisión» y cambiará a «Aceptada» 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 al AWS Marketplace utilizar el AWS Marketplace Catalog API.
Agregar una nueva versión
-
Desde el AWS Marketplace Management Portal, obtenga el ID del producto.
-
Abra el AWS Marketplace Management Portal
e inicie sesión en su cuenta de vendedor. -
En el menú Productos, selecciona Servidor.
-
En la página de productos para servidores, seleccione el producto.
-
En el resumen del producto, copia el identificador del producto.
-
-
Con el siguiente ejemplo de código, cree un archivo de conjunto de cambios en formato JSON. En el ejemplo,
your-product-IDsustitúyalo por el identificador de producto que obtuviste en el paso 1.new-version-nameSustitúyalo por el título de la versión.new-delivery-option-titleSustitúyalo por el título de la opción de envío.[ { "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, consulteSupervisión de un conjunto de cambios.
Errores asíncronos
Los siguientes errores son específicos de las AddDeliveryOptions acciones de. 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 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 |
|
ASSET_NOT_FOUND |
|
DUPLICATE_COMPONENT_NAME |
|
DUPLICATE_COMPONENT_NAME |
|
DUPLICATE_COMPONENT_ARN |
|
DUPLICATE_COMPONENT_ARN |
|
SCAN_ERROR |
|
ASSET_ACCESS_EXCEPTION |
|
ASSET_ACCESS_EXCEPTION |
|
ASSET_ACCESS_EXCEPTION |
|
ASSET_ACCESS_EXCEPTION |
|
INVALID_IMAGE_BUILDER_COMPONENT_PACKAGE |
|
INVALID_IMAGE_BUILDER_COMPONENT_PACKAGE |
|
DEMASIADOS COMPONENTES DE IMAGE_BUILDER_COMPONENTS |
|
INCOMPLETE_SELLER_PUBLIC_PROFILE |
|
DESCRIPCIÓN_INVÁLIDA |
|
NOMBRE_DE_COMPONENTE NO VÁLIDO |
|
VERSIÓN DE SISTEMA OPERATIVO ADMITIDA NO VÁLIDA |
|
FORMATO_DE_RUTA NO VÁLIDO |
|
INCOMPATIBLE_OS_TYPE |
|
ASSET_ACCESS_EXCEPTION |
|
ASSET_ACCESS_EXCEPTION |
|
INVALID_IB_COMPONENT_BUILD_VERSION |
|
INVALID_IB_COMPONENT_PARAMETER |
|
INVÁLID_IB_COMPONENT_PARAMETER |
|
MISSING_IB_COMPONENT_PARAMETER |
|
INVÁLID_IB_COMPONENT_PARAMETER |
|
FALLED_LAUNCH_TEST |
|
SSHAuthFailedForUserAndKeypair |
|
INVÁLID_IB_COMPONENT |
|
DUPLICATE_VERSION_TITLE |
|
TITLE_DE_VERSIÓN_INVÁLIDO |
|
TITULO_DE_VERSIÓN_INVALIDO |
|
TÍTULO_DE_VERSIÓN_INVÁLIDO |
|
TITLE_DE_VERSIÓN_INVÁLIDO |
|
NOTAS DE PUBLICACIÓN NO VÁLIDAS |
|
INVALID_RELEASE_NOTES |
|
NOTAS DE PUBLICACIÓN NO VÁLIDAS |
|
NOTAS DE PUBLICACIÓN NO VÁLIDAS |
|
INSTRUCCIONES_DE_USO INVÁLIDAS |
|
INSTRUCCIONES DE USO NO VÁLIDAS |
|
INSTRUCCIONES_DE_USO INVÁLIDAS |
|
DUPLICATE_DELIVERY_OPTION_TITLES |
|
TÍTULO_DE_OPCIÓN_DE_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, selecciona Servidor.
-
En la página de productos para servidores, seleccione el producto.
-
En el resumen del producto, copia 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 el resultado devuelto, vaya a la
VersionssecciónDetailsDocument,. Copia elIdvalorDeliveryOptions, de la versión que deseas actualizar. -
Con el siguiente ejemplo de código, cree un archivo de conjunto de cambios en formato JSON. En el ejemplo,
your-product-IDsustitúyalo por el identificador de producto que obtuviste en el paso 1.your-release-notesSustitúyalo por las notas de la versión.your-delivery-option-IDSustitúyalo por el identificador de la opción de entrega que obtuviste en el paso 3.your-usage-instructionsSustitúyalo por tus 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" } } } ] } } ] -
Guarda 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, consulteSupervisión de un conjunto de cambios.
Restringir la versión de un producto componente de Image Builder
Restringir una versión hace que no esté disponible para los compradores. Puede restringir una versión de su producto componente de Image Builder AWS Marketplace mediante la API de AWS Marketplace catálogo. Debe conservar al menos una versión de su 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, selecciona Servidor.
-
En la página de productos para servidores, seleccione el producto.
-
En el resumen del producto, copia 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 el resultado devuelto, vaya a la
VersionssecciónDetailsDocument,. Copia elIdvalorDeliveryOptions, de la versión que deseas actualizar. -
Con el siguiente ejemplo de código, cree un archivo de conjunto de cambios en formato JSON. En el ejemplo,
your-product-IDsustitúyalo por el identificador de producto que obtuviste en el paso 1.your-delivery-option-IDSustitúyalo por el identificador de la opción de entrega 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, consulteSupervisión de un conjunto de cambios.
Supervisión de 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-IDsustituya 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 ISV y garantizar una entrega de software estable y coherente a AWS Marketplace los compradores, analiza S3Download y activa AWS Marketplace 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 scripts bash que utilicen los comandos wget or curl download.