Adicionar uma nova versão Atualize a visibilidade de um complemento do Amazon EKS Crie repositórios e recursos Atualizar as informações da versão Restringir uma versão

Trabalhe com produtos à base de contêineres usando oAWS MarketplaceAPIs

Você pode usar a API de AWS Marketplace catálogo para automatizar tarefas para trabalhar com produtos baseados em contêineres.

Para obter informações sobre como criar um produto baseado em contêiner usando a API de catálogo, consulte. Crie um produto

Os tópicos a seguir descrevem como usar a API de catálogo para realizar ações em seus produtos baseados em contêineres:

Tópicos

Adicionar uma nova versão
Atualize a visibilidade de um complemento do Amazon EKS
Crie repositórios e recursos
Atualizar as informações da versão
Restringir uma versão

Adicionar uma nova versão

Se você já tiver um produto baseado em contêinerAWS Marketplace, poderá usar o AWS Marketplace Catalog API para adicionar uma nova versão. Isso exige que você já tenha criado repositórios AWS Marketplace para cada imagem ou artefato de contêiner que faz parte do seu produto e que possa copiá-los do local Docker e Helm dos arquivos.

nota

Para obter detalhes sobre como criar um produto baseado em contêiner usando oPortal de gerenciamento do AWS Marketplace, consulte Introdução aos produtos em contêiner no Guia do AWS Marketplacevendedor.

Para obter detalhes sobre como adicionar uma nova versão, incluindo a criação de repositórios Docker e a criação de Helm arquivos nesses repositórios, usando oPortal de gerenciamento do AWS Marketplace, consulte Adicionar uma nova versão do seu produto no Guia do AWS Marketplace vendedor.

Se você ainda não criou novos repositórios, pode criá-los usando a API de catálogo, consulteCrie repositórios e recursos.

Para adicionar uma nova versão, chame a operação da StartChangeSet API com o tipo de AddDeliveryOptions alteração, conforme mostrado no exemplo a seguir.

nota

Uma versão de um produto baseado em contêiner é composta por uma ou mais opções de entrega. Por exemplo, você pode ter duas opções de entrega, uma que funciona com um banco de dados NoSQL e outra que funciona com MySQL, para que seus usuários possam escolher como querem trabalhar com seu produto. Você cria a versão do seu produto e adiciona várias opções de entrega em uma única solicitação comAddDeliveryOptions.

Sintaxe da solicitação de entrega de imagem de contêiner


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

Sintaxe da solicitação de entrega do Amazon Bedrock AgentCore 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."
                  }
                ]
              }
            }
          }      
        ]
      }
    }
  ]
}

HelmSintaxe da solicitação 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}"
                  }
                ]
              }
            }
          }
        ]
      }
    }
  ]
}

Sintaxe da solicitação Add-On de entrega do 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"
    }
  ]
}

Forneça informações sobre os campos para adicionar o tipo de AddDeliveryOptions alteração:

Entity(objeto) (obrigatório) — Seu produto baseado em contêiner.
- Identifier(string) (obrigatório) — Seu ID do produto. Para obter mais informações, consulte Identificador.
- Type(string) (obrigatório) — Type É baseado no método de entrega (tipo de produto) que seu produto usará:ContainerProduct@1.0.
DetailsDocument(objeto) (obrigatório) — Detalhes da solicitação. Ele inclui todas as informações sobre a versão que você está adicionando. Esse campo é um campo de string.
- Version(objeto) — Detalhes sobre a versão que você está adicionando ao seu produto.
  - VersionTitle(string) — O título da versão que você está criando. Normalmente, essa é uma descrição da versão, semelhante Version 1.1 ou simplesmente1.1. Seus compradores poderão escolher a versão a ser implantada em uma lista de títulos de versões.
  - ReleaseNotes(string) — As notas detalhadas sobre esta versão. Deve ter menos de 30.000 caracteres.
