View a markdown version of this page

Trabaja con AMI-based productos - AWS Marketplace

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.

Trabaja con AMI-based productos

Puede utilizarla AWS Marketplace Catalog API para automatizar las tareas de trabajo con productos basados en Amazon Machine Image (AMI).

Para obtener información sobre cómo crear un AMI-based producto mediante la API de catálogo, consulteCree un producto.

En los siguientes temas, se describe cómo usar la API de catálogo para realizar acciones en tus AMI-based productos:

Agregar una nueva versión

Puedes usar la API de catálogo para agregar una nueva versión a un AMI-based producto existente en AWS Marketplace. Para obtener más información sobre cómo añadir nuevas versiones de la AMI a tu producto mediante el AWS Marketplace Management Portal, consulta Añadir una nueva versión en la Guía del AWS Marketplace vendedor.

Al crear una solicitud que incluya la adición de una nueva AMI a AWS Marketplace, la AMI debe copiarse en el sistema AWS Marketplace y, a continuación, escanearse para detectar problemas de seguridad. Debe conceder a AWS Marketplace acceso a la AMI creando un rol de administración de identidades y accesos (IAM) de AWS con permisos para realizar acciones en su AMI. Para obtener más información sobre los permisos necesarios, consulte Cómo conceder a AWS Marktplace el acceso a su AMI en la guía del AWS Marketplace vendedor.

Para añadir una nueva versión, llame a la operación de la StartChangeSet API con el tipo de AddDeliveryOptions cambio para AMI-based los productos, como se muestra en el siguiente ejemplo. Para probar tu llamada a la API sin crear realmente una nueva versión, establece el Intent parámetro enVALIDATE. Para obtener más información, consulta Intent.

nota

En el caso de los productos AMI, una versión se compone de una o más opciones de entrega. Todas las opciones de entrega de la misma versión deben tener el mismo AmiSource objeto con los mismos detalles. Todas las opciones de entrega deben añadirse a una versión al crearla. No es posible añadir opciones de entrega a una versión existente.

Sintaxis de la solicitud

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" }

La siguiente lista proporciona información sobre los campos de entrada que se utilizan con el tipo de AddDeliveryOptions cambio. Todos los campos son obligatorios, a menos que se indique lo contrario. Para obtener más información sobre estos campos, consulta Añadir una nueva versión en la Guía del AWS Marketplace vendedor.

  • DeliveryOptions(conjunto de objetos): una lista de los objetos de las opciones de entrega, con los detalles de cada uno de ellos. Debes incluir al menos uno.

    • Para la opción de entrega AMI (independiente), especifique un objeto con los siguientes detalles. Solo puede tener una opción de entrega con este tipo.

      • Detalles (objeto): contiene los detalles de esta opción de entrega. Tenga en cuenta que no es necesario que este objeto de detalles anidados tenga un doble escape.

        • AmiDeliveryOptionDetails(objeto): se utiliza para proporcionar los detalles de cada opción de entrega de la AMI.

          • AmiSource(objeto): detalles sobre la AMI que se utilizará en la versión agregada.

            • AmiId(cadena): ID de la AMI de origen, ubicada en el Región de AWS lugar donde se llama a la API. Siempre debe ser el este de EE. UU. (Virginia del Norte), ya que es la única región en la que está disponible la API de catálogo. Debe pertenecer a la cuenta de la persona que llama.

            • AccessRoleArn(cadena): el nombre de recurso de Amazon (ARN) del rol de IAM utilizado AWS Marketplace para acceder a la AMI proporcionada. Para obtener más información sobre la creación y el uso de este ARN, consulte Cómo conceder a AWS Marketplace el acceso a su AMI en la Guía del AWS Marketplace vendedor.

            • UserName(cadena): nombre de usuario de inicio de sesión para acceder al sistema operativo (SO) de la AMI. Por lo general, ec2-user para las AMI de Linux o Administrator para Windows.

            • ScanningPort(entero): puerto SSH o RDP utilizado para acceder al sistema operativo. Se utiliza para analizar la AMI proporcionada en busca de vulnerabilidades de seguridad. El valor predeterminado es 22.

            • OperatingSystemName(cadena): nombre del sistema operativo que se muestra a los compradores.

            • OperatingSystemVersion(cadena): la cadena de versiones del sistema operativo que se muestra a los compradores.

            • AfiIds(conjunto de cadenas) (opcional): identificadores de imagen FPGA (AFI) de Amazon para habilitar la compatibilidad con FPGA en esta versión. Cuando se proporciona, esto permite que el producto se ejecute en los tipos de instancia FPGA-enabled F2. Puede proporcionar hasta 15 ID de AFI por versión. Todos los ID de la AFI que proporcione deben provenir de la región Este de EE. UU. (Norte de Virginia), residir en la cuenta de vendedor de AWS Marketplace y el rol de acceso de IAM proporcionado debe tener permisos para compartir esta AFI con AWS Marketplace. Para obtener más información sobre los permisos necesarios, consulte Cómo conceder a AWS Marketplace el acceso a sus imágenes de FPGA en la Guía del AWS Marketplace vendedor.

          • UsageInstructions(cadena): instrucciones para usar la AMI o un enlace para obtener más información sobre la AMI.

          • AccessEndpointUrl(objeto) (opcional): se usa para crear una ruta para acceder a la AMI después de usarla.

            • Puerto (cadena): el número de puerto utilizado para acceder al servicio que se ejecuta en la AMI.

            • Protocolo (cadena): el protocolo (http o https) utilizado para acceder al servicio que se ejecuta en la AMI.

            • RelativePath(cadena): la ruta desde la raíz web para acceder al servicio que se ejecuta en la AMI (por ejemplo, /index.html).

          • RecommendedInstanceType(cadena): el tipo de instancia que se recomienda para ejecutar el servicio con la AMI y que es el predeterminado para las instalaciones del servicio con un solo clic. Para obtener una lista de los tipos de instancias, consulte los tipos de instancia en la Guía del usuario de Amazon Elastic Compute Cloud para instancias de Linux.

          • SecurityGroups(matriz de objetos): una lista de objetos que representan las reglas de ingreso para los grupos creados automáticamente para la versión.

            • IpProtocol(cadena): el protocolo que se va a usar (tcp o udp).

            • FromPort(entero): el puerto de origen.

            • ToPort(entero): el puerto de destino.

            • IpRanges(matriz de cadenas): rangos de IP permitidos, en formato CIDR (con el formato xxx.xxx.xxx). xxx/nn, por ejemplo,). 192.0.2.0/24

    • En el caso de una AMI con opción de CloudFormation entrega, especifique un objeto con los siguientes detalles. Puede tener hasta tres opciones de entrega de este tipo.

      • DeliveryOptionTitle(cadena): título de la opción de entrega.

      • Detalles (objeto): contiene los detalles de una opción de entrega de AMI. Tenga en cuenta que no es necesario que este objeto de detalles anidado tenga un doble escape.

        • DeploymentTemplateDeliveryOptionDetails(objeto): se utiliza para proporcionar los detalles de cada opción de entrega mediante CFT.

          • ShortDescription(cadena): breve descripción de la opción de envío de tu CloudFormation plantilla.

          • LongDescription(cadena): descripción detallada de la opción de entrega de tu CloudFormation plantilla.

          • UsageInstructions(string): instrucciones para usar la AMI o un enlace para obtener más información sobre la AMI.

          • RecommendedInstanceType(cadena): el tipo de instancia que se recomienda para ejecutar el servicio con la AMI y que es el predeterminado para las instalaciones del servicio con un solo clic. Para obtener una lista de los tipos de instancias, consulte los tipos de instancia en la Guía del usuario de Amazon Elastic Compute Cloud para instancias de Linux.

          • ArchitectureDiagram(cadena): URL a la ubicación de su diagrama arquitectónico en Amazon S3.

          • Plantilla (cadena): URL a la ubicación de su CloudFormation plantilla en Amazon S3.

          • TemplateSources(conjunto de objetos)

            • ParameterName(cadena): nombre del parámetro de la CloudFormation plantilla al que se debe transferir la AMI de esta versión. Para obtener más información, consulte Requisitos para los detalles de la AMI.

            • AmiSource(objeto)

              • AmiId(cadena): ID de la AMI de origen, ubicada en el Región de AWS lugar donde se llama a la API (actualmente siempre debe ser EE. UU. (Virginia del Norte) porque es la única región en la que está disponible la API de catálogo). Debe pertenecer a la cuenta de la persona que llama.

              • AccessRoleArn(cadena): el nombre de recurso de Amazon (ARN) del rol de IAM utilizado Región de AWS para acceder a la AMI proporcionada. Para obtener más información sobre la creación y el uso de este ARN, consulte Cómo conceder a AWS Marketplace el acceso a su AMI en la Guía del AWS Marketplace vendedor.

              • UserName(cadena): nombre de usuario de inicio de sesión para acceder al sistema operativo (SO) de la AMI. Por lo general, ec2-user para las AMI de Linux o Administrator Windows.

              • OperatingSystemName(cadena): nombre del sistema operativo que se muestra a los compradores.

              • OperatingSystemVersion(cadena): la cadena de versiones del sistema operativo que se muestra a los compradores.

