Agregar una nueva versión Actualizar la visibilidad de un complemento de Amazon EKS Crea repositorios y recursos Actualizar la información de la versión Restringir una versión

Trabaje con productos basados en contenedores utilizando el AWS Marketplace API

Puede utilizar la API de AWS Marketplace catálogo para automatizar las tareas de trabajo con productos basados en contenedores.

Para obtener información sobre cómo crear un producto basado en contenedores mediante la API de catálogo, consulte. Cree un producto

En los siguientes temas se describe cómo utilizar la API de catálogo para realizar acciones en los productos basados en contenedores:

Temas

Agregar una nueva versión
Actualizar la visibilidad de un complemento de Amazon EKS
Crea repositorios y recursos
Actualizar la información de la versión
Restringir una versión

Agregar una nueva versión

Si ya tienes un producto basado en un contenedor AWS Marketplace, puedes usarlo AWS Marketplace Catalog API para añadir una nueva versión. Esto requiere que ya hayas creado repositorios AWS Marketplace para cada imagen o artefacto del contenedor que forme parte de tu producto y que puedas copiarlos desde tu local y tus archivos. Docker Helm

nota

Para obtener más información sobre cómo crear un producto basado en contenedores con el AWS Marketplace Management Portal, consulta Cómo empezar con los productos en contenedores en la Guía del vendedor.AWS Marketplace

Para obtener más información sobre cómo añadir una nueva versión, incluida la creación de repositorios y la creación Docker de Helm archivos en esos repositorios, mediante el uso de la AWS Marketplace Management Portal, consulta Añadir una nueva versión de tu producto en la Guía del vendedor.AWS Marketplace

Si aún no has creado nuevos repositorios, puedes crearlos mediante la API del catálogo, consulta. Crea repositorios y recursos

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

nota

Una versión de un producto basado en un contenedor se compone de una o más opciones de entrega. Por ejemplo, puede tener dos opciones de entrega, una que funcione con una base de datos NoSQL y otra que funcione con MySQL, para que los usuarios puedan elegir cómo quieren trabajar con su producto. Puede crear la versión del producto y añadir varias opciones de entrega en una sola solicitud conAddDeliveryOptions.

Sintaxis de la solicitud de entrega de imágenes de contenedores


POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "AddDeliveryOptions",
      "Entity":
      {
        "Identifier": "example1-abcd-1234-5ef6-7890abcdef12",
        "Type": "ContainerProduct@1.0"
      },
      "DetailsDocument":
      {
        "Version":
        {
          "VersionTitle": "1.1",
          "ReleaseNotes": "Minor bug fix"
        },
        "DeliveryOptions":
        [
          {
            "DeliveryOptionTitle": "EKS Container image only delivery option",
            "Details":
            {
              "EcrDeliveryOptionDetails":
              {
                "ContainerImages":
                [
                  "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1"
                ],
                "DeploymentResources":
                [
                  {
                    "Name": "HelmDeploymentTemplate",
                    "Url": "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1"
                  }
                ],
                "CompatibleServices":
                [
                  "EKS"
                ],
                "Description": "Sample Description",
                "UsageInstructions": "helm pull 111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1"
              }
            }
          }      
        ]
      }
    }
  ]
}

Sintaxis de solicitud de entrega AgentCore de Amazon Bedrock Runtime


POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "AddDeliveryOptions",
      "Entity":
      {
        "Identifier": "example1-abcd-1234-5ef6-7890abcdef12",
        "Type": "ContainerProduct@1.0"
      },
      "DetailsDocument":
      {
        "Version":
        {
          "VersionTitle": "1.1",
          "ReleaseNotes": "Minor bug fix"
        },
        "DeliveryOptions":
        [
          {
            "DeliveryOptionTitle": "Amazon Bedrock AgentCore Runtime Delivery Option",
            "Details":
            {
              "EcrDeliveryOptionDetails":
              {
                "ContainerImages":
                [
                  "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1"
                ],
                "CompatibleServices":
                [
                  "Bedrock-AgentCore"
                ],
                "AgenticType":
                [
                  "AGENT" 
                ], 
                "Description": "Sample Description",
                "UsageInstructions": "To launch and invoke this agent on Amazon Bedrock AgentCore Runtime",
                "EnvironmentVariables":
                [
                  {
                    "Name": "HTTP_PORT",
                    "Description": "Port of the server",
                    "DefaultValue": "8080"
                  },
                  {
                    "Name": "API_KEY",
                    "Description": "Provide your unique API key here."
                  }
                ]
              }
            }
          }      
        ]
      }
    }
  ]
}

HelmSintaxis de la solicitud de entrega de gráficos


POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "AddDeliveryOptions",
      "Entity":
      {
        "Identifier": "example1-abcd-1234-5ef6-7890abcdef12",
        "Type": "ContainerProduct@1.0"
      },
      "DetailsDocument":
      {
        "Version":
        {
          "VersionTitle": "1.1",
          "ReleaseNotes": "Minor bug fix"
        },
        "DeliveryOptions":
        [
          {
            "DeliveryOptionTitle": "HelmChartDeliveryOption",
            "Details":
            {
              "HelmDeliveryOptionDetails":
              {
                "CompatibleServices":
                [
                  "EKS",
                  "EKS-Anywhere"
                ],
                "ContainerImages":
                [
                  "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1"
                ],
                "HelmChartUri": "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:helmchart1.1",
                "Description": "Helm chart description",
                "UsageInstructions": "Usage instructions",
                "MarketplaceServiceAccountName": "Service account name",
                "ReleaseName": "Optional release name",
                "Namespace": "Optional Kubernetes namespace",
                "OverrideParameters":
                [
                  {
                    "Key": "HelmKeyName1",
                    "DefaultValue": "${AWSMP_LICENSE_SECRET}"
                  },
                  {
                    "Key": "HelmKeyName2",
                    "DefaultValue": "${AWSMP_SERVICE_ACCOUNT}"
                  }
                ]
              }
            }
          }
        ]
      }
    }
  ]
}

Sintaxis de la solicitud Add-On de entrega de Amazon EKS


POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "AddDeliveryOptions",
      "Entity": {
        "Type": "ContainerProduct@1.0",
        "Identifier": "$CreateProductChange.Entity.Identifier"
      },
      "DetailsDocument": {
        "Version": {
          "VersionTitle": "1.1",
          "ReleaseNotes": "New Add-on Release"
        },
        "DeliveryOptions": [
          {
            "DeliveryOptionTitle": "AWS Marketplace Test AddOn from CAPI 1",
            "Visibility": "Limited",
            "Details": {
              "EksAddOnDeliveryOptionDetails": {
                "ContainerImages": [
                  "111122223333.dkr.ecr.us-east-1.amazonaws.com/test-seller/canary-test-repo-product-6:mongo"
                ],
                "HelmChartUri": "111122223333.dkr.ecr.us-east-1.amazonaws.com/rocket/rocket-product-helm:1.0",
                "Description": "Description for delivery option provided by ISV",
                "UsageInstructions": "Usage instructions with launch instructions",
                "AddOnName": "aws-mp-test",
                "AddOnVersion": "1.2.1",
                "AddOnType": "networking",
                "CompatibleKubernetesVersions": [
                  "1.25",
                  "1.26"
                ],
                "SupportedArchitectures": [
                  "amd64",
                  "arm64"
                ],
                "Namespace": "my-test-namespace",
                "EnvironmentOverrideParameters": [
                  {
                    "Key": "cluster-name",
                    "Value": "${AWS_EKS_CLUSTER_NAME}"
                  },
                  {
                    "Key": "region-name",
                    "Value": "${AWS_REGION}"
                  }
                ]
              }
            }
          }
        ]
      },
      "ChangeName": "PublishAddonNew"
    }
  ]
}