- DeliveryOptions(matriz de objetos) — Uma variedade de opções de entrega, em que cada uma é um método de entrega para a versão do seu produto. Por exemplo, se você tem uma opção de entrega para o Amazon Elastic Container Service (Amazon ECS) e outra para o Amazon Elastic Kubernetes Service (Amazon EKS), você deve ter duas opções de entrega.
  - DeliveryOptionTitle(string) — Uma breve descrição que ajuda o comprador a escolher entre suas opções de entrega.
  - Details(objeto) — Os recursos usados para essa opção de entrega. Esse é um campo de detalhes dentro do campo de detalhes. Você não precisa escapar duplamente dos caracteres nesse campo.
    
    AddOnName – Um nome de complemento exclusivo que os compradores verão no catálogo do Amazon EKS. Esse nome adicionará um prefixo posteriormente usandoSellerAlias. Por exemplo, onde isv-alias_ está o nome do complemento fornecido pelo ISV.
    
    AddOnType – O tipo de complemento escolhido em uma lista de valores suportados pelo Amazon EKS: Gitops | monitoramento | registro | gerenciamento de certificados | gerenciamento de políticas | gerenciamento de custos | escalonamento automático | armazenamento | kubernetes-management | service-mesh | etcd-backup | ingress-service-type | balanceador de carga | registro local| rede | segurança | backup | controlador de ingresso | observabilidade
    
    AddOnVersion – Uma versão semântica para que o comprador possa escolher uma versão específica AddOn que precisa instalar ou atualizar.
    
    CompatibleKubernetesVersions— As versões do Amazon EKS Kubernetes com as quais este software é compatível.
    
    CompatibleServices(array of strings) — Uma matriz de serviços com os quais a versão é compatível. Opções válidas: ECS EKSECS-Anywhere,EKS-Anywhere,, Bedrock-AgentCore e.
    
    ContainerImages(array of strings) — Uma matriz de URLs de imagem de contêiner usada por esta versão. O caminho será o repositório para o qual você fez o upload da imagem, com a tag da imagem usada por esta versão. A lista deve incluir todas as imagens necessárias, até mesmo imagens que não foram alteradas em relação às versões anteriores. Consulte a próxima seção para obter informações sobre como criar repositórios usando a API de catálogo.
    
    Description(string) — Uma descrição mais longa da opção de entrega para fornecer detalhes ao comprador. Você também pode incluir um link para mais instruções fornecidas em outro lugar.
    
    EcrDeliveryOptionDetails— AgenticType — O tipo de agente de tempo de execução. Opções válidas:AGENT,MCP_SERVER, ouA2A_SERVER.
    
    EcrDeliveryOptionDetails— EnvironmentVariables — Lista de variáveis de ambiente que são exigidas pelo contêiner AgentCore Runtime e que serão pré-preenchidas para os compradores após a implantação. Para cada variável, forneça um objeto com o nome esperado pelo seu contêiner, uma descrição e um DefaultValue opcional. Para variáveis como credenciais ou chaves de API que são exclusivas, não forneça um valor padrão. Você pode usar a descrição para especificar detalhes sobre a variável, bem como valores possíveis. Todas as variáveis fornecidas com seus valores padrão serão pré-preenchidas quando os compradores lançarem seu produto.
    
    EcrDeliveryOptionDetails –DeploymentResources (array of objects)— Uma série de outros recursos necessários para a versão, como Helm gráficos. Cada recurso inclui um Name para descrevê-lo e um URL que aponta para o recurso.
    
    EnvironmentOverrideParameters –Lista de parâmetros do sistema a serem usados pelo complemento. Alguns dos ISVs fornecidos AddOn (HelmChart) podem exigir configurações com informações derivadas do estado do ambiente de execução do Amazon EKS (/informações do sistema). Por exemplo,EksClusterRegion,EKSClusterName, e outros. Você pode evitar ações adicionais do comprador substituindo dinamicamente esses valores no lançamento do Amazon EKS. AddOn O sistema Amazon EKS já suporta substituições automáticas de parâmetros do sistema por complementos. AWS MarketplaceA experiência do ISV pode ser estendida para coletar esses parâmetros que exigiriam substituição.
    
    As informações genéricas do sistema a serem substituídas podem ser indicadas fornecendo uma constante AWS Marketplace especificada seguindo uma convenção semelhante à Helm substituição. Os valores suportados são ${AWS_REGION} e ${AWS_EKS_CLUSTER_NAME}.
    
    "EnvironmentOverrideParameters" : [ { "Key" : "my-field.region" "Value" : "${AWS_REGION}" }, { "Key" : "my-second-field" "Value" : "${AWS_EKS_CLUSTER_NAME}" },
    
    HelmDeliveryOptionDetails— HelmChartUri (string) — O URL do Helm gráfico hospedado no Amazon ECR que o comprador instalará para iniciar o software.
    
    HelmDeliveryOptionDetails –MarketplaceServiceAccountName (string)— Opcional — O nome da conta de serviço do Kubernetes. A conta de serviço será usada para se conectar ao AWS Identity and Access Management (IAM) para obter permissões de chamadaServiços da AWS.
    
    HelmDeliveryOptionDetails –ReleaseName (string)— Opcional — O nome da Helm versão fornecido ao helm install comando que os compradores usam para iniciar o software. Se não estiver incluído, Helm fornecerá um nome de lançamento gerado automaticamente para você.
    
    HelmDeliveryOptionDetails –Namespace (string)— Opcional — O Kubernetes namespace em que o Helm gráfico será instalado.
    
    HelmDeliveryOptionDetails –OverrideParameters (array of objects)— Parâmetros que serão usados nos Helm comandos que iniciam o aplicativo. Os compradores podem substituir os valores padrão.
    
    nota
    Para produtos Amazon EKS Anywhere, forneça pelo menos 1 parâmetro de substituição para o segredo da licença. Forneça DefaultValue de"${AWSMP_LICENSE_SECRET}".
    Para produtos pagos, forneça pelo menos 1 parâmetro de substituição para a configuração da conta de serviço. Forneça DefaultValue de"${AWSMP_SERVICE_ACCOUNT}".
    
    Key(string) — A chave para o parâmetro em notação de ponto (override.example.key).
    
    DefaultValue(string) — O valor padrão desse parâmetro de substituição.
    
    Namespace – O ISV forneceu namespace para a instalação do complemento.
    
    SupportedArchitectures – A lista de arquiteturas suportadas, como amd64 e arm64.
    
    UsageInstructions(string) — Forneça instruções sobre o uso dessa opção de entrega. Pode ter até 4.000 caracteres.

Sintaxe de resposta

Um conjunto de alterações é criado para sua solicitação. A resposta a essa solicitação fornece a ChangeSetId e ChangeSetArn para o conjunto de alterações e tem a seguinte aparência.


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

A solicitação de alteração é adicionada a uma fila e processada, incluindo a digitalização das imagens do contêiner e outras informações para garantir que atenda às AWS Marketplacediretrizes para produtos em contêiner. Esse processo pode levar de alguns minutos a horas, dependendo do número e do tamanho dos contêineres.

Você pode verificar o status da solicitação por meio daPortal de gerenciamento do AWS Marketplace, ou diretamente por meio da API de catálogo, usando a operação da DescribeChangeSet API.

Para obter mais informações sobre conjuntos de alterações, consulte Trabalhando com conjuntos de alterações. Para obter mais informações sobre erros nos conjuntos de alterações de produtos do vendedor, consulteAlterar o status e os erros do conjunto.

Erros assíncronos

Os erros a seguir são específicos AddDeliveryOptions das ações noAWS Marketplace Catalog API. Esses erros são retornados quando você liga DescribeChangeSet após o processamento de um conjunto de alterações. Para obter mais informações sobre como usar DescribeChangeSet para obter o status de uma solicitação de alteração, consulteTrabalhando com conjuntos de alterações.

Código de erro	Mensagem de erro
STATUS DE PRODUTO_INCOMPATÍVEL	Use um produto público ou limitado existente.
SERVIÇOS_INCOMPATÍVEIS	A lista de serviços contém serviços incompatíveis. [incompatible_services] Forneça uma lista válida de serviços compatíveis.
NENHUM SERVIÇO_ESPECIFICADO	Forneça pelo menos 1 serviço compatível.
_SERVIÇOS _COMPATÍVEIS_ DUPLICADOS AWS	A lista de serviços contém entradas duplicadas. Remova-os. Cada entrada deve ser exclusiva.
TÍTULO_DE_VERSÃO INVÁLIDA	Remova os espaços antes do símbolo da marca registrada.
TÍTULO_DE_VERSÃO INVÁLIDA	Remova os seguintes caracteres não suportados: [x, y, z]
TÍTULO_DE_VERSÃO INVÁLIDA	Remova os espaços do início do título da versão.
TÍTULO_DE_VERSÃO INVÁLIDA	Forneça o título da versão com menos de [x] caracteres.
TÍTULO DA VERSÃO_DUPLICADO	O título da versão [duplicate_version_title] é duplicado. Remova ou altere o título.
NOTAS_DE_LANÇAMENTO INVÁLIDAS	Remova os espaços antes do símbolo da marca registrada.
NOTAS_DE_LANÇAMENTO INVÁLIDAS	Remova caracteres não suportados: [x, y, z]
NOTAS_DE_LANÇAMENTO INVÁLIDAS	Remova os espaços do início das notas de versão.
NOTAS_DE_LANÇAMENTO INVÁLIDAS	Forneça notas de lançamento com menos de (x) caracteres.
INSTRUÇÕES_DE_USO INVÁLIDAS	Remova os espaços antes do símbolo da marca registrada.
INSTRUÇÕES_DE_USO INVÁLIDAS	Remova caracteres não suportados: [x, y, z]
INSTRUÇÕES_DE_USO INVÁLIDAS	Forneça instruções de uso com menos de (x) caracteres.
INSTRUÇÕES_DE_USO INVÁLIDAS	Forneça instruções de uso.
IMAGENS_CONTÊINERES AUSENTES	Forneça pelo menos 1 imagem de contêiner.
CHAVES SECRETAS SEM LICENÇA	Para produtos Amazon EKS Anywhere, forneça 1 parâmetro de substituição para o segredo da licença. Necessidades `DefaultValue` de`"${AWSMP_LICENSE_SECRET}"`, veja o exemplo na seção.
MUITAS_IMAGENS_CONTENTORES	Forneça menos de 50 imagens de contêiner.
IMAGENS_CONTÊINERES DUPLICADOS	A lista de imagens do contêiner contém imagens duplicadas: [duplicate_images]. Forneça uma lista com imagens exclusivas.
IMAGENS_CONTENTOR_INVÁLIDAS	Forneça um URI válido para a imagem do contêiner.
URI DE IMAGEM_CONTÊINER INVÁLIDO	A imagem [invalid_image_uri] não tem acesso a este produto. Faça o upload da imagem para o repositório de produtos correspondente. Para obter informações sobre o upload, consulte Introdução aos produtos de contêiner.
ETIQUETA_DE_IMAGEM_CONTÊINER INVÁLIDA	Evite usar a tag “mais recente”.
TÍTULO_OPÇÃO_DE_ENTREGA_DUPLICADOS	Títulos de opções de entrega duplicados: [duplicate_titles]. Remova as duplicatas
TÍTULOS_OPÇÕES_DE_ENTREGA INVÁLIDOS	Os títulos da opção de entrega [existing_titles] já existem. Forneça um título diferente.
TÍTULO_OPÇÃO_DE_PREENCHIMENTO INVÁLIDO	Forneça o título da opção de entrega com menos de (x) caracteres.
NENHUMA CONFIGURAÇÃO DE CONTA DE SERVIÇO	Para produtos pagos, forneça 1 parâmetro de substituição para a configuração da conta de serviço. Necessidades `DefaultValue` de`"${AWSMP_SERVICE_ACCOUNT}"`, veja o exemplo na seção.
DETALHES_INVÁLIDOS	Os detalhes fornecidos não são válidos.
NOME_DO_RECURSO_VAZIO	Forneça o nome do recurso.
URL_DE_RECURSO VAZIO	Forneça o URL do recurso.
NOME_DO_RECURSO_INVÁLIDO	Forneça o nome do recurso com menos de 256 caracteres.
URL_DE_RECURSO INVÁLIDO	Forneça o URL do recurso com menos de 256 caracteres.
DESCRIÇÃO_CURTA INVÁLIDA	Forneça uma breve descrição com menos de 1.000 caracteres.
DESCRIÇÃO_CURTA INVÁLIDA	Forneça uma breve descrição.
ERRO_DE_DIGITALIZAÇÃO	Corrija a vulnerabilidade de segurança “" [y] "” na imagem “" [x] "”.
IMAGEM_NÃO_ENCONTRADA	O URI da imagem pública [invalid_image_uri] é inválido. Forneça um URI válido.
ARN_INVÁLIDO	Forneça um ARN válido para acesso à imagem.
IMAGEM_INACESSÍVEL	Forneça um ARN válido para acesso à imagem.
NOME_DO_COMPLEMENTO DUPLICADO	O AddOn nome que você forneceu já está sendo usado por um produto diferente. Forneça um nome diferente.
VERSÃO_ADDON_DUPLICADA	O título da versão complementar [duplicate_version_title] já está em uso. Forneça um título diferente.
TIPO_ADDON_INVÁLIDO	Os tipos de complemento [invalid_types] são inválidos. Forneça um tipo da lista suportada: [eks_addon_do_supported_types].
VERSÃO_KUBERNETES INVÁLIDA	As versões do Kubernetes [invalid_versions] são inválidas. Forneça as versões da lista compatível: [eks_addon_do_supported_kubernetes_versions].
VERSÕES_DUPLICADAS DO KUBERNETES	Versões duplicadas do Kubernetes: [duplicate_versions]. Forneça uma lista com versões exclusivas.
ARQUITETURA_INVÁLIDA	As arquiteturas [invalid_architectures] são inválidas. Forneça arquiteturas das arquiteturas suportadas pelo Amazon EKS: [eks_addon_do_supported_architectures].
ARQUITETURAS DUPLICADAS SUPORTADAS	Arquiteturas duplicadas: [duplicate_architectures]. Forneça uma lista de arquiteturas exclusivas e suportadas.
ESTADO_DE_VISIBILIDADE_INVÁLIDO	Os estados [invalid_states] são inválidos para a opção de entrega {EKS_DO}. Forneça um estado de visibilidade válido a partir dos seguintes valores permitidos: Limitado.
VALOR_DE_PARAMETER_OVERRIDE_INVÁLIDO	Os valores do parâmetro de substituição [invalid_values] são inválidos. Forneça um valor válido na lista a seguir: [eks_addon_do_environment_override_parameter_values].
TECLA_DE_PARAMETER_OVERRIDE_DUPLICATE ENVIRONMENT_OVERRIDE_KEY	Os parâmetros de substituição do ambiente contêm chaves duplicadas: [duplicate_keys]. Remova-os.
MUITAS_EKS_ADDON_DELIVERY_OPTIONS	Forneça somente uma opção de entrega complementar do Amazon EKS para a versão.
NOME_DO_COMPLEMENTO INCOMPATÍVEL	O nome do complemento [provided_name] não corresponde ao nome existente. Reutilize o nome existente da versão pública ou de versões anteriores desse complemento. Você só pode usar um nome de complemento para cada produto.
TIPO_ADDON INCOMPATÍVEL	O tipo de complemento [provided_type] não corresponde ao tipo existente. Reutilize o tipo existente da versão pública ou de versões anteriores desse complemento. Você só pode usar um tipo de complemento para cada produto.
NAMESPACE INCOMPATIBLE_ADDON_	O namespace complementar [provided_namespace] não corresponde ao namespace existente. Reutilize o namespace existente da versão pública ou de versões anteriores desse complemento. Você só pode usar um namespace complementar para cada produto.
INVALID_HELM_CHART_URI	O URI do gráfico Helm [invalid_uri] é inválido. Forneça um URI no formato SemVer 2.
INCOMPATIBLE_HELM_OBJECTS (OBJETOS_HELM_INVÁLIDOS)	<unsupported-objects>Forneça um Helm gráfico sem usar os seguintes Helm objetos não suportados:.
GRÁFICOS_DE_HELM_DEPENDENTES INVÁLIDOS	<invalid-subcharts>Forneça um gráfico do Helm que contenha os seguintes gráficos dependentes diretamente no diretório do gráfico pai e não de origem externa:.
CONFIGURAÇÃO INVÁLIDA DO HELM_SENSITIVE_	Forneça um esquema de configuração avançado sem informações confidenciais ou segredos. Palavras-chave: <sensitive-parameters-identified>
IMAGEM_INVALID_HELM_UNDECLARED_	<list-of-images>Forneça as seguintes imagens do gráfico Helm na opção de entrega da solicitação:.
IMAGENS_HELM_CHART_INVÁLIDAS	Forneça um gráfico do Helm contendo imagens em repositórios criados por meio do tipo de AddRepositories alteração. Imagens externas:<images-identified>.
INVALID_HELM_LINT	Forneça um gráfico do Helm que passe com sucesso pelo Helm lint.
MODELO_DE_CAPACETE INVÁLIDO	Forneça um gráfico do Helm que passe pelo modelo do Helm com sucesso.
GRÁFICO_DE_CAPACETE INVÁLIDO	Forneça um gráfico do Helm que siga as AWS Marketplace orientações identificadas na lista com marcadores do Helm Charts no Guia do vendedor. AWS Marketplace
NOME_DO_COMPLEMENTO INVÁLIDO	Forneça um AddOn nome que siga o seguinte padrão regex: xx
NAMESPACE DE COMPLEMENTO INVÁLIDO	Os valores do namespace [invalid_namespaces] são inválidos. O namespace deve seguir a expressão regular {EKS_ADD_ON_NAMESPACE_REGEX}. Por exemplo, namespace, namespace-test.
PADRÃO_NOME_DO_COMPLEMENTO INVÁLIDO	Forneça um nome de complemento que comece com uma letra ou dígito e, em seguida, uma combinação de letras, dígitos e hífens. Por exemplo, test-addon, eksaddon
PADRÃO_DE_VERSÃO_ADDON INVÁLIDO	<major>Forneça uma versão complementar usando o seguinte padrão: ". <minor>. <patch>"(por exemplo, 1.2.3, 0.1.2, 0.1.1)
IDS_OPÇÕES_DE_ENTREGA VAZIAS	Forneça uma lista de IDs de opções de entrega.
ENTRADA DE OPÇÕES_DE ENTREGA INVÁLIDA	A lista contém uma ou mais opções de entrega inválidas. Forneça uma lista válida e garanta que cada opção tenha um único método de entrega.
OVERRIDE_PARAMETER_KEYS_CONTAINS_SPECIAL_CHARS	As chaves do parâmetro de substituição [invalid_keys] contêm caracteres inválidos. Suas teclas devem usar somente letras, números, aspas duplas (” “) e sinais de adição (+).
REPOSITÓRIO_CONTAINER_IMAGE_INVÁLIDO	Os repositórios [invalid_repositories] são inválidos. Forneça repositórios criados por meio do tipo de AddRepositories alteração.
FORMATO_TAG_IMAGEM_CONTAINER INVÁLIDO	A tag da imagem do contêiner [invalid_image_tag] é inválida. Forneça uma tag em conformidade com a expressão regular {CONTAINER_IMAGE_TAG_REGEX}.
TECLAS_DE_PARAMETER_DUPLICATE	Os parâmetros de substituição contêm chaves duplicadas [duplicate_keys]. Remova as duplicatas.
CONTAINER_IMAGE_URI NÃO SUPORTADO	A imagem do contêiner [unsupported_image] não é suportada. Forneça uma imagem que siga o Image Manifest V 2, Esquema 1.
NOMES_REPOSITÓRIOS_DUPLICADOS	Nomes de repositórios duplicados: [duplicate_repo_names]. Forneça nomes exclusivos.
NAMESPACE INVÁLIDO	Os valores do namespace [invalid_namespaces] são inválidos. Forneça valores que estejam em conformidade com a expressão regular {HELM_RELEASE_PARAM_REGEX}.
NOME_DE_LANÇAMENTO INVÁLIDO	Os valores de releaseName [invalid_release_names] são inválidos. Forneça valores que estejam em conformidade com a expressão regular {HELM_RELEASE_PARAM_REGEX}.
OVERRIDE_PARAMETER_KEYS_CONTAINS_RESERVED_PARAMETER_KEYS	A chave de parâmetro de substituição para títulos de opções de entrega [invalid_keys] está reservada. Chaves reservadas: [reserved_param_keys]. Forneça uma chave diferente.

Atualize a visibilidade de um complemento do Amazon EKS

Você pode usar a API do catálogo para atualizar a visibilidade de uma opção de entrega complementar do Amazon EKS da versão do seu produto emAWS Marketplace. As opções Helm de contêiner e entrega para seu produto de contêiner são criadas automaticamente com o status de visibilidade “Público”.

nota

A capacidade de atualizar a visibilidade da versão do seu produto é suportada somente pela opção de entrega complementar Amazon EKS das versões listadas. Se seu produto ainda não for “Público”, envie uma solicitação para publicar o produto com o status de visibilidade “Público” usando Portal de gerenciamento do AWS Marketplace o.

Por padrão, quando você cria uma versão com a opção de entrega complementar do Amazon EKS, ela é publicada no status “Limitado”. O status “Limitado” significa que o produto não está disponível publicamente em todas as regiões para seus compradores usarem e implantarem em um cluster Amazon EKS. Você pode atualizar a visibilidade da opção de entrega de “Limitada” para “Pública” chamando a operação da StartChangeSet API com o tipo de UpdateDeliveryOptionsVisibility alteração. Especifique a versão DeliveryOptions Id do seu produto que corresponde à opção de entrega complementar do Amazon EKS.

Sintaxe da solicitação



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

Para adicionar o tipo de UpdateDeliveryOptionsVisibility alteração, forneça informações para os seguintes campos:

Entity(objeto) (obrigatório) — Seu produto baseado em contêiner.
- Identifier(string) (obrigatório) — Seu ID do produto. Para obter mais informações, consulte Identificador.
- Type(string) (obrigatório) — Type É baseado no método de entrega (tipo de produto) que seu produto usa:ContainerProduct@1.0.
DetailsDocument(objeto) (obrigatório) — Detalhes da solicitação, incluindo as informações sobre os repositórios que você deseja criar. Os campos a seguir são todos obrigatórios.
- DeliveryOptions(lista de objetos) — Lista de DeliveryOption objetos, incluindo os detalhes de cada um:
  - Id(string) — Identificador exclusivo para DeliveryOption o. (Para obter o identificador exclusivo doDeliveryOption, chame a DescribeEntity ação no produto que você está atualizando.
  - TargetVisibility— A nova visibilidade pretendida do produto.

Sintaxe de resposta

Um conjunto de alterações é criado para sua solicitação. A resposta a essa solicitação fornece o ChangeSetId e ChangeSetArn para o conjunto de alterações.



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

Você pode verificar o status da solicitação por meio do Portal de gerenciamento do AWS Marketplace ou AWS Marketplace Catalog API usando a operação da DescribeChangeSet API.

Erros assíncronos

A tabela a seguir mostra os erros específicos AddDeliveryOptions das ações noAWS Marketplace Catalog API. Esses erros são retornados quando você liga DescribeChangeSet após o processamento de um conjunto de alterações. Para obter mais informações sobre como usar DescribeChangeSet para obter o status de uma solicitação de alteração, consulteTrabalhando com conjuntos de alterações.

Código de erro	Mensagem de erro
IDS_OPÇÕES_DE_ENTREGA VAZIAS	Forneça uma lista de IDs de opções de entrega.
ESTADO_DE_VISIBILIDADE_INVÁLIDO	A `TargetVisibility` opção que você forneceu não é suportada. Tente novamente com uma opção permitida. As opções permitidas são: `Public`
IDS_OPTION_DE_DELIVERY INVÁLIDOS	Você forneceu detalhes inválidos da opção de entrega. Forneça IDs de opção de entrega que possam ser encontrados no produto. IDs não encontrados: [x]
IDS_OPTION_DE_DELIVERY DUPLICADOS	IDs de opção de entrega duplicados: [duplicate_ids]. Forneça IDs de opção de entrega exclusivos.
ERRO_DE_AUDITORIA	Você não concluiu o teste de um fornecedor independente de software (ISV) para todas as versões de cluster compatíveis do Amazon EKS para suas versões complementares do Amazon EKS. Você deve concluir o teste antes que possamos liberar as opções de entrega.
TIPO_DE_OPÇÃO_DE_ENTREGA INVÁLIDA	O tipo de opção de entrega que você forneceu não é válido. Certifique-se de que sua opção de entrega seja do tipo: `EksAddOn` e tente novamente.
OBJETOS_HELM_INCOMPATÍVEIS	Forneça um Helm gráfico sem objetos não suportados: Helm os objetos não suportados Helm são os seguintes: todos os objetos Release (exceto .Name e .Namespace), Helm ganchos e funções de pesquisa.
NOME_DO_COMPLEMENTO INCOMPATÍVEL	O nome do complemento [provided_name] não corresponde ao nome da versão pública. Atualize o nome público antes do lançamento.
TIPO DE COMPLEMENTO INCOMPATÍVEL	Os tipos de complementos não coincidem. Reutilize o tipo de complemento existente da versão de complemento pública ou de versões complementares anteriores deste produto. Somente um complemento é compatível com cada produto.
NAMESPACE INCOMPATIBLE_ADDON_	O namespace complementar fornecido [provided_namespace] não corresponde ao namespace da versão pública. Atualize o namespace do complemento antes do lançamento.

Crie repositórios e recursos

Para criar uma nova versão de um produto baseado em contêiner, você deve ter os recursos da versão disponíveis nos AWS Marketplace repositórios. Você cria os repositórios e, em seguida, envia (carrega) os Docker (eHelm) recursos para os repositórios. Para saber como criar os repositórios por meio doPortal de gerenciamento do AWS Marketplace, consulte Adicionar uma nova versão do seu produto no Guia do AWS Marketplace vendedor.

Para criar novos repositórios, chame StartChangeSet com o tipo de AddRepositories alteração, conforme mostrado no exemplo a seguir.

Sintaxe da solicitação


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

Forneça informações sobre os campos para adicionar o tipo de AddRepositories alteração:

Para obter mais informações sobre a criação de repositórios, consulte Adicionar uma nova versão no Guia do AWS Marketplace vendedor.

Entity(objeto) (obrigatório) — Seu produto baseado em contêiner.
- Identificador (string) (obrigatório) — ID do seu produto. Para obter mais informações, consulte Identificador.
- Type(string) (obrigatório) — Type É baseado no método de entrega (tipo de produto) que seu produto usará:ContainerProduct@1.0.
DetailsDocument(objeto) (obrigatório) — Detalhes da solicitação. Ele inclui as informações sobre os repositórios que você deseja criar. Os campos incluídos são todos obrigatórios.
- Repositories(matriz de estruturas) — Uma lista de objetos do repositório. Cada objeto do repositório inclui um nome e um tipo.
  - RepositoryName(string) — O nome do repositório a ser criado.
  - RepositoryType(string) — O tipo do repositório a ser criado. O único valor permitido é ECR.

nota

Você pode ter até 70 repositórios por produto, embora possa adicionar vários recursos e versões de recursos a um único repositório, fornecendo tags diferentes ao enviá-los.

Depois de criar um ou mais repositórios, você adiciona seus recursos aos repositórios. Para obter informações sobre como enviar recursos para repositórios, consulte Enviar uma imagem no Guia do usuário do Amazon Elastic Container Registry. Para obter informações sobre os comandos push específicos necessários para um de seus repositórios, consulte Adicionar uma nova versão no Guia do AWS Marketplace vendedor.

Erros assíncronos

Os erros a seguir são específicos AddRepositories das ações noAWS Marketplace Catalog API. Esses erros são retornados quando você liga DescribeChangeSet após o processamento de um conjunto de alterações. Para obter mais informações sobre como usar DescribeChangeSet para obter o status de uma solicitação de alteração, consulteTrabalhando com conjuntos de alterações.

Código de erro	Mensagem de erro
NOME_ECR_REPOSITORY_INVÁLIDO	Forneça o nome do repositório no formato: 'nginx-web-app'
DUPLICATE_ECR_REPOSITORY_NAME	O repositório [duplicate_repo_names] já existe. Escolha um nome diferente.
INFORMAÇÕES_REPOSITÓRIO_AUSENTES	Forneça pelo menos um nome de repositório.
NOME_ECR_REPOSITORY_INVÁLIDO	O comprimento máximo de caracteres foi atingido em 256. A contagem de caracteres inclui o namespace do vendedor.

Atualizar as informações da versão

Você pode usar a API de catálogo para atualizar os detalhes de uma versão existente do seu produto baseado em contêiner no. AWS Marketplace

nota

Quando um produto está disponível publicamente, você não pode atualizar o título da versão, as imagens do contêiner, o título da opção de entrega ou os recursos de implantação da versão. Se você precisar atualizar esses aspectos de um produto, crie uma nova versão.

Para atualizar uma versão existente do seu produto baseado em contêiner, chame a operação da StartChangeSet API com o tipo de UpdateDeliveryOptions alteração, conforme mostrado no exemplo a seguir. Isso atualiza as informações detalhadas das opções de entrega que você especifica, bem como a versão associada. Você deve incluir pelo menos uma opção de entrega.

Sintaxe da solicitação de entrega de imagem de contêiner


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

HelmSintaxe da solicitação 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"
                           }
                        ]
                     }
                  }
               }
            ]
         }
      }
   ]
}