Sintaxis de respuesta

Se crea un conjunto de cambios para su solicitud. La respuesta a esta solicitud le proporciona la dirección ChangeSetId y ChangeSetArn para el conjunto de cambios y tiene el siguiente aspecto.

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

La solicitud de cambio se agrega a una cola y se procesa. Esto incluyó la validación de la información para garantizar que cumple con las AWS Marketplace directrices. El proceso de validación puede tardar desde unos minutos hasta unas horas.

Puedes comprobar el estado de la solicitud a través de la AWS Marketplace Management Portal API de catálogo o directamente a través de la operación de la DescribeChangeSet API.

Para obtener más información sobre los errores en los conjuntos de cambios de productos del vendedor, consultaCambia el estado y los errores del conjunto.

Cuando se complete la solicitud, se añadirá la versión y los suscriptores actuales recibirán un mensaje de correo electrónico informándoles sobre la nueva versión. Para obtener más información sobre el proceso de añadir una nueva versión, consulta Añadir una nueva versión en la Guía del AWS Marketplace vendedor.

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.

Código de error Mensaje de error
INVALID_AMI_NAME El prefijo (x) del nombre de la AMI no es válido. Introduzca un nombre nuevo con el nombre de su empresa o marca como prefijo.

PRODUCTO_INVÁLIDO

Usa un producto público o limitado existente.

TÍTULO_DE LA VERSIÓN_DUPLICADO

El título de la versión debe ser diferente al de cualquier otro título de versión de este producto.

TÍTULO_DE_VERSIÓN INVÁLIDO

Elimine los espacios antes del símbolo de la marca comercial.

TÍTULO_DE_VERSIÓN INVÁLIDO

Elimine los caracteres no compatibles: [x, y, z]

INVALID_VERSION_TITLE

Elimine los espacios del principio del título de la versión.

TÍTULO_DE_VERSIÓN INVÁLIDO

Proporcione el título de la versión con menos de [x] caracteres.

NOTAS_DE_VERSIÓN INVÁLIDAS

Elimine los espacios antes del símbolo de la marca comercial.

NOTAS_DE_VERSIÓN INVÁLIDAS

Elimine los caracteres no compatibles: [x, y, z]

INVALID_RELEASE_NOTES

Elimine los espacios del principio de las notas de la versión.

NOTAS_DE_VERSIÓN INVÁLIDAS

Proporcione notas de la versión con menos de (x) caracteres.

INSTRUCCIONES_DE_USO INVÁLIDAS

Elimine los espacios antes del símbolo de la marca comercial.

INSTRUCCIONES_DE_USO INVÁLIDAS

Elimine los caracteres no compatibles: [x, y, z]

INSTRUCCIONES_DE USO NO VÁLIDAS

Elimine los espacios del principio de las notas de la versión.