Proporcione información sobre los campos para añadir el tipo de AddDeliveryOptions cambio:

Entity(objeto) (obligatorio): su producto basado en un contenedor.
- Identifier(cadena) (obligatorio): tu 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:ContainerProduct@1.0.
DetailsDocument(objeto) (obligatorio): detalles de la solicitud. Incluye toda la información sobre la versión que va a añadir. Este campo es un campo de cadena de caracteres.
- Version(objeto): detalles sobre la versión que vas a añadir al producto.
  - VersionTitle(cadena): el título de la versión que está creando. Normalmente se trata de una descripción de la versión, por ejemplo Version 1.1 o simplemente1.1. Los compradores podrán elegir la versión que quieren implementar de una lista de títulos de versiones.
  - ReleaseNotes(string): las notas detalladas sobre esta versión. Debe tener menos de 30 000 caracteres.
- DeliveryOptions(conjunto de objetos): variedad de opciones de entrega, cada una de las cuales es un método de entrega para la versión del producto. Por ejemplo, si tienes una opción de entrega para Amazon Elastic Container Service (Amazon ECS) y otra para Amazon Elastic Kubernetes Service (Amazon EKS), debes tener dos opciones de entrega.
  - DeliveryOptionTitle(cadena): descripción breve que ayuda al comprador a elegir entre las opciones de envío.
  - Details(objeto): los recursos que se utilizan para esta opción de entrega. Se trata de un campo de detalles dentro del campo de detalles. No es necesario escapar por partida doble de los caracteres de este campo.
    
    AddOnName – Un nombre de complemento único que los compradores verán en el catálogo de Amazon EKS. Este nombre añadirá un prefijo más adelante utilizandoSellerAlias. Por ejemplo, dónde isv-alias_ está el nombre del complemento proporcionado por el ISV.
    
    AddOnType – El tipo de complemento elegido de una lista de valores compatibles de Amazon EKS: Gitops | monitoring | logging | cert-management | policy-management | cost-management | autoscaling | storage | kubernetes-management | service-mesh | etcd-backup | ingress-service-type | load-balancer | local-registry| networking | Security | backup | ingress-controller | observability
    
    AddOnVersion – Una versión semántica para que el comprador pueda elegir la versión específica AddOn que necesita instalar o actualizar.
    
    CompatibleKubernetesVersions— Las versiones de Amazon EKS Kubernetes con las que es compatible este software.
    
    CompatibleServices(conjunto de cadenas): conjunto de servicios con los que la versión es compatible. Opciones válidas: ECSEKS,ECS-Anywhere,EKS-Anywhere, yBedrock-AgentCore.
    
    ContainerImages(matriz de cadenas): matriz de direcciones URL de imágenes de contenedores utilizadas en esta versión. La ruta será el repositorio en el que ha cargado la imagen, con la etiqueta de la imagen utilizada en esta versión. La lista debe incluir todas las imágenes necesarias, incluso las que no hayan cambiado con respecto a las versiones anteriores. Consulta la siguiente sección para obtener información sobre la creación de repositorios mediante la API de catálogo.
    
    Description(string): una descripción más larga de la opción de entrega para proporcionar detalles al comprador. También puedes incluir un enlace a más instrucciones que se proporcionan en otro lugar.
    
    EcrDeliveryOptionDetails— AgenticType — El tipo de agente de ejecución. Opciones válidas:AGENT,MCP_SERVER, oA2A_SERVER.
    
    EcrDeliveryOptionDetails— EnvironmentVariables — Lista de variables de entorno que requiere el contenedor AgentCore Runtime y que los compradores rellenarán previamente cuando se desplieguen. Para cada variable, proporciona un objeto con el nombre esperado por tu contenedor, una descripción y un DefaultValue opcional. Para variables como las credenciales o las claves de API que son únicas, no proporciones un valor predeterminado. Puede usar la descripción para especificar detalles sobre la variable, así como los posibles valores. Todas las variables proporcionadas con sus valores predeterminados se rellenarán automáticamente cuando los compradores lancen tu producto.
    
    EcrDeliveryOptionDetails –DeploymentResources (array of objects)— Una serie de otros recursos necesarios para la versión, como Helm gráficos. Cada recurso incluye una Name para describirlo y otra URL que apunta al recurso.
    
    EnvironmentOverrideParameters –Lista de parámetros del sistema que utilizará el complemento. Algunos de los ISV proporcionados AddOn (HelmChart) pueden requerir configuraciones con información derivada del estado del entorno de ejecución de Amazon EKS (/información del sistema). Por ejemplo, EksClusterRegionEKSClusterName, y otros. Puedes evitar que el comprador tome medidas adicionales sustituyendo estos valores de forma dinámica en el AddOn lanzamiento de Amazon EKS. El sistema Amazon EKS ya admite la sustitución automática de complementos por parámetros del sistema. AWS Marketplace La experiencia de ISV puede ampliarse para recopilar estos parámetros que requerirían ser sustituidos.
    
    La información genérica del sistema que se va a sustituir puede indicarse proporcionando una constante AWS Marketplace específica siguiendo una convención similar a Helm la sustitución. Los valores admitidos son ${AWS_REGION} y ${AWS_EKS_CLUSTER_NAME}.
    
    "EnvironmentOverrideParameters" : [ { "Key" : "my-field.region" "Value" : "${AWS_REGION}" }, { "Key" : "my-second-field" "Value" : "${AWS_EKS_CLUSTER_NAME}" },
    
    HelmDeliveryOptionDetails— HelmChartUri (string) — La URL del Helm gráfico alojado en Amazon ECR que el comprador instalará para lanzar el software.
    
    HelmDeliveryOptionDetails –MarketplaceServiceAccountName (string)— Opcional: el nombre de la cuenta de servicio de Kubernetes. La cuenta de servicio se utilizará para conectarse a AWS Identity and Access Management (IAM) y obtener permisos de llamada. Servicios de AWS
    
    HelmDeliveryOptionDetails –ReleaseName (string)— Opcional: nombre de la Helm versión que se proporciona al helm install comando que los compradores utilizan para lanzar el software. Si no se incluye, Helm te proporcionará un nombre de versión generado automáticamente.
    
    HelmDeliveryOptionDetails –Namespace (string)— Opcional: el espacio de Kubernetes nombres donde se instalará el Helm gráfico.
    
    HelmDeliveryOptionDetails –OverrideParameters (array of objects)— Parámetros que se utilizarán en los Helm comandos que inicien la aplicación. Los compradores pueden anular los valores predeterminados.
    
    nota
    En el caso de los productos Amazon EKS Anywhere, proporcione al menos un parámetro de anulación para el secreto de licencia. ProporcioneDefaultValue. "${AWSMP_LICENSE_SECRET}"
    En el caso de los productos de pago, proporciona al menos un parámetro de anulación para la configuración de la cuenta de servicio. Suministro DefaultValue de. "${AWSMP_SERVICE_ACCOUNT}"
    
    Key(cadena): la clave del parámetro en notación de puntos (override.example.key).
    
    DefaultValue(cadena): el valor predeterminado de este parámetro de anulación.
    
    Namespace – El ISV proporcionó el espacio de nombres para la instalación del complemento.
    
    SupportedArchitectures – La lista de arquitecturas compatibles, como amd64 y arm64.
    
    UsageInstructions(string): proporciona instrucciones sobre el uso de esta opción de entrega. Puede tener hasta 4000 caracteres.

Sintaxis de respuesta

Se crea un conjunto de cambios para su solicitud. La respuesta a esta solicitud proporciona la información ChangeSetId necesaria 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 añade a una cola y se procesa, lo que incluye el escaneo del contenedor, las imágenes y otra información para garantizar que cumple con AWS Marketplace las directrices aplicables a los productos en contenedores. Este proceso puede tardar de unos minutos a horas, según la cantidad y el tamaño de los contenedores.

Puedes comprobar el estado de la solicitud a través de la AWS Marketplace Management Portal API del 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 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.

Código de error	Mensaje de error
ESTADO DEL PRODUCTO INCOMPATIBLE	Usa un producto público o limitado existente.
SERVICIOS_INCOMPATIBLES	La lista de servicios contiene servicios incompatibles. [incompatible_services] Proporcione una lista válida de servicios compatibles.
NO SE ESPECIFICÓ NINGÚN SERVICIO_	Proporcione al menos un servicio compatible.
SERVICIOS DUPLICADOS_COMPATIBLES_AWS	La lista de servicios contiene entradas duplicadas. Elimínelos. Cada entrada debe ser única.
TITULO_DE_VERSIÓN_INVALIDO	Elimine los espacios antes del símbolo de la marca comercial.
TITULO_DE_VERSIÓN_INVALIDO	Elimine los siguientes caracteres no admitidos: [x, y, z]
TÍTULO_DE_VERSIÓN NO VÁLIDO	Elimine los espacios del principio del título de la versión.
TITLE_DE_VERSIÓN_INVÁLIDO	Proporcione el título de la versión con menos de [x] caracteres.
TITULO_DE_VERSIÓN_DUPLICADO	El título de la versión [duplicate_version_title] es un duplicado. Elimine o cambie el título.
INVALID_RELEASE_NOTES	Elimine los espacios antes del símbolo de la marca comercial.
INVALID_RELEASE_NOTES	Eliminar caracteres no admitidos: [x, y, z]
NOTAS DE PUBLICACIÓN NO VÁLIDAS	Elimine los espacios del principio de las notas de la versión.
NOTAS DE PUBLICACIÓN NO VÁLIDAS	Proporcione las 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 NO VÁLIDAS	Eliminar caracteres no admitidos: [x, y, z]
INSTRUCCIONES_DE_USO INVÁLIDAS	Proporcione instrucciones de uso con menos de (x) caracteres.
INSTRUCCIONES_DE_USO INVÁLIDAS	Proporcione instrucciones de uso.
MISSING_CONTAINER_IMAGES	Proporcione al menos una imagen de contenedor.
NO_LICENSE_SECRET_KEYS	En el caso de los productos Amazon EKS Anywhere, proporcione 1 parámetro de anulación para el secreto de licencia. Necesidades `DefaultValue` de`"${AWSMP_LICENSE_SECRET}"`, consulte el ejemplo en la sección.
DEMASIADOS CONTENEDORES_IMÁGENES	Proporcione menos de 50 imágenes de contenedores.
DUPLICATE_CONTAINER_IMAGES	La lista de imágenes del contenedor contiene imágenes duplicadas: [duplicate_images]. Proporcione una lista con imágenes únicas.
INVALID_CONTAINER_IMAGES	Proporcione un URI válido para la imagen del contenedor.
INVALID_CONTAINER_IMAGE_URI	La imagen [invalid_image_uri] no tiene acceso a este producto. Sube la imagen al repositorio de productos correspondiente. Para obtener información sobre la carga, consulta Cómo empezar a usar productos en contenedores.
INVALID_CONTAINER_IMAGE_TAG	Evita usar la etiqueta «más reciente».
DUPLICATE_DELIVERY_OPTION_TITLES	Títulos de opciones de entrega duplicados: [duplicate_titles]. Elimina los duplicados
TITLOS_OPCION_DE_ENTREGA NO VÁLIDOS	Los títulos de las opciones de entrega [existing_titles] ya existen. Proporcione un título diferente.
INVALID_FULFILLMENT_OPTION_TITLE	Indique el título de la opción de envío con menos de (x) caracteres.
NO_SERVICE_ACCOUNT_CONFIGURATION	En el caso de los productos de pago, proporciona un parámetro de anulación para la configuración de la cuenta de servicio. Necesidades `DefaultValue` de`"${AWSMP_SERVICE_ACCOUNT}"`, consulte el ejemplo en la sección.
DETALLES_INVÁLIDOS	Los detalles proporcionados no son válidos.
NOMBRE_DE_RECURSO VACÍO	Proporcione el nombre del recurso.
EMPTY_RESOURCE_URL	Proporcione la URL del recurso.
NOMBRE_DE_RECURSO NO VÁLIDO	Proporcione el nombre del recurso con menos de 256 caracteres.
URL DEL RECURSO NO VÁLIDO	Proporcione la URL del recurso con menos de 256 caracteres.
DESCRIPCIÓN_CORTA NO VÁLIDA	Proporcione una descripción breve de menos de 1000 caracteres.
DESCRIPCIÓN_CORTA NO VÁLIDA	Proporcione una descripción breve.
SCAN_ERROR	Corrige la vulnerabilidad de seguridad «" [y] "» en la imagen «" [x] "».
IMAGE_NOT_FOUND	El URI de la imagen pública [invalid_image_uri] no es válido. Proporcione una URL válida.
INVÁLID_ARN	Proporcione un ARN válido para el acceso a la imagen.
IMAGE_INACCESSIBLE	Proporcione un ARN válido para el acceso a la imagen.
DUPLICATE_ADDON_NAME	El AddOn nombre que has proporcionado ya está siendo utilizado en otro producto. Introduce un nombre diferente.
DUPLICATE_ADDON_VERSION	El título de la versión del complemento [duplicate_version_title] ya está en uso. Proporcione un título diferente.
TIPO_COMPLEMENTO NO VÁLIDO	Los tipos de complementos [invalid_types] no son válidos. Proporcione un tipo de la lista compatible: [eks_addon_do_supported_types].
VERSIÓN DE KUBERNETES_INVÁLIDA	Las versiones de Kubernetes [invalid_versions] no son válidas. Proporcione las versiones de la lista compatible: [eks_addon_do_supported_kubernetes_versions].
VERSIONES DUPLICADAS DE KUBERNETES_VERSION	Versiones de Kubernetes duplicadas: [duplicate_versions]. Proporcione una lista con versiones únicas.
ARQUITECTURA_INVÁLIDA	Las arquitecturas [invalid_architectures] no son válidas. Proporcione arquitecturas de las arquitecturas compatibles con Amazon EKS: [eks_addon_do_supported_architectures].
ARQUITECTURAS_COMPATIBLES DUPLICADAS	Arquitecturas duplicadas: [duplicate_architectures]. Proporcione una lista de arquitecturas únicas compatibles.
ESTADO_DE VISIBILIDAD_INVALIDO	Los estados [invalid_states] no son válidos para la opción de envío {EKS_DO}. Proporcione un estado de visibilidad válido a partir de los siguientes valores permitidos: Limitado.
INVALID_ENVIRONMENT_OVERRIDE_PARAMETER_VALUE	Los valores de los parámetros de anulación [invalid_values] no son válidos. Proporcione un valor válido de la siguiente lista: [eks_addon_do_environment_override_parameter_values].
DUPLICATE_ENVIRONMENT_OVERRIDE_PARAMETER_KEY	Los parámetros de anulación del entorno contienen claves duplicadas: [duplicate_keys]. Elimínelos.
TOO_MANY_EKS_ADDON_DELIVERY_OPTIONS	Proporcione solo una opción de entrega complementaria de Amazon EKS para la versión.
INCOMPATIBLE_ADDON_NAME	El nombre del complemento [provided_name] no coincide con el nombre existente. Reutilice el nombre existente de la versión pública o de las versiones anteriores de este complemento. Solo puedes usar un nombre de complemento para cada producto.
INCOMPATIBLE_ADDON_TYPE	El tipo de complemento [provided_type] no coincide con el tipo existente. Reutiliza el tipo existente de la versión pública o de las versiones anteriores de este complemento. Solo puedes usar un tipo de complemento para cada producto.
INCOMPATIBLE_ADDON_NAMESPACE	El espacio de nombres del complemento [provided_namespace] no coincide con el espacio de nombres existente. Reutiliza el espacio de nombres existente de la versión pública, o de versiones anteriores, de este complemento. Solo puedes usar un espacio de nombres adicional para cada producto.
INVALID_HELM_CHART_URI	El URI del gráfico de Helm [invalid_uri] no es válido. Proporcione un URI en el SemVer formato 2.
INCOMPATIBLE_HELM_OBJECTS (HELM_OBJECTS INVÁLIDO)	<unsupported-objects>Proporcione un gráfico sin utilizar los Helm siguientes objetos no compatibles:. Helm
INVALID_DEPENDENT_HELM_CHARTS	<invalid-subcharts>Proporcione un gráfico de Helm que contenga los siguientes gráficos dependientes directamente en el directorio de gráficos principal y no de origen externo:.
INVALID_HELM_SENSITIVE_CONFIG	Proporcione un esquema de configuración avanzado sin información confidencial ni secretos. Palabras clave: <sensitive-parameters-identified>
IMAGEN_HELM_UNDECLARED_INVÁLIDAS	<list-of-images>Proporcione las siguientes imágenes de Helm Chart dentro de la opción de entrega de la solicitud:.
IMAGEN_HELM_CHART_INVÁLIDAS	Proporcione un gráfico de Helm que contenga imágenes de los repositorios creados mediante el tipo de cambio. AddRepositories <images-identified>Imágenes externas:.
INVALID_HELM_LINT	Proporcione un diagrama de Helm que supere correctamente la lint de Helm.
PLANTILLA DE HELM_INVÁLIDA	Proporcione un diagrama de Helm que supere correctamente la plantilla de Helm.
INVALID_HELM_CHART	Proporciona un diagrama de Helm que se ajuste a las instrucciones indicadas en la lista con viñetas de Helm Charts de la AWS Marketplace Guía del vendedor.AWS Marketplace
NOMBRE_COMPLEMENTO NO VÁLIDO	Proporcione un AddOn nombre que siga el siguiente patrón de expresiones regulares: xx
ESPACIO DE NOMBRES ADDON_INVALID_ADDON_	Los valores del espacio de nombres [invalid_namespaces] no son válidos. El espacio de nombres debe seguir la expresión regular {EKS_ADD_ON_NAMESPACE_REGEX}. Por ejemplo, namespace, namespace-test.
NOMBRE_COMPLEMENTO NO VÁLIDO	Proporcione un nombre de complemento que comience con una letra o un dígito y, a continuación, una combinación de letras, dígitos y guiones. Por ejemplo, test-addon, eksaddon
INVALID_ADDON_VERSION_PATTERN	<major>Proporcione una versión complementaria con el siguiente patrón: ". <minor>. <patch>"(por ejemplo, 1.2.3, 0.1.2, 0.1.1)
ID_DE_OPCIÓN_DE_ENTREGA VACÍA	Proporcione una lista de los identificadores de las opciones de entrega.
ENTRADA DE OPCIONES DE ENTREGA NO VÁLIDA	La lista contiene una o más opciones de envío no válidas. Proporcione una lista válida y asegúrese de que cada opción tenga un único método de entrega.
OVERRIDE_PARAMETER_KEYS_CONTAINS_SPECIAL_CHARS	Las claves de parámetros de anulación [invalid_keys] contienen caracteres no válidos. Las claves solo deben usar letras, números, comillas dobles («») y signos más (+).
INVALID_CONTAINER_IMAGE_REPOSITORY	Los repositorios [invalid_repositories] no son válidos. Proporcione los repositorios creados mediante el tipo de cambio. AddRepositories
INVALID_CONTAINER_IMAGE_TAG_FORMAT	La etiqueta de imagen del contenedor [invalid_image_tag] no es válida. Proporcione una etiqueta que se ajuste a la expresión regular {CONTAINER_IMAGE_TAG_REGEX}.
DUPLICATE_OVERRIDE_PARAMETER_KEYS	Los parámetros de anulación contienen claves duplicadas [duplicate_keys]. Elimine los duplicados.
UNSUPPORTED_CONTAINER_IMAGE_URI	La imagen del contenedor [unsupported_image] no es compatible. Proporcione una imagen que siga el esquema 1 del Manifiesto de imágenes V 2.
NOMBRES_DE_REPOSITORY_DUPLICADOS	Nombres de repositorios duplicados: [duplicate_repo_names]. Proporcione nombres únicos.
ESPACIO DE NOMBRES NO VÁLIDO	Los valores del espacio de nombres [invalid_namespaces] no son válidos. Proporcione valores que se ajusten a la expresión regular {HELM_RELEASE_PARAM_REGEX}.
NOMBRE_DE_LANZAMIENTO INVÁLIDO	Los valores de releaseName [invalid_release_names] no son válidos. Proporcione valores que se ajusten a la expresión regular {HELM_RELEASE_PARAM_REGEX}.
OVERRIDE_PARAMETER_KEYS_CONTAINS_RESERVED_PARAMETER_KEYS	La clave del parámetro de anulación para los títulos de las opciones de entrega [invalid_keys] está reservada. Claves reservadas: [reserved_param_keys]. Proporcione una clave diferente.

Actualizar la visibilidad de un complemento de Amazon EKS

Puede utilizar la API de catálogo para actualizar la visibilidad de una opción de entrega complementaria de Amazon EKS de la versión de su producto en AWS Marketplace. El contenedor y las opciones de Helm entrega de su producto en contenedor se crean automáticamente con el estado de visibilidad «Público».

nota

La posibilidad de actualizar la visibilidad de la versión del producto solo está disponible para la opción de entrega complementaria Amazon EKS de las versiones de la lista. Si su producto aún no es «público», envíe una solicitud para publicar el producto con el estado de visibilidad «Público» utilizando el AWS Marketplace Management Portal.

De forma predeterminada, cuando creas una versión con la opción de entrega del complemento Amazon EKS, se publica en estado «Limitado». El estado «Limitado» significa que el producto no está disponible públicamente en todas las regiones para que sus compradores lo usen e implementen en un clúster de Amazon EKS. Puedes cambiar la visibilidad de la opción de entrega de «Limitada» a «Pública» llamando a la operación de la StartChangeSet API con el tipo de UpdateDeliveryOptionsVisibility cambio. DeliveryOptions IdEspecifica la versión de tu producto que corresponda a la opción de entrega complementaria de Amazon EKS.

Sintaxis de la solicitud



{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateDeliveryOptionsVisibility",
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "ContainerProduct@1.0"
      },
      "DetailsDocument":
      {
        "DeliveryOptions":
        [
          {
            "Id": "do-1234567891234567891234",
            "TargetVisibility": "Public"
          }
        ]
      }
    }
  ]
}