Sintaxe da solicitação Add-On de entrega do 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}"
                           }
                        ]
                     }
                  }
               }
            ]
         }
      }
   ]
}

Forneça informações sobre os campos para adicionar o tipo de UpdateDeliveryOptions alteração:

Para obter mais informações sobre esses campos, consulte Adicionar uma nova versão no Guia do AWS Marketplace vendedor.

Entity(objeto) (obrigatório) — Seu produto baseado em contêiner.
- Identifier(string) (obrigatório) — Seu ID do produto. Para obter mais informações, consulte Identificador.
- Type(string) (obrigatório) — Type É baseado no método de entrega (tipo de produto) que seu produto usará:ContainerProduct@1.0.
DetailsDocument(objeto) (obrigatório) — Detalhes da solicitação. Ela inclui todas as informações sobre a versão do seu produto baseado em contêiner que você gostaria de atualizar. Os campos incluídos são todos opcionais, mas você deve incluir pelo menos um campo para atualizar.
- Version(objeto) — Detalhes sobre a versão do software.
  - VersionTitle(string) — O título da versão que você está criando. Normalmente, essa é uma descrição da versão, como Version 1.1 ou simplesmente1.1. Seus compradores poderão escolher a versão a ser implantada em uma lista de todos os títulos da versão.
    
    Essa propriedade não pode ser atualizada se o produto já estiver publicado publicamente.
  - ReleaseNotes(string) — Notas para que os compradores informem sobre as mudanças de uma versão para outra.