INSTRUCCIONES_DE_USO INVÁLIDAS

Proporcione instrucciones de uso con menos de (x) caracteres.

TIPO_DE_INSTANCIA_RECOMENDADO_NO DISPONIBLE

Proporcione un tipo de instancia existente y disponible.

TIPO_DE_INSTANCIA_RECOMENDADO NO VÁLIDO

Proporcione un tipo de instancia válido.

GRUPO_DE_SEGURIDAD_INVÁLIDO

Los puertos del grupo de seguridad deben estar entre 1 y [máximo].

GRUPO_DE_SEGURIDAD_INVÁLIDO

Proporcione un valor para los rangos de IP de CIDR.

GRUPO_DE_SEGURIDAD_INVÁLIDO

Proporcione un puerto de inicio del grupo de seguridad que no sea mayor que el puerto final.

PROTOCOLO DE GRUPO_DE_SEGURIDAD NO VÁLIDO

El protocolo del grupo de seguridad debe ser «tcp» o «UDP».

CIDR_IP NO VÁLIDA

Proporcione el rango de IP CIDR estándar en el formulario «0.0.0». 0/0'.

PUERTO_ENDPOINT_DE ACCESO NO VÁLIDO

Proporcione un puerto de punto final inferior a [x].

PUERTO_ENDPOINT_DE ACCESO NO VÁLIDO

Proporcione un puerto de punto final entre 1 y [máx.].

PUERTO_ENDPOINT_DE ACCESO NO VÁLIDO

Proporcione el puerto de punto final.

RUTA_RELATIVA_DEL_PUNTO DE ACCESO INVÁLIDO

Elimine los espacios de la ruta relativa.

RUTA_RELATIVA_DEL_PUNTO DE ACCESO INVÁLIDO

Elimine el '/' anterior de la ruta relativa.

SISTEMA_OPERATIVO_INCOMPATIBLE

Proporcione el nombre y la versión del sistema operativo que sean compatibles con los tipos de instancia: [x]

INCOMPATIBLE_OPERATING_SYSTEM_NAME

Proporcione un nombre con menos de (x) caracteres.

NOMBRE_DE_SISTEMA_OPERATIVO INCOMPATIBLE

Proporcione el nombre del sistema operativo compatible.

VERSIÓN_DE_SISTEMA_OPERATIVO INCOMPATIBLE

Proporcione una versión con menos de (x) caracteres.

PUERTO_DE_ESCANEO NO VÁLIDO

Proporcione un puerto de escaneo entre 1 y [máx.].

AMI_ID NO VÁLIDO

Proporcione un ID de AMI válido.

CÓDIGO_DE_PRODUCTO_AMI EXISTENTE

Elimine el código de producto adjunto a la imagen X.

INVALID_AMI_ARCHITECTURE

Proporcione una nueva AMI con arquitectura [x].

TIPO_AMI_VIRTUALIZACIÓN_NO VÁLIDO

Proporcione una nueva AMI con el tipo de virtualización [x].

TIPO_AMI_VIRTUALIZACIÓN_NO VÁLIDO

Proporcione el volumen [z] esperado en la imagen [x].

AMI INCOMPATIBLE

Proporcione una nueva AMI, ya que la arquitectura [x] de [y] no es compatible con los siguientes tipos de instancias: [z]

INCOMPATIBLE_AMI

Proporcione una nueva AMI, ya que los siguientes tipos de instancias no admiten el tipo de virtualización [x] en [y]:

INCOMPATIBLE_AMI

Habilite la compatibilidad con ENA para la imagen x, ya que los siguientes tipos de instancias requieren compatibilidad con ENA: [y]

ASSET_NOT_FOUND

Compruebe si [ami-id] existe en la región us-east-1 de [account-id] Cuenta de AWS y si el [ARN] AccessARN proporcionado tiene permisos para compartir esta AMI con ella. AWS Marketplace

EXCEPCIÓN DE ACCESO A ACTIVOS

No se puede copiar la AMI [x] a la cuenta. AWS Marketplace

ERROR DE ESCANEO

Corrija la vulnerabilidad de seguridad [y] en la imagen [x].

ACTIVO NO ENCONTRADO

Comprueba si [afi-id] existe en la región us-east-1 de [account-id] Cuenta de AWS y si el [ARN] AccessARN proporcionado tiene permiso para compartir este AFI con él. AWS Marketplace

EXCEPCIÓN DE ACCESO A ACTIVOS

No se puede acceder a AFI. Compruebe si AccessARN proporcionado [ARN] tiene permisos para compartir esta AFI AWS Marketplace y acceder al rol La cuenta es propietaria de AFI.

FALTA EL TIPO_DE_INSTANCIA DE FPGA

No se encontró ningún tipo de instancia basado en FPGA. Utilice AddInstanceTypes el tipo de cambio para agregar un tipo de instancia basado en FPGA.

También puedes crear un AMI-based producto mediante AWS Marketplace Management Portal. Para obtener más información, consulta los productos de AMI en la Guía del AWS Marketplace vendedor.

Si quieres ver un tutorial sobre cómo automatizar la actualización de tus AMI-based productos, también puedes consultar el vídeo titulado Cómo automatizar las actualizaciones de tus listados de productos AWS Marketplace con la API de catálogo (5:08).

Actualizar la información de la versión

Puedes usar la API de catálogo para actualizar los detalles de una versión existente de tu producto en. AMI-based AWS Marketplace

nota

Para obtener más información sobre la actualización de la información de la versión mediante el AWS Marketplace Management Portal, consulta Cómo actualizar la información de la versión en la Guía del AWS Marketplace vendedor.

No puedes actualizar la AMI para esa versión. Si necesita actualizar la AMI, cree una nueva versión en su lugar.

Para agregar una nueva versión, llame a la operación de la StartChangeSet API con el tipo de UpdateDeliveryOptions cambio, como se muestra en el siguiente ejemplo.

Sintaxis de la solicitud

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." } } } ] } } ] }