Para añadir el tipo de UpdateDeliveryOptionsVisibility cambio, proporciona información para los siguientes campos:

Entity(objeto) (obligatorio): su producto basado en un contenedor.
- Identifier(cadena) (obligatorio): tu 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 utilice tu producto:ContainerProduct@1.0.
DetailsDocument(objeto) (obligatorio): detalles de la solicitud, incluida la información sobre los repositorios que deseas crear. Todos los campos siguientes son obligatorios.
- DeliveryOptions(lista de objetos): lista de DeliveryOption objetos, incluidos los detalles de cada uno:
  - Id(cadena): identificador único paraDeliveryOption. (Para obtener el identificador único deDeliveryOption, ejecuta la DescribeEntity acción en el producto que estás actualizando.
  - TargetVisibility— La nueva visibilidad prevista del producto.

Sintaxis de respuesta

Se crea un conjunto de cambios para su solicitud. La respuesta a esta solicitud proporciona los datos ChangeSetId y ChangeSetArn para el conjunto de cambios.



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

La solicitud de cambio se añade a una lista y se procesa, lo que incluye el escaneo de las imágenes del contenedor y otra información para garantizar que cumple con AWS Marketplace las directrices aplicables a los productos en contenedores. Este proceso puede tardar de unos minutos a horas, según la cantidad y el tamaño de los contenedores.

Puedes comprobar el estado de la solicitud mediante la AWS Marketplace Management Portal operación DescribeChangeSet API o AWS Marketplace Catalog API mediante ella.

Errores asíncronos

En la siguiente tabla se muestran los errores que son específicos de AddDeliveryOptions las acciones de. AWS Marketplace Catalog API Estos errores se devuelven al llamar 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.

Código de error	Mensaje de error
EMPTY_DELIVERY_OPTION_IDS	Proporcione una lista de los identificadores de las opciones de entrega.
ESTADO_DE VISIBILIDAD_INVALIDO	La `TargetVisibility` opción que has proporcionado no es compatible. Inténtalo de nuevo con una opción permitida. Las opciones permitidas son: `Public`
ID_DE_OPCIÓN_DE_ENTREGA INVÁLIDOS	Has proporcionado detalles de la opción de envío no válidos. Proporciona los identificadores de las opciones de envío que se encuentran en el producto. No se encontraron los identificadores: [x]
DUPLICATE_DELIVERY_OPTION_IDS	Identificadores de opciones de envío duplicados: [duplicate_ids]. Proporciona identificadores de opciones de entrega únicos.
ERROR DE AUDITORÍA	No ha realizado las pruebas de un proveedor de software independiente (ISV) para todas las versiones de clústeres de Amazon EKS compatibles con sus versiones complementarias de Amazon EKS. Debe completar las pruebas antes de que podamos lanzar las opciones de entrega.
TIPO_DE_OPCIÓN_DE_ENTREGA NO VÁLIDO	El tipo de opción de envío que has proporcionado no es válido. Asegúrese de que su opción de envío es del tipo: `EksAddOn` e inténtelo de nuevo.
INCOMPATIBLE_HELM_OBJECTS	Proporcione un Helm gráfico sin objetos no compatibles: Helm los objetos no compatibles son los siguientes: todos Helm los objetos Release (excepto .Name y .Namespace), los ganchos y las funciones de búsqueda. Helm
INCOMPATIBLE_ADDON_NAME	El nombre del complemento [provided_name] no coincide con el nombre de la versión pública. Actualiza el nombre público antes de publicarlo.
INCOMPATIBLE_ADDON_TYPE	Los tipos de complementos no coinciden. Reutilice el tipo de complemento existente de la versión pública del complemento o de las versiones anteriores del complemento de este producto. Solo se admite un complemento para cada producto.
INCOMPATIBLE_ADDON_NAMESPACE	El espacio de nombres del complemento proporcionado [provided_namespace] no coincide con el espacio de nombres de la versión pública. Actualiza el espacio de nombres del complemento antes de publicarlo.

Crea repositorios y recursos

Para crear una nueva versión de un producto basado en contenedores, debe tener los recursos de la versión disponibles en los repositorios. AWS Marketplace Cree los repositorios y, a continuación, introduzca (cargue) los recursos Docker (yHelm) en los repositorios. Para obtener información sobre cómo crear los repositorios a través de AWS Marketplace Management Portal, consulta Añadir una nueva versión de tu producto en la AWS Marketplace Guía del vendedor.

Para crear nuevos repositorios, llama StartChangeSet con el tipo de AddRepositories 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": "AddRepositories",
      "Entity":
      {
        "Identifier": "example1-abcd-1234-5ef6-7890abcdef12",
        "Type": "ContainerProduct@1.0"
      },
      "DetailsDocument":
      {
        "Repositories":
        [
          {
            "RepositoryName": "new-repo-1",
            "RepositoryType": "ECR"
          },
          {
            "RepositoryName": "new-repo-2",
            "RepositoryType": "ECR"
          }
        ]
      }
    }
  ]
}