- DeliveryOptions(lista de objetos) — Lista de DeliveryOption objetos, incluindo os detalhes de cada um:
  - Id(string) — Identificador exclusivo para o DeliveryOption (você pode obter o identificador exclusivo para o DeliveryOption chamando a DescribeEntity ação no produto que você está atualizando).
  - Details(objeto) — Contém os detalhes de uma opção de entrega. Observe que esse objeto de detalhes aninhados não precisa ter escape duplo.
    
    EcrDeliveryOptionDetails(objeto) — Os detalhes da opção de entrega da imagem do contêiner.
    
    DeliveryOptionTitle(string) — Uma breve descrição que permite ao comprador escolher entre suas opções de entrega.
    
    Essa propriedade não pode ser atualizada se o produto já estiver publicado publicamente.
    
    ContainerImages(array of strings) — Uma matriz de URLs de imagem de contêiner usada por esta versão. O caminho será o repositório para o qual você fez o upload da imagem, com a tag da imagem usada por esta versão. Se esse campo for incluído, a lista deverá incluir todas as imagens necessárias, até mesmo imagens que não estejam sendo alteradas.
    
    Essa propriedade não pode ser atualizada se o produto já estiver publicado publicamente.
    
    DeploymentResources(matriz de objetos) — Uma matriz de outros recursos de implantação necessários para a versão, como links para Helm gráficos ou outra documentação. Cada recurso inclui um nome para descrevê-lo e uma URL que aponta para o recurso. Na página de lançamento da sua versão, isso é exibido como uma lista de links.
    
    Essa propriedade não pode ser atualizada se o produto já estiver publicado publicamente.
    
    Name(string) — O texto do hiperlink exibido ao comprador.
    
    Url(string) — O URL do hiperlink exibido ao comprador.
    
    CompatibleServices(array of strings) — Uma matriz de serviços com os quais a versão é compatível. Opções válidas: ECS EKSECS-Anywhere,EKS-Anywhere,, Bedrock-AgentCore e.
    
    AgenticTypeO tipo de agente de tempo de execução. Opções válidas:AGENT,MCP_SERVER, ouA2A_SERVER.
    
    Description(string) — Uma descrição mais longa da opção de entrega para fornecer detalhes ao comprador. Você também pode incluir um link para mais instruções hospedadas em outro lugar.
    
    UsageInstructions(string) — Forneça instruções sobre como implantar e usar seu produto. Você também pode adicionar um link para as instruções de uso hospedadas em outro lugar. Pode ter até 4.000 caracteres.
    
    EnvironmentVariables— Lista de variáveis de ambiente que são exigidas pelo contêiner AgentCore Runtime e que serão pré-preenchidas para os compradores após a implantação. Para cada variável, forneça um objeto com o nome esperado pelo seu contêiner, uma descrição e um DefaultValue opcional. Para variáveis como credenciais ou chaves de API que são exclusivas, não forneça um valor padrão. Você pode usar a descrição para especificar detalhes sobre a variável, bem como valores possíveis. Todas as variáveis fornecidas com seus valores padrão serão pré-preenchidas quando os compradores lançarem seu produto.
  - Id(string) — Identificador exclusivo para o DeliveryOption (você pode obter o identificador exclusivo para o DeliveryOption chamando a DescribeEntity ação no produto que você está atualizando).
  - Details(objeto) — Contém os detalhes de uma opção de entrega. Observe que esse objeto de detalhes aninhados não precisa ter escape duplo.
    
    HelmDeliveryOptionDetails(objeto) — Os detalhes da opção de entrega do Helm gráfico.
    
    DeliveryOptionTitle(string) — Uma breve descrição que permite ao comprador escolher entre suas opções de entrega.
    
    Essa propriedade não pode ser atualizada se o produto já estiver publicado publicamente.
    
    ContainerImages(array of strings) — Uma matriz de URLs de imagem de contêiner usada por esta versão. O caminho será o repositório para o qual você fez o upload da imagem, com a tag da imagem usada por esta versão. A lista deve incluir todas as imagens necessárias, até mesmo imagens que não foram alteradas em relação às versões anteriores. Consulte a próxima seção para obter informações sobre como criar repositórios usando a API de catálogo.
    
    HelmChartUri(string) — O URL do Helm gráfico hospedado no Amazon ECR que o comprador instalará para iniciar o software.
    
    CompatibleServices(array of strings) — Uma matriz de serviços com os quais a versão é compatível. As opções válidas são ECS e EKS.
    
    Description(string) — Uma descrição mais longa da opção de entrega para fornecer detalhes ao comprador. Você também pode incluir um link para mais instruções fornecidas em outro lugar.
    
    UsageInstructions(string) — Forneça instruções sobre o uso dessa opção de entrega. Pode ter até 4.000 caracteres.
    
    MarketplaceServiceAccountName(string) — O nome da conta Kubernetes de serviço. A conta de serviço será usada para se conectar e AWS Identity and Access Management obter permissões para ligar para AWS os serviços.
    
    ReleaseName(string) — O nome da Helm versão fornecido ao helm install comando que os compradores usam para iniciar o software.
    
    Namespace(string) — O Kubernetes namespace em que o Helm gráfico será instalado.
    
    OverrideParameters(matriz de objetos) — Parâmetros que serão usados nos Helm comandos que iniciam o aplicativo. Os compradores podem substituir os valores padrão.
    
    Key(string) — A chave para o parâmetro em notação de ponto (override.example.key).
    
    DefaultValue(string) — O valor padrão desse parâmetro de substituição.