A continuación se muestra información sobre los campos de entrada que proporciona para agregar el tipo de UpdateDeliveryOptions cambio. Para obtener más información sobre estos campos, consulta Cómo actualizar la información de la versión en la Guía del AWS Marketplace vendedor.

  • Entidad (objeto) (obligatorio): tu AMI-based producto.

    • Identificador (cadena) (obligatorio): el identificador de su producto. Para obtener más información, consulte Identificador.

    • Tipo (cadena) (obligatorio): Type se basa en el método de entrega (tipo de producto) que utilizará tu producto:AmiProduct@1.0.

  • DetailsDocument(objeto) (obligatorio): detalles de la solicitud. Incluye toda la información sobre la versión de tu AMI-based producto que deseas actualizar. Todos los campos incluidos son opcionales, pero debes incluir al menos un campo para actualizarlos.

    • Versión (objeto): detalles sobre la versión del software.

      • ReleaseNotes(cadena): notas para que los compradores les informen sobre los cambios de una versión a la siguiente.

    • DeliveryOptions(conjunto de objetos): lista de objetos de opciones de entrega. Incluye solo las opciones de entrega que quieras actualizar.

      • Para la opción de entrega AMI (independiente), especifique un objeto con los siguientes detalles. Incluya solo los campos que desee actualizar. Todos los campos son opcionales, a menos que se indique lo contrario.

        • ID (cadena) (obligatorio): identificador único de la opción de envío (puedes obtener el identificador único de la opción de entrega llamando a la DescribeEntity acción correspondiente al producto que estás actualizando).

        • Detalles (objeto): contiene los detalles de una opción de entrega de AMI. Tenga en cuenta que no es necesario que este objeto de detalles anidado tenga un doble escape.

          • AmiDeliveryOptionDetails(objeto): los detalles de una opción de entrega de la AMI.

            • UsageInstructions(cadena): instrucciones para usar la AMI o un enlace para obtener más información sobre la AMI.

            • AccessEndpointUrl(objeto): se usa para crear una ruta para acceder a la AMI después de usarla.

              • Puerto (cadena): el número de puerto utilizado para acceder al servicio que se ejecuta en la AMI.

              • Protocolo (cadena): el protocolo (httpohttps) utilizado para acceder al servicio que se ejecuta en la AMI.

              • RelativePath(cadena): la ruta desde la raíz web para acceder al servicio que se ejecuta en la AMI (por ejemplo/index.html).

            • RecommendedInstanceType(cadena): el tipo de instancia que se recomienda para ejecutar el servicio con la AMI y que es el predeterminado para las instalaciones del servicio con un solo clic.

            • SecurityGroups(matriz de objetos): una lista de objetos que representan las reglas de entrada para los grupos creados automáticamente para la versión:

              • FromPort(entero): el puerto de origen.

              • IpProtocol(cadena): el protocolo que se va a usar (tcpoidp).

              • IpRanges(matriz de cadenas): rangos de IP permitidos, en formato CIDR (con el formato xxx.xxx.xxx). xxx/nn, por ejemplo,). 192.0.2.0/24

              • ToPort(entero): el puerto de destino.

      • En el caso de una AMI con opción de CloudFormation entrega, especifique un objeto con los siguientes detalles. Incluya solo los campos que desee actualizar. Todos los campos son opcionales, a menos que se indique lo contrario.

        • ID (cadena) (obligatorio): identificador único de la opción de envío (puedes obtener el identificador único de la opción de entrega llamando a la DescribeEntity acción correspondiente al producto que estás actualizando).

        • Detalles (objeto): contiene los detalles de una opción de entrega de AMI. Tenga en cuenta que no es necesario que este objeto de detalles anidado tenga un doble escape.

          • DeploymentTemplateDeliveryOptionDetails(objeto): se utiliza para proporcionar los detalles de cada opción de entrega mediante CFT.

            • DeliveryOptionTitle(cadena): título de la opción de entrega.

            • ShortDescription(cadena): descripción breve de la opción de envío de tu CloudFormation plantilla.

            • LongDescription(cadena): descripción detallada de la opción de entrega de tu CloudFormation plantilla.

            • UsageInstructions(string): instrucciones para usar la AMI o un enlace para obtener más información sobre la AMI.

            • RecommendedInstanceType(cadena): el tipo de instancia que se recomienda para ejecutar el servicio con la AMI y que es el predeterminado para las instalaciones del servicio con un solo clic. Para obtener una lista de los tipos de instancias, consulte los tipos de instancia en la Guía del usuario de Amazon Elastic Compute Cloud para instancias de Linux.

            • ArchitectureDiagram(cadena): URL a la ubicación de su diagrama arquitectónico en Amazon S3.

            • Plantilla (cadena): URL a la ubicación de su CloudFormation plantilla en Amazon S3.

            • TemplateSources(conjunto de objetos)

              • ParameterName(cadena): nombre del parámetro de la CloudFormation plantilla al que se debe transferir la AMI de esta versión. Para obtener más información, consulte Requisitos para los detalles de la AMI.

              • AmiSource(objeto)

                • AmiId(cadena): ID de la AMI de origen, ubicada en el Región de AWS lugar donde se llama a la API (actualmente siempre debe ser EE. UU. (Virginia del Norte) porque es la única región en la que está disponible la API de catálogo). Debe pertenecer a la cuenta de la persona que llama.

                • AccessRoleArn(cadena): el nombre de recurso de Amazon (ARN) del rol de IAM utilizado Región de AWS para acceder a la AMI proporcionada. Para obtener más información sobre la creación y el uso de este ARN, consulte Cómo conceder a AWS Marketplace el acceso a su AMI en la Guía del AWS Marketplace vendedor.

                • UserName(cadena): nombre de usuario de inicio de sesión para acceder al sistema operativo (SO) de la AMI. Por lo general, ec2-user para las AMI de Linux o Administrator para Windows.

                • OperatingSystemName(cadena): nombre del sistema operativo que se muestra a los compradores.

                • OperatingSystemVersion(cadena): la cadena de versiones del sistema operativo que se muestra a los compradores.

Sintaxis de respuesta