Proporcione información sobre los campos para añadir el tipo de AddRepositories cambio:

Para obtener más información sobre la creación de repositorios, consulta Añadir una nueva versión en la Guía del AWS Marketplace vendedor.

Entity(objeto) (obligatorio): tu producto basado en un contenedor.
- Identificador (cadena) (obligatorio): tu 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:ContainerProduct@1.0.
DetailsDocument(objeto) (obligatorio): detalles de la solicitud. Incluye la información sobre los repositorios que desea crear. Todos los campos incluidos son obligatorios.
- Repositories(conjunto de estructuras): lista de objetos del repositorio. Cada objeto de repositorio incluye un nombre y un tipo.
  - RepositoryName(cadena): el nombre del repositorio que se va a crear.
  - RepositoryType(cadena): el tipo de repositorio que se va a crear. El único valor permitido es ECR.

nota

Puedes tener hasta 70 repositorios por producto, aunque puedes añadir varios recursos y versiones de los recursos a un único repositorio asignándoles diferentes etiquetas al insertarlos.

Después de crear uno o más repositorios, añada sus recursos a los repositorios. Para obtener información sobre cómo enviar recursos a los repositorios, consulte Cómo enviar una imagen en la Guía del usuario de Amazon Elastic Container Registry. Para obtener información sobre los comandos push específicos necesarios para uno de tus repositorios, consulta Cómo añadir una nueva versión en la Guía del AWS Marketplace vendedor.