Sintaxe de resposta

Um conjunto de alterações é criado para sua solicitação. A resposta a essa solicitação fornece a ChangeSetId e ChangeSetArn para o conjunto de alterações e tem a seguinte aparência.


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

Você pode verificar o status da solicitação por meio daPortal de gerenciamento do AWS Marketplace, ou diretamente por meio da API de catálogo, usando a operação da DescribeChangeSet API.

Erros assíncronos

Os erros a seguir são específicos UpdateDeliveryOptions das ações noAWS Marketplace Catalog API. Esses erros são retornados quando você liga DescribeChangeSet após o processamento de um conjunto de alterações. Para obter mais informações sobre como usar DescribeChangeSet para obter o status de uma solicitação de alteração, consulteTrabalhando com conjuntos de alterações.

Código de erro	Mensagem de erro
STATUS DE PRODUTO_INCOMPATÍVEL	Use um produto público ou limitado existente.
SERVIÇOS_INCOMPATÍVEIS	A lista de serviços contém serviços incompatíveis. [incompatible_services] Forneça uma lista válida de serviços compatíveis.
NENHUM SERVIÇO_ESPECIFICADO	Forneça pelo menos 1 serviço compatível.
SERVIÇOS AWS COMPATÍVEIS COM DUPLICADOS	A lista de serviços contém entradas duplicadas. Remova-os. Cada entrada deve ser exclusiva.
TÍTULO_DE_VERSÃO INVÁLIDA	Remova os espaços antes do símbolo da marca registrada.
TÍTULO_DE_VERSÃO INVÁLIDA	Remova os seguintes caracteres não suportados: [x, y, z]
TÍTULO_DE_VERSÃO INVÁLIDA	Remova os espaços do início do título da versão.
TÍTULO_DE_VERSÃO INVÁLIDA	Forneça o título da versão com menos de [x] caracteres.
TÍTULO DA VERSÃO_DUPLICADO	O título da versão [duplicate_version_title] é duplicado. Remova ou altere o título.
NOTAS_DE_LANÇAMENTO INVÁLIDAS	Remova os espaços antes do símbolo da marca registrada.
NOTAS_DE_LANÇAMENTO INVÁLIDAS	Remova caracteres não suportados: [x, y, z]
NOTAS_DE_LANÇAMENTO INVÁLIDAS	Remova os espaços do início das notas de versão.
NOTAS_DE_LANÇAMENTO INVÁLIDAS	Forneça notas de lançamento com menos de (x) caracteres.
INSTRUÇÕES_DE_USO INVÁLIDAS	Remova os espaços antes do símbolo da marca registrada.
INSTRUÇÕES_DE_USO INVÁLIDAS	Remova caracteres não suportados: [x, y, z]
INSTRUÇÕES_DE_USO INVÁLIDAS	Forneça instruções de uso com menos de (x) caracteres.
INSTRUÇÕES_DE_USO INVÁLIDAS	Forneça instruções de uso.
IMAGENS_CONTÊINERES AUSENTES	Forneça pelo menos 1 imagem de contêiner.
MUITAS_IMAGENS_CONTENTORES	Forneça menos de 50 imagens de contêiner.
IMAGENS_CONTÊINERES DUPLICADOS	A lista de imagens do contêiner contém imagens duplicadas: [duplicate_images]. Forneça uma lista com imagens exclusivas.
IMAGENS_CONTENTOR_INVÁLIDAS	Forneça um URI válido para a imagem do contêiner.
URI DE IMAGEM_CONTÊINER INVÁLIDO	A imagem [invalid_image_uri] não tem acesso a este produto. Faça o upload da imagem para o repositório de produtos correspondente. Para obter informações sobre o upload, consulte Introdução aos produtos de contêiner.
ETIQUETA_DE_IMAGEM_CONTÊINER INVÁLIDA	Evite usar a tag “mais recente”.
IDS_OPTION_DE_DELIVERY AUSENTES	Forneça a opção de entrega a partir da lista existente de IDs.
IDS_OPÇÕES_DE_ENTREGA VAZIAS	Forneça uma lista não vazia de IDs de opções de entrega.
IDS_OPTION_DE_DELIVERY DUPLICADOS	IDs de opção de entrega duplicados: [duplicate_ids]. Forneça IDs de opção de entrega exclusivos.
TÍTULO_OPÇÃO_DE_ENTREGA_DUPLICADOS	Títulos de opções de entrega duplicados: [duplicate_titles]. Remova as duplicatas
TÍTULOS_OPÇÕES_DE_ENTREGA INVÁLIDOS	Os títulos da opção de entrega [existing_titles] já existem. Forneça um título diferente.
TÍTULO_OPÇÃO_DE_PREENCHIMENTO INVÁLIDO	Forneça o título da opção de entrega com menos de (x) caracteres.
NOME_DO_RECURSO_VAZIO	Forneça o nome do recurso.
URL_DE_RECURSO VAZIO	Forneça o URL do recurso.
NOME_DO_RECURSO_INVÁLIDO	Forneça o nome do recurso com menos de 256 caracteres.
URL_DE_RECURSO INVÁLIDO	Forneça o URL do recurso com menos de 256 caracteres.
DESCRIÇÃO_CURTA INVÁLIDA	Forneça uma breve descrição com menos de 1.000 caracteres.
DESCRIÇÃO_CURTA INVÁLIDA	Forneça uma breve descrição.
CHAVES SECRETAS SEM LICENÇA	Para produtos Amazon EKS Anywhere, forneça 1 parâmetro de substituição para o segredo da licença. Necessidades `DefaultValue` de`"${AWSMP_LICENSE_SECRET}"`, veja o exemplo na seção.
NENHUMA CONFIGURAÇÃO DE CONTA DE SERVIÇO	Para produtos pagos, forneça 1 parâmetro de substituição para a configuração da conta de serviço. Necessidades `DefaultValue` de`"${AWSMP_SERVICE_ACCOUNT}"`, veja o exemplo na seção.
ERRO_DE_DIGITALIZAÇÃO	Corrija a vulnerabilidade de segurança “" [y] "” na imagem “" [x] "”.
CAMPO NÃO AUTORIZADO A SER ALTERADO	O campo [x] não pode ser alterado.
STATUS DE OPÇÕES_DE ENTREGA INVÁLIDO	Os IDs da opção de entrega [invalid_ids] são inválidos. Forneça opções de entrega no estado limitado ou público.
NENHUMA ALTERAÇÃO ENCONTRADA	Forneça pelo menos 1 alteração.
ATUALIZAÇÃO DE VÁRIAS VERSÕES	Forneça IDs de opção de entrega da mesma versão.
OVERRIDE_PARAMETER_KEYS_CONTAINS_SPECIAL_CHARS	As chaves do parâmetro de substituição [invalid_keys] contêm caracteres inválidos. Suas teclas devem usar somente letras, números, aspas duplas (” “) e sinais de adição (+).
REPOSITÓRIO_CONTAINER_IMAGE_INVÁLIDO	Os repositórios [invalid_repositories] são inválidos. Forneça repositórios criados por meio do tipo de AddRepositories alteração.
FORMATO_TAG_IMAGEM_CONTAINER INVÁLIDO	A tag da imagem do contêiner [invalid_image_tag] é inválida. Forneça uma tag em conformidade com a expressão regular {CONTAINER_IMAGE_TAG_REGEX}.
TECLAS_DE_PARAMETER_DUPLICATE	Os parâmetros de substituição contêm chaves duplicadas [duplicate_keys]. Remova as duplicatas.
CONTAINER_IMAGE_URI NÃO SUPORTADO	A imagem do contêiner [unsupported_image] não é suportada. Forneça uma imagem que siga o Image Manifest V 2, Esquema 1.
NAMESPACE INVÁLIDO	Os valores do namespace [invalid_namespaces] são inválidos. Forneça valores que estejam em conformidade com a expressão regular {HELM_RELEASE_PARAM_REGEX}.
NOME_DE_LANÇAMENTO INVÁLIDO	Os valores de releaseName [invalid_release_names] são inválidos. Forneça valores que estejam em conformidade com a expressão regular {HELM_RELEASE_PARAM_REGEX}.
OVERRIDE_PARAMETER_KEYS_CONTAINS_RESERVED_PARAMETER_KEYS	A chave de parâmetro de substituição para títulos de opções de entrega [invalid_keys] está reservada. Chaves reservadas: [reserved_param_keys]. Forneça uma chave diferente.
NOME_DO_COMPLEMENTO INCOMPATÍVEL	O nome do complemento [provided_name] não corresponde ao nome existente. Reutilize o nome existente da versão pública ou de versões anteriores desse complemento. Você só pode usar um nome de complemento para cada produto.
NAMESPACE INCOMPATIBLE_ADDON_	O namespace complementar [provided_namespace] não corresponde ao namespace existente. Reutilize o namespace existente da versão pública ou de versões anteriores desse complemento. Você só pode usar um namespace complementar para cada produto.