Se crea un conjunto de cambios para su solicitud. La respuesta a esta solicitud le proporciona la dirección ChangeSetId y ChangeSetArn para el conjunto de cambios y tiene el siguiente aspecto.

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

La solicitud de cambio se agrega a una cola y se procesa. Esto incluyó la validación de la información para garantizar que cumple con las AWS Marketplace directrices. El proceso de validación puede tardar desde unos minutos hasta unas horas.

Puedes comprobar el estado de la solicitud a través de la AWS Marketplace Management Portal API de catálogo o directamente a través de la operación de la DescribeChangeSet API.

Para obtener más información sobre los conjuntos de cambios, consulte Trabajar con conjuntos de cambios. Para obtener más información sobre los errores en los conjuntos de cambios de productos del vendedor, consultaCambia el estado y los errores del conjunto.

Errores asincrónicos

Los siguientes errores son específicos de UpdateDeliveryOptions 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.

Puede recuperar UpdatePricingTerms acciones mediante la DescribeChangeSet operación una vez que el conjunto de cambios comience a procesarse. Para obtener más información sobre los detalles de los errores y la solución de problemasCambia el estado y los errores del conjunto, consulte la sección anterior de esta guía.

Código de error Mensaje de error
INVALID_PRODUCT Usa un producto público o limitado existente.
IDENTIFICADORES DE OPCION_DE_ENTREGA FALTANTES Proporciona al menos un identificador de opción de entrega.
IDENTIFICADORES DE OPCION_DE_ENTREGA NO VÁLIDOS Proporciona los identificadores de las opciones de entrega que se encuentran en el producto. Identificadores no encontrados: [x]
INVALID_DELIVERY_OPTIONS Proporciona los identificadores de las opciones de envío que pertenezcan a la misma versión.

Restringir una versión

Puedes usar la API de catálogo para restringir una versión de tu AMI-based producto. Esto evita que los nuevos compradores usen esa versión, pero la mantiene disponible para los compradores actuales. Al restringir todas las opciones de entrega de una versión, se restringe la versión. Al restringir una o más opciones de entrega de una versión, pero no todas, solo se restringen las opciones de entrega de esa versión. Siempre debes tener disponible al menos una versión sin restricciones de un producto, por lo que no puedes restringir la última versión de un producto disponible públicamente.

nota

Para obtener más información sobre cómo restringir las versiones de la AMI AWS Marketplace a través del AWS Marketplace Management Portal, consulta Cómo restringir una versión en la Guía del AWS Marketplace vendedor.

Para restringir una versión, llama a la operación de la StartChangeSet API con el tipo de RestrictDeliveryOptions cambio, como se muestra en el siguiente ejemplo.

nota

Todos los suscriptores pueden usar la versión actual independientemente del estado de restricción. AWS Marketplace Las directrices exigen que sigas ofreciendo asistencia a los compradores actuales durante 90 días después de restringir la versión. Su AMI se marcará como obsoleta cuando se restrinja la versión. Para obtener más información, consulte Dar de baja una AM en la Guía del usuario de Amazon Elastic Compute Cloud para instancias de Windows .

Sintaxis de la solicitud

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" ] } } ] }

La siguiente es la información sobre los campos de entrada que proporcionas para añadir el tipo de RestrictDeliveryOptions cambio:

  • Entidad (objeto) (obligatorio): tu AMI-based producto.

    • Identificador (cadena) (obligatorio): el identificador de su producto. Para obtener más información, consulte Identificador.

    • Tipo (cadena) (obligatorio): Type se basa en el método de entrega (tipo de producto) que utilizará tu producto:AmiProduct@1.0.

  • DetailsDocument(objeto) (obligatorio): detalles de la solicitud. Incluye los ID de las versiones de tu AMI-based producto que deseas restringir.

    • DeliveryOptionIds(conjunto de objetos): lista de DeliveryOption identificadores de las versiones que desea restringir. Puede obtener el identificador único del DeliveryOption llamando a la DescribeEntity acción en la versión que está restringiendo.

Sintaxis de respuesta

Se crea un conjunto de cambios para su solicitud. La respuesta a esta solicitud le proporciona la dirección ChangeSetId y ChangeSetArn para el conjunto de cambios y tiene el siguiente aspecto.

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

La solicitud de cambio se agrega a una cola y se procesa. Esto incluyó la validación de la información para garantizar que cumple con las AWS Marketplace directrices. El proceso de validación puede tardar desde unos minutos hasta unas horas.

Puedes comprobar el estado de la solicitud a través de la AWS Marketplace Management Portal API de catálogo o directamente a través de la operación de la DescribeChangeSet API.

Errores asincrónicos

Los siguientes errores son específicos de RestrictDeliveryOptions 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.

Código de error Mensaje de error

INVALID_PRODUCT

Usa un producto público existente.

IDENTIFICADORES DE OPCIONES DE ENTREGA FALTANTES

Proporciona al menos un identificador de opción de entrega.

IDENTIFICADORES DE OPCION_DE_ENTREGA NO VÁLIDOS

Proporciona los identificadores de las opciones de entrega que se encuentran en el producto. Identificadores no encontrados: [x]

OPCIÓN INVALID_DELIVERY_OPTION

Proporciona los identificadores de las opciones de entrega que estén en un estado público. Identificaciones que no están en estado público: [x]

TODAS LAS OPCIONES DE ENTREGA RESTRINGIDAS

Proporcione menos opciones de entrega para restringir, ya que al menos una debe permanecer en estado público.

Actualizar el futuro Región de AWS compatibilidad

Puedes usar la API de catálogo para cambiar las futuras preferencias de Región de AWS soporte de tu AMI-based producto en AWS Marketplace.

nota

Para obtener más información sobre cómo cambiar el soporte de futuras regiones de AWS mediante el AWS Marketplace Management Portal, consulte Actualizar el soporte para futuras regiones de AWS en la Guía del AWS Marketplace vendedor.

nota

El tipo de UpdateFutureRegionSupport cambio solo está disponible enAmiProduct@1.0.