Errores asíncronos

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

Código de error	Mensaje de error
NOMBRE_DE_REPOSITORIO ECR_INVÁLIDO	Proporcione el nombre del repositorio en el formato: 'nginx-web-app'
DUPLICATE_ECR_REPOSITORY_NAME	El repositorio [duplicate_repo_names] ya existe. Elija un nombre diferente.
MISSING_REPOSITORY_INFORMATION	Proporcione al menos un nombre de repositorio.
NOMBRE_ECR_REPOSITORY_INVALID_ECR_REPOSITORY_NAME	Se ha alcanzado la longitud máxima de 256 caracteres. El número de caracteres incluye el espacio de nombres del vendedor.

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 basado en contenedores. AWS Marketplace

nota

Cuando un producto está disponible públicamente, no puedes actualizar el título de la versión, las imágenes del contenedor, el título de la opción de entrega ni los recursos de despliegue de la versión. Si necesitas actualizar estos aspectos de un producto, crea una versión nueva en su lugar.

Para actualizar una versión existente de su producto basado en contenedores, llame a la operación de StartChangeSet API con el tipo de UpdateDeliveryOptions cambio, como se muestra en el siguiente ejemplo. Esto actualiza la información detallada de las opciones de entrega que especifiques, así como la versión asociada. Debe incluir al menos una opción de entrega.