Restringir uma versão

Você pode usar a API de catálogo para restringir uma versão do seu produto baseado em contêiner em. AWS Marketplace Isso impede que novos compradores possam usar essa versão. Deve haver pelo menos uma versão disponível publicamente em um produto. Você não pode restringir a única versão disponível publicamente restante de um produto.

Para restringir uma versão, chame a operação da StartChangeSet API com o tipo de RestrictDeliveryOptions alteração, conforme mostrado no exemplo a seguir.

nota

Restringir uma ou mais opções de entrega de uma versão, mas não todas, fará com que essas opções não estejam disponíveis para seus compradores. Restringir todas as opções de entrega de uma versão removerá essa versão do AWS Marketplace catálogo.

Atualmente, a restrição de um complemento do Amazon EKS não é suportada pela API de catálogo.

As versões restritas ainda estão disponíveis para clientes existentes.

Sintaxe da solicitação


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

Forneça informações sobre os campos para adicionar o tipo de RestrictDeliveryOptions alteração:

Entity(objeto) (obrigatório) — Seu produto baseado em contêiner.
- Identifier(string) (obrigatório) — Seu ID do produto. Para obter mais informações, consulte Identificador.
- Type(string) (obrigatório) — Type É baseado no método de entrega (tipo de produto) que seu produto usará:ContainerProduct@1.0.
DetailsDocument(objeto) (obrigatório) — Detalhes da solicitação. Ele inclui IDs para as opções de entrega do seu produto baseado em contêiner que você gostaria de restringir.
- DeliveryOptionIds(matriz de strings) — Lista de DeliveryOption IDs para as versões que você deseja restringir. Você pode obter o identificador exclusivo do DeliveryOption chamando a DescribeEntity ação no produto que você está restringindo.