Para cambiar las preferencias de Región de AWS soporte futuras, llame a la operación de la StartChangeSet API con el tipo de UpdateFutureRegionSupport cambio, como se muestra en el siguiente ejemplo.

Sintaxis de la solicitud

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" ] } } } ] }

Proporcione información sobre los campos para agregar el tipo de UpdateFutureRegionSupport cambio:

  • Entity(objeto) (obligatorio): su AMI-based producto.

    • Identifier(cadena) (obligatorio): su identificador de producto. Para obtener más información, consulte Identificador.

    • Type(cadena) (obligatorio): Type se basa en el método de entrega (tipo de producto) que utilizará tu producto:AmiProduct@1.0.

  • DetailsDocument(objeto) (obligatorio): los detalles necesarios para ejecutar el ChangeSet.

    • FutureRegionSupport— Objeto

      • SupportedRegions— Single-element conjunto de cadenas

        Valores compatibles con el elemento: uno de ["All","US","None"]

Sintaxis de respuesta

Se crea un conjunto de cambios para su solicitud. La respuesta a esta solicitud le proporciona la dirección ChangeSetId y ChangeSetArn para el conjunto de cambios y tiene el siguiente aspecto.

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

La solicitud de cambio se agrega a una cola y se procesa. Esto incluyó la validación de la información para garantizar que cumple con las AWS Marketplace directrices. El proceso de validación puede tardar desde unos minutos hasta unas horas.

Puedes comprobar el estado de la solicitud a través de la AWS Marketplace Management Portal API de catálogo o directamente a través de la operación de la DescribeChangeSet API.

Errores asincrónicos

Los siguientes errores son específicos de UpdateFutureRegionSupport 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.

Código de error Mensaje de error
DEMASIADAS REGIONES Actualmente, solo se admite un valor para FutureRegionSupport: Todos, EE. UU. o Ninguno
INVALID_REGIONS Las regiones solicitadas [a, b, c] no son válidas o no están disponibles. Solo los valores admitidos son [x, y, z].
INVALID_INPUT SupportedRegions no puede estar vacío.

Agregar un compatible Región de AWS

Puedes usar la API de catálogo para agregar nuevos productos compatibles Regiones de AWS para tu AMI-based producto en AWS Marketplace.

nota

Para obtener más información sobre cómo añadir nuevas regiones compatibles mediante la AWS Marketplace Management Portal, consulte Añadir una región de AWS en la Guía del AWS Marketplace vendedor.

nota

El tipo de AddRegions cambio solo está disponible enAmiProduct@1.0.

Para agregar nuevas regiones compatibles, llame a la operación de la StartChangeSet API con el tipo de AddRegions cambio, como se muestra en el siguiente ejemplo.

Sintaxis de la solicitud

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" } } ] }

Proporcione información sobre los campos para agregar el tipo de AddRegions cambio.

  • Entity(objeto) (obligatorio): su AMI-based producto.

    • Identifier(cadena) (obligatorio): su identificador de producto. Para obtener más información, consulte Identificador.

    • Type(cadena) (obligatorio): Type se basa en el método de entrega (tipo de producto) que utilizará tu producto:AmiProduct@1.0.

  • ejemplo
    DetailsDocument (object) (required) – The details required to execute the ChangeSet.
    • Regions: matriz de cadenas

      Valores admitidos por elementos: cadenas Región de AWS de código válidas.

      Por ejemplo, ["us-east- 1"].

Sintaxis de respuesta

Se crea un conjunto de cambios para su solicitud. La respuesta a esta solicitud le proporciona la dirección ChangeSetId y ChangeSetArn para el conjunto de cambios y tiene el siguiente aspecto.

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

La solicitud de cambio se agrega a una cola y se procesa. Esto incluyó la validación de la información para garantizar que cumple con las AWS Marketplace directrices. El proceso de validación puede tardar desde unos minutos hasta unas horas.

Puedes comprobar el estado de la solicitud a través de la AWS Marketplace Management Portal API de catálogo o directamente a través de la operación de la DescribeChangeSet API.

  • Si el estado de ejecución del conjunto de cambios esSUCCEEDED: Se genera una nueva entidad Identifier (oEntityId). Puedes usar la operación de la DescribeEntity API en la entidad del producto para comprobar el resultado.

  • Si el estado de ejecución del conjunto de cambios esCLIENT_ERROR: La DescribeChangeSet respuesta proporciona los detalles del error, así como las acciones correspondientes que se deben tomar para corregir el error.

Errores asincrónicos

Los siguientes errores son específicos de AddRegions 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.

Código de error Mensaje de error
INVALID_REGIONS Las regiones solicitadas [a, b, c] no son válidas o no están disponibles. Solo los valores admitidos son [x, y, z].
INVALID_INPUT Las regiones no pueden estar vacías.

Restringir un Región de AWS

Puedes usar la API de catálogo para restringir la compatibilidad anterior con Regiones de AWS tu AMI-based producto en AWS Marketplace.

nota

Para obtener más información sobre cómo restringir las regiones que anteriormente admitían el uso de AWS Marketplace Management Portal, consulte Restringir una región de AWS en la Guía del AWS Marketplace vendedor.

nota

El tipo de RestrictRegions cambio solo está disponible enAmiProduct@1.0.

Para restringir las regiones admitidas anteriormente, llama a la operación de la StartChangeSet API con el tipo de RestrictRegions cambio, como se muestra en el siguiente ejemplo.

Sintaxis de la solicitud

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" } } ] }

Proporcione información sobre los campos para agregar el tipo de AddRegions cambio.

  • Entity(objeto) (obligatorio): su AMI-based producto.

    • Identifier(cadena) (obligatorio): su identificador de producto. Para obtener más información, consulte Identificador.

    • Type(cadena) (obligatorio): Type se basa en el método de entrega (tipo de producto) que utilizará tu producto:AmiProduct@1.0.

  • DetailsDocument(objeto) (obligatorio): los detalles necesarios para ejecutar el ChangeSet.

    • Regions— Matriz de cadenas

      Valores compatibles con los elementos: cadenas de Región de AWS código válidas, como"us-east-1".