Sintaxis de la solicitud de entrega de imágenes de contenedores


POST /StartChangeSet HTTP/1.1 
Content-type: application/json

{
   "Catalog":"AWSMarketplace",
   "ChangeSet":[
      {
         "ChangeType":"UpdateDeliveryOptions",
         "Entity":{
            "Identifier":"example1-abcd-1234-5ef6-7890abcdef12",
            "Type":"ContainerProduct@1.0"
         },
         "DetailsDocument":{
            "Version":{
               "ReleaseNotes":"New release notes",
               "VersionTitle":"Version 1.2"
            },
            "DeliveryOptions":[
               {
                  "Id":"example4-2222-cccc-2222-cccccccccccc",
                  "Details":{
                     "EcrDeliveryOptionDetails":{
                        "DeliveryOptionTitle":"New Delivery Option Title",
                        "Description":"New description",
                        "UsageInstructions":"New usage instructions",
                        "CompatibleServices":[
                           "EKS"
                        ]
                     }
                  }
               }
            ]
         }
      }
   ]
}

HelmSintaxis de la solicitud de entrega de gráficos


POST /StartChangeSet HTTP/1.1 
Content-type: application/json

{
   "Catalog":"AWSMarketplace",
   "ChangeSet":[
      {
         "ChangeType":"UpdateDeliveryOptions",
         "Entity":{
            "Identifier":"example1-abcd-1234-5ef6-7890abcdef12",
            "Type":"ContainerProduct@1.0"
         },
         "DetailsDocument":{
            "Version":{
               "ReleaseNotes":"New release notes",
               "VersionTitle":"Version 1.2"
            },
            "DeliveryOptions":[
               {
                  "Id":"example5-2222-cccc-2222-cccccccccccc",
                  "Details":{
                     "HelmDeliveryOptionDetails":{
                        "DeliveryOptionTitle":"New Delivery Option Title",
                        "ContainerImages":[
                           "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/imagename:1.0"
                        ],
                        "HelmChartUri":"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/helmname:1.0",
                        "CompatibleServices":[
                           "EKS-Anywhere"
                        ],
                        "Description":"New description",
                        "UsageInstructions":"New usage instructions",
                        "MarketplaceServiceAccountName":"new-service-account-name",
                        "ReleaseName":"new-release-name",
                        "Namespace":"new-cluster-namespace",
                        "OverrideParameters":[
                           {
                              "Key":"new.parameter.key",
                              "DefaultValue":"New parameter default value"
                           }
                        ]
                     }
                  }
               }
            ]
         }
      }
   ]
}

Sintaxis de la solicitud Add-On de entrega de Amazon EKS


POST /StartChangeSet HTTP/1.1 
Content-type: application/json

{
   "Catalog":"AWSMarketplace",
   "ChangeSet":[
      {
         "ChangeType":"UpdateDeliveryOptions",
         "Entity":{
            "Identifier":"example1-abcd-1234-5ef6-7890abcdef12",
            "Type":"ContainerProduct@1.0"
         },
         "DetailsDocument":{
            "Version":{
               "ReleaseNotes":"New release notes",
               "VersionTitle":"Version 1.2"
            },
            "DeliveryOptions":[
               {
                  "Id":"example4-2222-cccc-2222-cccccccccccc",
                  "Details":{
                     "EksAddOnDeliveryOptionDetails":{
                        "ContainerImages":[
                           "709825985650.dkr.ecr.us-east-1.amazonaws.com/test-seller/canary-test-repo-product-6:mongo"
                        ],
                        "Description":"Description for delivery option provided by ISV",
                        "UsageInstructions":"Usage instructions with launch instructions",
                        "HelmChartUri":"709825985650.dkr.ecr.us-east-1.amazonaws.com/rocket/rocket-product-helm:1.0",
                        "AddOnName":"aws-mp-test",
                        "AddOnVersion":"1.2.1",
                        "AddOnType":"networking",
                        "CompatibleKubernetesVersions":[
                           "1.19",
                           "1.20"
                        ],
                        "SupportedArchitectures":[
                           "amd64",
                           "arm64"
                        ],
                        "Namespace":"my-test-namespace",
                        "EnvironmentOverrideParameters":[
                           {
                              "Key":"my-field",
                              "Value":"${AWS_EKS_CLUSTER_NAME}"
                           }
                        ]
                     }
                  }
               }
            ]
         }
      }
   ]
}

Proporcione información sobre los campos para añadir el tipo de UpdateDeliveryOptions cambio:

Para obtener más información sobre estos campos, consulta Añadir una nueva versión en la Guía del AWS Marketplace vendedor.

Entity(objeto) (obligatorio): tu producto basado en un contenedor.
- Identifier(cadena) (obligatorio): tu 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:ContainerProduct@1.0.
DetailsDocument(objeto) (obligatorio): detalles de la solicitud. Incluye cualquier información sobre la versión de su producto basado en contenedores que desee actualizar. Todos los campos incluidos son opcionales, pero debe incluir al menos un campo para actualizarlos.
- Version(objeto): detalles sobre la versión del software.
  - VersionTitle(cadena): el título de la versión que está creando. Normalmente se trata de una descripción de la versión, por ejemplo Version 1.1 o simplemente1.1. Los compradores podrán elegir la versión que quieren implementar de una lista de todos los títulos de las versiones.
    
    Esta propiedad no se puede actualizar si el producto ya está publicado públicamente.
  - ReleaseNotes(string): notas para que los compradores les informen de los cambios de una versión a la siguiente.