Sintaxe de resposta

Um conjunto de alterações é criado para sua solicitação. A resposta a essa solicitação fornece a ChangeSetId e ChangeSetArn para o conjunto de alterações e tem a seguinte aparência.


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

A solicitação de alteração é adicionada a uma fila e processada. Esse processo pode levar de alguns minutos a horas.

Você pode verificar o status da solicitação por meio daPortal de gerenciamento do AWS Marketplace, ou diretamente por meio da API de catálogo, usando a operação da DescribeChangeSet API.

Erros assíncronos

Os erros a seguir são específicos RestrictDeliveryOptions das ações noAWS Marketplace Catalog API. Esses erros são retornados quando você liga DescribeChangeSet após o processamento de um conjunto de alterações. Para obter mais informações sobre como usar DescribeChangeSet para obter o status de uma solicitação de alteração, consulteTrabalhando com conjuntos de alterações.

Código de erro	Mensagem de erro
STATUS DE PRODUTO_INCOMPATÍVEL	Use um produto público.
IDS_OPTION_DE_DELIVERY AUSENTES	Forneça a opção de entrega a partir da lista existente de IDs.
STATUS DE OPÇÕES_DE ENTREGA INVÁLIDO	Os IDs da opção de entrega [invalid_ids] são inválidos. Forneça opções de entrega no estado público.
IDS_OPÇÕES_DE_ENTREGA VAZIAS	Forneça uma lista não vazia de IDs de opções de entrega.
OPÇÕES_MINIMUM_PUBLIC_DELIVERY_INVÁLIDAS	Não é possível restringir todas as IDs das opções de entrega.
IDS_OPTION_DE_DELIVERY DUPLICADOS	IDs de opção de entrega duplicados: [duplicate_ids]. Forneça IDs de opção de entrega exclusivos.

Atenção O Javascript está desativado ou não está disponível no seu navegador.

Para usar a documentação da AWS, o Javascript deve estar ativado. Consulte as páginas de Ajuda do navegador para obter instruções.

Convenções do documento

Trabalhe com produtos componentes do EC2 Image Builder

Trabalhe com produtos SaaS