Sintaxis de respuesta

Se crea un conjunto de cambios para su solicitud. La respuesta a esta solicitud le proporciona la dirección ChangeSetId y ChangeSetArn para el conjunto de cambios y tiene el siguiente aspecto.

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

La solicitud de cambio se agrega a una cola y se procesa. Esto incluyó la validación de la información para garantizar que cumple con las AWS Marketplace directrices. El proceso de validación puede tardar desde unos minutos hasta unas horas.

Puedes comprobar el estado de la solicitud a través de la AWS Marketplace Management Portal API de catálogo o directamente a través de la operación de la DescribeChangeSet API.

  • Si el estado de ejecución del conjunto de cambios esSUCCEEDED: se genera Identifier (oEntityId) una nueva entidad (o). Puedes usarlo DescribeEntity en la entidad del producto para comprobar el resultado. Para obtener más información, consulte DescribeEntity.

  • Si el estado de ejecución del conjunto de cambios esCLIENT_ERROR: La DescribeChangeSet respuesta proporciona los detalles del error, así como las acciones correspondientes que se deben tomar para corregir el error.

Errores asincrónicos

Los siguientes errores son específicos de AddRegions 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 el uso DescribeChangeSet para obtener el estado de una solicitud de cambio, consulteTrabajar con conjuntos de cambios.

Código de error Mensaje de error
INVALID_REGIONS Las regiones solicitadas [a, b, c] no son válidas o no están disponibles. Solo los valores admitidos son [x, y, z].
INVALID_INPUT Las regiones no pueden estar vacías.

Agregar un nuevo tipo de instancia

Puedes usar la API de catálogo para agregar nuevos tipos de instancias para tu AMI-based producto en AWS Marketplace.

nota

Para obtener más información sobre cómo añadir tipos de instancias mediante la AWS Marketplace Management Portal, consulta Añadir una instancia en la Guía del AWS Marketplace vendedor.

AddInstanceTypesañadirá nuevos tipos de instancias a los productos existentes y a los productos recién creados al crear un producto. El tipo de cambio actualizará todas las versiones del documento del producto con un nuevo tipo de instancia.

nota

El tipo de AddInstanceTypes cambio solo está disponible enAmiProduct@1.0.

Al agregar un tipo de instancia restringido, el tipo de instancia se puede eliminar de la lista restringida y agregar a la lista de tipos de instancias disponibles. De este modo, los vendedores tienen más control para cambiar la restricción de sus productos. La lista de tipos de instancias es intercambiable y no representa un estado restringido permanente para un producto.

En el caso de los productos con medición interna, los vendedores deben establecer distintos tipos de cambio AddDimensions y UpdatePricingTerms actualizar los precios del tipo de instancia.

Para añadir nuevos tipos de instancia, llama a la operación de StartChangeSet API con el tipo de RestrictRegions cambio, como se muestra en el siguiente ejemplo.

Sintaxis de la solicitud

A continuación, solo se muestra el tipo de AddInstanceTypes cambio. Aunque los vendedores de AMI con contador interno están obligados a llamar AddInstanceTypes y UpdatePricingTerms cambiar el tipo de su AMI.

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" ] } } ] }

Proporcione información sobre los campos para agregar el tipo de AddInstanceTypes cambio:

  • Entity(objeto) (obligatorio): su AMI-based producto.

    • Identifier(cadena) (obligatorio): su identificador de producto. Para obtener más información, consulte Identificador.

    • Type(cadena) (obligatorio): Type se basa en el método de entrega (tipo de producto) que utilizará tu producto:AmiProduct@1.0.

  • DetailsDocument(objeto) (obligatorio): los detalles necesarios para ejecutar elChangeSet, en este casoInstanceTypes.

    • InstanceTypes(matriz de cadenas) (obligatorio): lista de cadenas InstanceTypes para agregar al producto. Estas instancias se añadirán a las existentesInstanceTypes.

Sintaxis de respuesta

Se crea un conjunto de cambios para su solicitud. La respuesta a esta solicitud le proporciona la dirección ChangeSetId y ChangeSetArn para el conjunto de cambios y tiene el siguiente aspecto.

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

La solicitud de cambio se agrega a una cola y se procesa. Esto incluyó la validación de la información para garantizar que cumple con las AWS Marketplace directrices. El proceso de validación puede tardar desde unos minutos hasta unas horas.

Puedes comprobar el estado de la solicitud a través de la AWS Marketplace Management Portal API de catálogo o directamente a través de la operación de la DescribeChangeSet API.

Validaciones sincrónicas

Las siguientes validaciones de esquema son específicas de las acciones del. AddInstanceTypes AWS Marketplace Catalog API Estas validaciones se realizan al llamar. StartChangeSet Si la solicitud no cumple los siguientes requisitos, generará un error y recibirá una respuesta HTTP.

Campo de entrada Regla de validación HTTP
InstanceTypes Obligatorio 422
InstanceTypes No debe estar vacía 422
InstanceTypes Las entradas deben tener entre 1 y 24 caracteres. Debe coincidir con ^ [A-Za-z0-9_.-] +$ 422
InstanceTypes Las entradas deben ser únicas 422
InstanceTypes No debe tener más de 1500 entradas 422
Una propiedad desconocida No se permiten propiedades adicionales 422

Errores asincrónicos

Los siguientes errores son específicos de AddInstanceTypes 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.