- DeliveryOptions(lista de objetos): lista de DeliveryOption objetos, incluidos los detalles de cada uno:
  - Id(cadena): identificador único del DeliveryOption (puedes obtener el identificador único del DeliveryOption producto que vas a actualizar realizando la DescribeEntity acción correspondiente).
  - Details(objeto): contiene los detalles de una opción de entrega. Tenga en cuenta que este objeto de detalles anidado no necesita tener un doble escape.
    
    EcrDeliveryOptionDetails(objeto): los detalles de la opción de entrega de la imagen del contenedor.
    
    DeliveryOptionTitle(cadena): descripción breve que permite al comprador elegir entre las opciones de envío.
    
    Esta propiedad no se puede actualizar si el producto ya está publicado públicamente.
    
    ContainerImages(matriz de cadenas): matriz de direcciones URL de imágenes de contenedores utilizadas en esta versión. La ruta será el repositorio en el que ha cargado la imagen, con la etiqueta de la imagen utilizada en esta versión. Si se incluye este campo, la lista debe incluir todas las imágenes necesarias, incluso las que no cambien.
    
    Esta propiedad no se puede actualizar si el producto ya está publicado públicamente.
    
    DeploymentResources(conjunto de objetos): conjunto de otros recursos de implementación necesarios para la versión, como enlaces a Helm gráficos u otra documentación. Cada recurso incluye un nombre para describirlo y una URL que apunta al recurso. En la página de inicio de su versión, se muestra como una lista de enlaces.
    
    Esta propiedad no se puede actualizar si el producto ya está publicado públicamente.
    
    Name(cadena): el texto del hipervínculo que se muestra al comprador.
    
    Url(cadena): la URL del hipervínculo que se muestra al comprador.
    
    CompatibleServices(conjunto de cadenas): conjunto de servicios con los que la versión es compatible. Opciones válidas: ECSEKS,ECS-Anywhere,EKS-Anywhere, yBedrock-AgentCore.
    
    AgenticTypeEl tipo de agente de ejecución. Opciones válidas:AGENT,MCP_SERVER, oA2A_SERVER.
    
    Description(cadena): una descripción más larga de la opción de envío para proporcionar detalles al comprador. También puedes incluir un enlace a más instrucciones alojadas en otro lugar.
    
    UsageInstructions(cadena): proporciona instrucciones sobre cómo implementar y usar el producto. También puede añadir un enlace a las instrucciones de uso alojadas en otro lugar. Puede tener hasta 4000 caracteres.
    
    EnvironmentVariables— Lista de variables de entorno que requiere el contenedor AgentCore Runtime y que los compradores rellenarán previamente cuando se desplieguen. Para cada variable, proporciona un objeto con el nombre esperado por tu contenedor, una descripción y un DefaultValue opcional. Para variables como las credenciales o las claves de API que son únicas, no proporciones un valor predeterminado. Puede usar la descripción para especificar detalles sobre la variable, así como los posibles valores. Todas las variables proporcionadas con sus valores predeterminados se rellenarán automáticamente cuando los compradores lancen tu producto.
  - Id(cadena): identificador único del producto DeliveryOption (puedes obtener el DeliveryOption identificador único del DescribeEntity producto que estás actualizando).
  - Details(objeto): contiene los detalles de una opción de entrega. Tenga en cuenta que este objeto de detalles anidado no necesita tener un doble escape.
    
    HelmDeliveryOptionDetails(objeto): los detalles de la opción de envío del Helm gráfico.
    
    DeliveryOptionTitle(cadena): descripción breve que permite al comprador elegir entre las opciones de envío.
    
    Esta propiedad no se puede actualizar si el producto ya está publicado públicamente.
    
    ContainerImages(matriz de cadenas): matriz de direcciones URL de imágenes de contenedores utilizadas en esta versión. La ruta será el repositorio en el que ha cargado la imagen, con la etiqueta de la imagen utilizada en esta versión. La lista debe incluir todas las imágenes necesarias, incluso las que no hayan cambiado con respecto a las versiones anteriores. Consulta la siguiente sección para obtener información sobre la creación de repositorios mediante la API de catálogo.
    
    HelmChartUri(string): la URL del Helm gráfico alojado en Amazon ECR que el comprador instalará para lanzar el software.
    
    CompatibleServices(conjunto de cadenas): conjunto de servicios con los que la versión es compatible. Las opciones válidas son ECS y EKS.
    
    Description(string): una descripción más larga de la opción de entrega para dar detalles al comprador. También puedes incluir un enlace a más instrucciones que se proporcionan en otro lugar.
    
    UsageInstructions(string): proporciona instrucciones sobre el uso de esta opción de envío. Puede tener hasta 4000 caracteres.
    
    MarketplaceServiceAccountName(cadena): el nombre de la cuenta de Kubernetes servicio. La cuenta de servicio se utilizará para conectarse y AWS Identity and Access Management obtener permisos para llamar a AWS los servicios.
    
    ReleaseName(cadena): nombre de la Helm versión que se proporciona al helm install comando que los compradores utilizan para lanzar el software.
    
    Namespace(cadena): el espacio de Kubernetes nombres en el que se instalará el Helm gráfico.
    
    OverrideParameters(matriz de objetos): parámetros que se utilizarán en los Helm comandos que inicien la aplicación. Los compradores pueden anular los valores predeterminados.
    
    Key(cadena): la clave del parámetro en notación de puntos (override.example.key).
    
    DefaultValue(cadena): el valor predeterminado de este parámetro de anulación.

Sintaxis de respuesta


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

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

Errores asíncronos

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

Código de error	Mensaje de error
ESTADO DEL PRODUCTO INCOMPATIBLE	Usa un producto público o limitado existente.
SERVICIOS_INCOMPATIBLES	La lista de servicios contiene servicios incompatibles. [incompatible_services] Proporcione una lista válida de servicios compatibles.
NO SE ESPECIFICÓ NINGÚN SERVICIO_	Proporcione al menos un servicio compatible.
DUPLICATE_COMPATIBLE_AWS_SERVICES	La lista de servicios contiene entradas duplicadas. Elimínelos. Cada entrada debe ser única.
TITULO_DE_VERSIÓN_INVALIDO	Elimine los espacios antes del símbolo de la marca comercial.
TITULO_DE_VERSIÓN_INVALIDO	Elimine los siguientes caracteres no admitidos: [x, y, z]
TÍTULO_DE_VERSIÓN NO VÁLIDO	Elimine los espacios del principio del título de la versión.
TITLE_DE_VERSIÓN_INVÁLIDO	Proporcione el título de la versión con menos de [x] caracteres.
TITULO_DE_VERSIÓN_DUPLICADO	El título de la versión [duplicate_version_title] es un duplicado. Elimine o cambie el título.
INVALID_RELEASE_NOTES	Elimine los espacios antes del símbolo de la marca comercial.
INVALID_RELEASE_NOTES	Eliminar caracteres no admitidos: [x, y, z]
NOTAS DE PUBLICACIÓN NO VÁLIDAS	Elimine los espacios del principio de las notas de la versión.
NOTAS DE PUBLICACIÓN NO VÁLIDAS	Proporcione las 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 NO VÁLIDAS	Eliminar caracteres no admitidos: [x, y, z]
INSTRUCCIONES_DE_USO INVÁLIDAS	Proporcione instrucciones de uso con menos de (x) caracteres.
INSTRUCCIONES_DE_USO INVÁLIDAS	Proporcione instrucciones de uso.
MISSING_CONTAINER_IMAGES	Proporcione al menos una imagen de contenedor.
TOO_MANY_CONTAINER_IMAGES	Proporcione menos de 50 imágenes de contenedores.
DUPLICATE_CONTAINER_IMAGES	La lista de imágenes del contenedor contiene imágenes duplicadas: [duplicate_images]. Proporcione una lista con imágenes únicas.
INVALID_CONTAINER_IMAGES	Proporcione un URI válido para la imagen del contenedor.
INVALID_CONTAINER_IMAGE_URI	La imagen [invalid_image_uri] no tiene acceso a este producto. Sube la imagen al repositorio de productos correspondiente. Para obtener información sobre la carga, consulta Cómo empezar a usar productos en contenedores.
INVALID_CONTAINER_IMAGE_TAG	Evita usar la etiqueta «más reciente».
MISSING_DELIVERY_OPTION_IDS	Proporcione la opción de entrega de la lista de identificadores existente.
EMPTY_DELIVERY_OPTION_IDS	Proporcione una lista de identificadores de opciones de entrega que no esté vacía.
DUPLICATE_DELIVERY_OPTION_IDS	Identificadores de opciones de envío duplicados: [duplicate_ids]. Proporciona identificadores de opciones de entrega únicos.
DUPLICATE_DELIVERY_OPTION_TITLES	Títulos de opciones de entrega duplicados: [duplicate_titles]. Elimina los duplicados
TITLOS_OPCION_DE_ENTREGA NO VÁLIDOS	Los títulos de las opciones de entrega [existing_titles] ya existen. Proporcione un título diferente.
INVALID_FULFILLMENT_OPTION_TITLE	Indique el título de la opción de envío con menos de (x) caracteres.
NOMBRE_DE_RECURSO VACÍO	Proporcione el nombre del recurso.
EMPTY_RESOURCE_URL	Proporcione la URL del recurso.
NOMBRE_DE_RECURSO NO VÁLIDO	Proporcione el nombre del recurso con menos de 256 caracteres.
URL DEL RECURSO NO VÁLIDO	Proporcione la URL del recurso con menos de 256 caracteres.
DESCRIPCIÓN_CORTA NO VÁLIDA	Proporcione una descripción breve de menos de 1000 caracteres.
DESCRIPCIÓN_CORTA NO VÁLIDA	Proporcione una descripción breve.
NO_LICENSE_SECRET_KEYS	En el caso de los productos Amazon EKS Anywhere, proporcione 1 parámetro de anulación para el secreto de licencia. Necesidades `DefaultValue` de`"${AWSMP_LICENSE_SECRET}"`, consulte el ejemplo en la sección.
NO_SERVICE_ACCOUNT_CONFIGURATION	En el caso de los productos de pago, proporciona un parámetro de anulación para la configuración de la cuenta de servicio. Necesidades `DefaultValue` de`"${AWSMP_SERVICE_ACCOUNT}"`, consulte el ejemplo en la sección.
SCAN_ERROR	Corrige la vulnerabilidad de seguridad «" [y] "» en la imagen «" [x] "».
FIELD_NOT_ALLOWED_TO_CHANGE	El campo [x] no se puede cambiar.
OPCIONES_DE_ENTREGA INVÁLIDAS	Los identificadores de las opciones de envío [invalid_ids] no son válidos. Proporcione las opciones de entrega en estado limitado o público.
NO SE ENCONTRÓ NINGÚN CAMBIO	Proporcione al menos 1 cambio.
MULTIPLE_VERSION_UPDATE	Proporcione los ID de las opciones de entrega de la misma versión.
OVERRIDE_PARAMETER_KEYS_CONTAINS_SPECIAL_CHARS	Las claves de parámetros de anulación [invalid_keys] contienen caracteres no válidos. Las claves solo deben usar letras, números, comillas dobles («») y signos más (+).
INVALID_CONTAINER_IMAGE_REPOSITORY	Los repositorios [invalid_repositories] no son válidos. Proporcione los repositorios creados mediante el tipo de cambio. AddRepositories
INVALID_CONTAINER_IMAGE_TAG_FORMAT	La etiqueta de imagen del contenedor [invalid_image_tag] no es válida. Proporcione una etiqueta que se ajuste a la expresión regular {CONTAINER_IMAGE_TAG_REGEX}.
DUPLICATE_OVERRIDE_PARAMETER_KEYS	Los parámetros de anulación contienen claves duplicadas [duplicate_keys]. Elimine los duplicados.
UNSUPPORTED_CONTAINER_IMAGE_URI	La imagen del contenedor [unsupported_image] no es compatible. Proporcione una imagen que siga el esquema 1 del Manifiesto de imágenes V 2.
ESPACIO DE NOMBRES NO VÁLIDO	Los valores del espacio de nombres [invalid_namespaces] no son válidos. Proporcione valores que se ajusten a la expresión regular {HELM_RELEASE_PARAM_REGEX}.
NOMBRE_DE_LANZAMIENTO INVÁLIDO	Los valores de releaseName [invalid_release_names] no son válidos. Proporcione valores que se ajusten a la expresión regular {HELM_RELEASE_PARAM_REGEX}.
OVERRIDE_PARAMETER_KEYS_CONTAINS_RESERVED_PARAMETER_KEYS	La clave del parámetro de anulación para los títulos de las opciones de entrega [invalid_keys] está reservada. Claves reservadas: [reserved_param_keys]. Proporcione una clave diferente.
INCOMPATIBLE_ADDON_NAME	El nombre del complemento [provided_name] no coincide con el nombre existente. Reutilice el nombre existente de la versión pública o de las versiones anteriores de este complemento. Solo puedes usar un nombre de complemento para cada producto.
INCOMPATIBLE_ADDON_NAMESPACE	El espacio de nombres del complemento [provided_namespace] no coincide con el espacio de nombres existente. Reutiliza el espacio de nombres existente de la versión pública, o de versiones anteriores, de este complemento. Solo puedes usar un espacio de nombres adicional para cada producto.

Restringir una versión

Puedes usar la API de catálogo para restringir una versión de tu producto basado en contenedores. AWS Marketplace Esto impide que los nuevos compradores puedan utilizar esa versión. Debe haber al menos una versión disponible públicamente en un producto. No puedes restringir la única versión disponible públicamente restante de un producto.

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

nota

Si restringes una o varias opciones de envío de una versión, no todas, dejarás de estar disponibles para tus compradores. Si se restringen todas las opciones de envío de una versión, se eliminará esa versión del AWS Marketplace catálogo.

Actualmente, la API de catálogo no admite la restricción de un complemento de Amazon EKS.

Las versiones restringidas siguen estando disponibles para los clientes actuales.

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",
        "Type": "ContainerProduct@1.0"
      },
      "DetailsDocument":
      {
        "DeliveryOptionIds":
        [
          "example1-2222-cccc-2222-cccccccccccc"
        ]
      }
    }
  ]
}

Proporcione información sobre los campos para añadir el tipo de RestrictDeliveryOptions cambio:

Entity(objeto) (obligatorio): su producto basado en un contenedor.
- Identifier(cadena) (obligatorio): tu 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:ContainerProduct@1.0.
DetailsDocument(objeto) (obligatorio): detalles de la solicitud. Incluye los identificadores de las opciones de entrega de tu producto basado en contenedores que te gustaría restringir.
- DeliveryOptionIds(conjunto de cadenas): lista de DeliveryOption identificadores de las versiones que quieres restringir. Para obtener el identificador único del DeliveryOption producto que vas a restringir, puedes realizar la DescribeEntity acción correspondiente.

Sintaxis de respuesta


{
  "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. Este proceso puede tardar de unos minutos a horas.

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

Errores asíncronos

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

Código de error	Mensaje de error
ESTADO DEL PRODUCTO INCOMPATIBLE	Usa un producto público.
MISSING_DELIVERY_OPTION_IDS	Proporcione la opción de entrega de la lista de identificadores existente.
OPCIONES_DE_ENTREGA INVÁLIDAS	Los identificadores de las opciones de envío [invalid_ids] no son válidos. Proporcione las opciones de entrega en un estado público.
EMPTY_DELIVERY_OPTION_IDS	Proporcione una lista de identificadores de opciones de entrega que no esté vacía.
INVALID_MINIMUM_PUBLIC_DELIVERY_OPTIONS	No se pueden restringir todos los ID de las opciones de entrega.
DUPLICATE_DELIVERY_OPTION_IDS	Identificadores de opciones de envío duplicados: [duplicate_ids]. Proporciona identificadores de opciones de entrega únicos.

Aviso JavaScript está desactivado o no está disponible en su navegador.

Para utilizar la documentación de AWS, debe estar habilitado JavaScript. Para obtener más información, consulte las páginas de ayuda de su navegador.

Convenciones del documento

Trabaje con los productos componentes de EC2 Image Builder

Trabaje con productos SaaS