Código de error Mensaje de error
INVALID_INSTANCE_TYPES Los siguientes tipos de instancia no son válidos: [x]
INVALID_INSTANCE_VIRTUALIZATION La virtualización del producto es [x]. No es compatible con los siguientes tipos de instancias: [x]
INVALID_AMI_ARCHITECTURE La arquitectura de CPU del producto es '%s'». + «No es compatible con los siguientes tipos de instancias: [x]
SISTEMA_OPERATIVO_INCOMPATIBLE Los tipos de instancia son incompatibles con el sistema operativo definido en el producto. Proporcione tipos de instancia que sean compatibles con el sistema operativo definido en el producto.
TIPO_DE_PRODUCTO NO VÁLIDO Utilice un único producto AMI existente.
CONFIGURACIÓN_ENA_INVÁLIDA El producto no es compatible con ENA. Los siguientes tipos de instancias requieren soporte para ENA: [x]
INVALID_DIMENSIONS No se han encontrado dimensiones medidas internamente para los tipos de instancia: [x]
DIMENSIONES_FALTANTES No se han encontrado dimensiones para el producto. AddDimensions es obligatorio antes AddInstanceTypes.
ACTUALIZACIÓN_PRECIO_OBLIGATORIO UpdatePricingTerms El tipo de cambio es obligatorio cuando las dimensiones medidas internamente están disponibles en el producto.

Restringir un tipo de instancia

Puedes usar la API de catálogo para limitar o restringir los tipos de instancias disponibles para tu AMI-based producto en AWS Marketplace.

nota

Para obtener más información sobre cómo limitar o restringir los tipos de instancias disponibles mediante la AWS Marketplace Management Portal, consulta Restringir una instancia en la Guía del AWS Marketplace vendedor.

Los suscriptores actuales no se verán afectados por este cambio y podrán usar los tipos de instancias restringidos. Sin embargo, ningún comprador nuevo podrá usar tipos de instancias restringidas. Para detener las suscripciones a los tipos de instancias actuales (una vez que se restrinjan los tipos de instancias), debes ponerte en contacto con el equipo de operaciones del AWS Marketplace vendedor.

RestrictInstanctTypesrestringe los tipos de instancia a todas las versiones del documento del producto. En el tipo de AddInstanceTypes cambio, se actualizan todas las versiones del producto. No podrás restringir los tipos de instancias recomendados. El tipo de instancia recomendado está en el nivel de versión, por lo que es posible que el vendedor no pueda restringir varios tipos de instancias.

En el caso de un producto con medición interna, debes llamar a distintos tipos de cambio al realizar la llamadaRestrictDimensions. Esto evita que se creen nuevas ofertas para los tipos de instancias restringidos.

nota

El tipo de RestrictInstanceTypes cambio solo está disponible enAmiProduct@1.0.

Para limitar o restringir los tipos de instancia disponibles para tu AMI-based producto, llama a la operación de la StartChangeSet API con el tipo de RestrictInstanceTypes cambio, como se muestra en el siguiente ejemplo.

Sintaxis de la solicitud

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" ] } } ] }

Proporciona información sobre los campos para añadir el tipo de RestrictInstanceTypes cambio.

  • Entity(objeto) (obligatorio): su AMI-based producto.

    • Identifier(cadena) (obligatorio): su identificador de producto. Para obtener más información, consulte Identificador.

    • Type(cadena) (obligatorio): Type se basa en el método de entrega (tipo de producto) que utilizará tu producto:AmiProduct@1.0.

  • DetailsDocument(objeto) (obligatorio): los detalles necesarios para ejecutar elChangeSet, en este casoInstanceTypes.

    • InstanceTypes(matriz de cadenas) (obligatorio): lista de cadenas InstanceTypes que se deben restringir al producto. Estas instancias se agregan a la instancia restringida actual (o si no hay ningún tipo de instancia existente, se agregará)InstanceTypes.

Sintaxis de respuesta

Se crea un conjunto de cambios para su solicitud. La respuesta a esta solicitud le proporciona la dirección ChangeSetId y ChangeSetArn para el conjunto de cambios y tiene el siguiente aspecto.

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

La solicitud de cambio se agrega a una cola y se procesa. Esto incluyó la validación de la información para garantizar que cumple con las AWS Marketplace directrices. El proceso de validación puede tardar desde unos minutos hasta unas horas.

Puedes comprobar el estado de la solicitud a través de la AWS Marketplace Management Portal API de catálogo o directamente a través de la operación de la DescribeChangeSet API.

Validaciones sincrónicas

Las siguientes validaciones de esquema son específicas de las acciones del. RestrictInstanceTypes AWS Marketplace Catalog API Estas validaciones se realizan al llamar. StartChangeSet Si la solicitud no cumple los siguientes requisitos, generará un error y recibirá una respuesta HTTP.

Campo de entrada Regla de validación HTTP
InstanceTypes Obligatorio 422
InstanceTypes No debe estar vacía 422
InstanceTypes Las entradas deben tener entre 1 y 24 caracteres. Debe coincidir con ^ [A-Za-z0-9_.-] +$ 422
InstanceTypes Las entradas deben ser únicas 422
InstanceTypes No debe tener más de 1500 entradas 422
Una propiedad desconocida No se permiten propiedades adicionales 422

Errores asincrónicos

Los siguientes errores son específicos de RestrictInstanceTypes 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.

Código de error Mensaje de error
TIPO_DE_INSTANCIA INVÁLIDOS Los siguientes tipos de instancia no son válidos: [x]
TIPO_ DE PRODUCTO NO VÁLIDO Utilice un único producto AMI existente.
TIPO_DE_INSTANCIA DUPLICADA Proporcione tipos de instancias sin duplicados.
TIPO_DE_INSTANCIA NO DISPONIBLE Proporcione un tipo de instancia disponible.
TIPO_DE_INSTANCIA_RESTRINGIDO RECOMENDADO No se pueden restringir los siguientes tipos de instancias. El tipo de instancia recomendado debe cambiarse por uno diferente antes de restringirlo. ID de opciones de entrega [X] Tipo de instancia [X]
DIMENSIONS_NOT_RESTICTED Restrinja las dimensiones antes de restringir los tipos de instancia medidos internamente: [x]
REGION_NO_INSTANCES Sus tipos de instancias restringidos podrían provocar errores en el lanzamiento del producto en la región: X. Considere la posibilidad de restringir menos instancias.
RESTRICCIÓN_INCOMPATIBLE Sus tipos de instancia restringidos harían que el producto no tuviera ningún tipo de instancia basado en FPGA para las AFIs. El producto debe admitir al menos un tipo de instancia basado en FPGA.