Ajouter une nouvelle version Mettre à jour la visibilité d'un module complémentaire Amazon EKS Création de référentiels et de ressources Informations de version de mise à jour Restreindre une version

Travaillez avec des produits en contenant à l'aide du AWS Marketplace API

Vous pouvez utiliser l'API AWS Marketplace Catalog pour automatiser les tâches liées à l'utilisation de produits basés sur des conteneurs.

Pour plus d'informations sur la création d'un produit basé sur un conteneur à l'aide de l'API Catalog, consultez. Création d'un produit

Les rubriques suivantes décrivent comment utiliser l'API Catalog pour effectuer des actions sur vos produits basés sur des conteneurs :

Rubriques

Ajouter une nouvelle version
Mettre à jour la visibilité d'un module complémentaire Amazon EKS
Création de référentiels et de ressources
Informations de version de mise à jour
Restreindre une version

Ajouter une nouvelle version

Si vous possédez déjà un produit basé sur un conteneur AWS Marketplace, vous pouvez utiliser le AWS Marketplace Catalog API pour ajouter une nouvelle version. Cela nécessite que vous ayez déjà créé des référentiels AWS Marketplace pour chaque image ou artefact de conteneur faisant partie de votre produit, et que vous puissiez les copier depuis votre local Docker et Helm vos fichiers.

Note

Pour plus d'informations sur la création d'un produit en conteneur à l'aide du Portail de gestion AWS Marketplace, consultez la section Commencer à utiliser des produits en conteneur dans le Guide du AWS Marketplace vendeur.

Pour plus d'informations sur l'ajout d'une nouvelle version, y compris la création de référentiels Docker et la création de Helm fichiers dans ces référentiels, à l' Portail de gestion AWS Marketplace aide de la section Ajouter une nouvelle version de votre produit dans le Guide du AWS Marketplace vendeur.

Si vous n'avez pas encore créé de nouveaux référentiels, vous pouvez les créer à l'aide de l'API Catalog, voirCréation de référentiels et de ressources.

Pour ajouter une nouvelle version, appelez l'opération StartChangeSet API avec le type de AddDeliveryOptions modification, comme indiqué dans l'exemple suivant.

Note

Une version d'un produit basé sur un conteneur est composée d'une ou de plusieurs options de livraison. Par exemple, vous pouvez avoir deux options de livraison, l'une qui fonctionne avec une base de données NoSQL et l'autre qui fonctionne avec MySQL, afin que vos utilisateurs puissent choisir la manière dont ils souhaitent travailler avec votre produit. Vous créez la version de votre produit et ajoutez plusieurs options de livraison en une seule demande avecAddDeliveryOptions.

Syntaxe de demande de livraison d'images de conteneur


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

Syntaxe de demande de livraison 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."
                  }
                ]
              }
            }
          }      
        ]
      }
    }
  ]
}

HelmSyntaxe de demande de livraison de graphiques


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

Syntaxe des demandes Add-On de livraison 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"
    }
  ]
}

Fournissez des informations pour les champs permettant d'ajouter le type de AddDeliveryOptions modification :

Entity(objet) (obligatoire) — Votre produit basé sur un conteneur.
- Identifier(string) (obligatoire) — L'identifiant de votre produit. Pour de plus amples informations, veuillez consulter Identifiant.
- Type(chaîne) (obligatoire) — Cela dépend du mode de livraison (type de produit) que votre produit utilisera :ContainerProduct@1.0. Type
DetailsDocument(objet) (obligatoire) — Détails de la demande. Il contient toutes les informations relatives à la version que vous ajoutez. Ce champ est un champ de chaîne.
- Version(object) — Informations sur la version que vous ajoutez à votre produit.
  - VersionTitle(string) — Le titre de la version que vous créez. Il s'agit généralement d'une description de la version, similaire Version 1.1 ou simple1.1. Vos acheteurs pourront choisir la version à déployer dans une liste de titres de version.
  - ReleaseNotes(string) — Les notes détaillées concernant cette version. Doit comporter moins de 30 000 caractères.
- DeliveryOptions(ensemble d'objets) — Un ensemble d'options de livraison, chacune étant un mode de livraison pour la version de votre produit. Par exemple, si vous avez une option de livraison pour Amazon Elastic Container Service (Amazon ECS) et une autre pour Amazon Elastic Kubernetes Service (Amazon EKS), vous devez disposer de deux options de livraison.
  - DeliveryOptionTitle(chaîne) — Brève description qui aide votre acheteur à choisir entre vos options de livraison.
  - Details(object) — Les ressources utilisées pour cette option de livraison. Il s'agit d'un champ de détails dans le champ de détails. Il n'est pas nécessaire d'échapper deux fois aux caractères dans ce champ.
    
    AddOnName – Nom unique du module complémentaire que les acheteurs verront apparaître dans le catalogue Amazon EKS. Ce nom ajoutera un préfixe ultérieurement en utilisantSellerAlias. Par exemple, où isv-alias_ est le nom du module complémentaire fourni par l'ISV ?
    
    AddOnType – Type de module complémentaire choisi parmi une liste de valeurs prises en charge par Amazon EKS : Gitops | surveillance | journalisation | gestion des certificats | gestion des politiques | gestion des coûts | mise à l'échelle automatique | stockage | kubernetes-management | service-mesh | etcd-backup | ingress-service-type | load-balancer | local-registry | réseau | sécurité | sauvegarde | contrôleur d'entrée | observabilité
    
    AddOnVersion – Une version sémantique permettant à l'acheteur de choisir une version spécifique à installer ou à mettre à niveau. AddOn
    
    CompatibleKubernetesVersions— Les versions d'Amazon EKS Kubernetes avec lesquelles ce logiciel est compatible.
    
    CompatibleServices(tableau de chaînes) — Ensemble de services avec lesquels la version est compatible. Options valides : ECSEKS,ECS-Anywhere,EKS-Anywhere, etBedrock-AgentCore.
    
    ContainerImages(tableau de chaînes) — Tableau d'URL d'images de conteneurs utilisé par cette version. Le chemin sera le référentiel dans lequel vous avez chargé l'image, avec le tag correspondant à l'image utilisée par cette version. La liste doit inclure toutes les images nécessaires, même les images qui n'ont pas changé par rapport aux versions précédentes. Consultez la section suivante pour plus d'informations sur la création de référentiels à l'aide de l'API Catalog.
    
    Description(chaîne) — Description plus longue de l'option de livraison pour fournir des informations à votre acheteur. Vous pouvez également inclure un lien vers d'autres instructions fournies ailleurs.
    
    EcrDeliveryOptionDetails— AgenticType — Type d'agent d'exécution. Options valides : AGENTMCP_SERVER, ouA2A_SERVER.
    
    EcrDeliveryOptionDetails— EnvironmentVariables — Liste des variables d'environnement requises par le conteneur AgentCore Runtime et qui seront préremplies pour les acheteurs lors du déploiement. Pour chaque variable, fournissez un objet avec le nom attendu par votre conteneur, une description et une DefaultValue facultative. Pour les variables telles que les informations d'identification ou les clés d'API qui sont uniques, ne fournissez pas de valeur par défaut. Vous pouvez utiliser la description pour spécifier les détails de la variable ainsi que les valeurs possibles. Toutes les variables fournies avec leurs valeurs par défaut seront préremplies lorsque les acheteurs lanceront votre produit.
    
    EcrDeliveryOptionDetails –DeploymentResources (array of objects)— Un ensemble d'autres ressources nécessaires à la version, telles que Helm des graphiques. Chaque ressource inclut un Name pour la décrire et un URL qui pointe vers la ressource.
    
    EnvironmentOverrideParameters –Liste des paramètres système à utiliser par le module complémentaire. Certains des ISV fournis AddOn (HelmChart) peuvent nécessiter des configurations avec des informations dérivées de l'état de l'environnement d'exécution Amazon EKS (/informations système). Par exemple, EksClusterRegionEKSClusterName, et d'autres. Vous pouvez éviter des actions supplémentaires de la part de l'acheteur en remplaçant ces valeurs de manière dynamique lors du AddOn lancement d'Amazon EKS. Le système Amazon EKS prend déjà en charge le remplacement automatique des paramètres système par des modules complémentaires. AWS Marketplace L'expérience des ISV peut être étendue pour collecter ces paramètres qui nécessiteraient une substitution.
    
    Les informations système génériques à substituer peuvent être indiquées en fournissant une constante AWS Marketplace spécifiée selon une convention similaire à la Helm substitution. Les valeurs prises en charge sont ${AWS_REGION} et ${AWS_EKS_CLUSTER_NAME}.
    
    "EnvironmentOverrideParameters" : [ { "Key" : "my-field.region" "Value" : "${AWS_REGION}" }, { "Key" : "my-second-field" "Value" : "${AWS_EKS_CLUSTER_NAME}" },
    
    HelmDeliveryOptionDetails— HelmChartUri (string) — L'URL du Helm graphique hébergé sur Amazon ECR que l'acheteur installera pour lancer le logiciel.
    
    HelmDeliveryOptionDetails –MarketplaceServiceAccountName (string)— Facultatif — Le nom du compte de service Kubernetes. Le compte de service sera utilisé pour se connecter à Gestion des identités et des accès AWS (IAM) afin d'obtenir les autorisations d'appel Services AWS.
    
    HelmDeliveryOptionDetails –ReleaseName (string)— Facultatif — Nom de la Helm version fourni à la helm install commande utilisée par les acheteurs pour lancer le logiciel. S'il n'est pas inclus, Helm il vous fournira un nom de version généré automatiquement.
    
    HelmDeliveryOptionDetails –Namespace (string)— Facultatif — L'Kubernetesespace de noms dans lequel le Helm graphique sera installé.
    
    HelmDeliveryOptionDetails –OverrideParameters (array of objects)— Paramètres qui seront utilisés dans les Helm commandes qui lancent l'application. Les acheteurs peuvent modifier les valeurs par défaut.
    
    Note
    Pour les produits Amazon EKS Anywhere, fournissez au moins un paramètre de remplacement pour le secret de licence. Fournir DefaultValue de"${AWSMP_LICENSE_SECRET}".
    Pour les produits payants, fournissez au moins un paramètre de remplacement pour la configuration du compte de service. Fournir DefaultValue de"${AWSMP_SERVICE_ACCOUNT}".
    
    Key(string) — La clé du paramètre en notation par points (override.example.key).
    
    DefaultValue(string) — La valeur par défaut de ce paramètre de remplacement.
    
    Namespace – L'ISV a fourni un espace de noms pour l'installation des modules complémentaires.
    
    SupportedArchitectures – La liste des architectures prises en charge, comme amd64 et arm64.
    
    UsageInstructions(string) — Fournissez des instructions concernant l'utilisation de cette option de livraison. Peut comporter jusqu'à 4 000 caractères.

Syntaxe de réponse

Un ensemble de modifications est créé pour votre demande. La réponse à cette demande vous donne l'ChangeSetIdensemble ChangeSetArn de modifications et ressemble à ce qui suit.


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

La demande de modification est ajoutée à une file d'attente et traitée, notamment en scannant les images du conteneur et d'autres informations pour s'assurer qu'elle est conforme aux AWS Marketplace directives relatives aux produits en conteneur. Ce processus peut prendre de quelques minutes à quelques heures, selon le nombre et la taille de vos contenants.

Vous pouvez vérifier l'état de la demande via ou directement via l' Portail de gestion AWS Marketplace API Catalog à l'aide de l'opération DescribeChangeSet API.

Pour plus d’informations sur les jeux de modifications, consultez Travailler avec des ensembles de modifications. Pour plus d'informations sur les erreurs dans les ensembles de modifications des produits proposés par les vendeurs, consultezModifier le statut et les erreurs du set.

Erreurs asynchrones

Les erreurs suivantes sont spécifiques aux AddDeliveryOptions actions du AWS Marketplace Catalog API. Ces erreurs sont renvoyées lorsque vous appelez DescribeChangeSet après le traitement d'un ensemble de modifications. Pour plus d'informations sur l'utilisation DescribeChangeSet pour obtenir le statut d'une demande de modification, consultezTravailler avec des ensembles de modifications.

Code d’erreur	Message d’erreur
ÉTAT_DU PRODUIT INCOMPATIBLE	Utilisez un produit limité ou public existant.
SERVICES_INCOMPATIBLES	La liste des services contient des services incompatibles. [incompatible_services] Fournissez une liste valide de services compatibles.
AUCUN SERVICE SPÉCIFIÉ	Fournissez au moins un service compatible.
_SERVICES COMPATIBLES AVEC LES DOUBLONS AWS	La liste des services contient des entrées dupliquées. Retirez-les. Chaque entrée doit être unique.
TITRE_DE LA VERSION NON VALIDE	Supprimez les espaces devant le symbole de marque.
TITRE_DE LA VERSION NON VALIDE	Supprimez les caractères non pris en charge suivants : [x, y, z]
TITRE_DE LA VERSION NON VALIDE	Supprimez les espaces au début du titre de la version.
TITRE_DE LA VERSION NON VALIDE	Indiquez le titre de la version contenant moins de [x] caractères.
TITRE_DE_VERSION DUPLIQUÉ	Le titre de la version [duplicate_version_title] est un doublon. Supprimez ou modifiez le titre.
NOTES_DE_PUBLICATION NON VALIDES	Supprimez les espaces devant le symbole de marque.
NOTES_DE_PUBLICATION NON VALIDES	Supprimer les caractères non pris en charge : [x, y, z]
NOTES_DE_PUBLICATION NON VALIDES	Supprimez les espaces au début des notes de publication.
NOTES_DE_PUBLICATION NON VALIDES	Fournissez des notes de version contenant moins de (x) caractères.
INSTRUCTIONS D'UTILISATION NON VALIDES	Supprimez les espaces devant le symbole de marque.
INSTRUCTIONS D'UTILISATION NON VALIDES	Supprimer les caractères non pris en charge : [x, y, z]
INSTRUCTIONS D'UTILISATION NON VALIDES	Fournissez des instructions d'utilisation contenant moins de (x) caractères.
INSTRUCTIONS D'UTILISATION NON VALIDES	Fournissez des instructions d'utilisation.
IMAGES_CONTENEUR_MANQUANTES	Fournissez au moins une image du conteneur.
AUCUNE CLÉ SECRÈTE DE LICENCE	Pour les produits Amazon EKS Anywhere, fournissez un paramètre de remplacement pour le secret de licence. Besoins `DefaultValue` de`"${AWSMP_LICENSE_SECRET}"`, voir l'exemple dans la section.
TROP D'IMAGES_CONTENEUR_D'IMAGES	Fournissez moins de 50 images de conteneurs.
IMAGES_CONTENEUR_DUPLIQUÉES	La liste des images du conteneur contient des images dupliquées : [duplicate_images]. Fournissez une liste d'images uniques.
IMAGES_CONTENEUR_INVALIDES	Fournissez un URI valide pour l'image du conteneur.
INVALID_CONTAINER_IMAGE_URI	L'image [invalid_image_uri] n'a pas accès à ce produit. Téléchargez l'image dans le référentiel de produits correspondant. Pour plus d'informations sur le téléchargement, voir Commencer à utiliser les produits conteneurisés.
IMAGE_CONTENEUR_TAG NON VALIDE	Évitez d'utiliser le tag « dernier ».
TITRES D'OPTIONS DE LIVRAISON DUPLIQUÉS	Titres des options de livraison dupliqués : [duplicate_titles]. Supprimer les doublons
TITRES_OPTION_DE LIVRAISON NON VALIDES	Les titres des options de livraison [existing_titles] existent déjà. Entrez un autre titre.
TITRE_OPTION_D'EXPÉDITION NON VALIDE	Indiquez le titre de l'option de livraison contenant moins de (x) caractères.
AUCUNE CONFIGURATION DE COMPTE DE SERVICE	Pour les produits payants, fournissez 1 paramètre de remplacement pour la configuration du compte de service. Besoins `DefaultValue` de`"${AWSMP_SERVICE_ACCOUNT}"`, voir l'exemple dans la section.
DÉTAILS_INVALIDES	Les informations fournies ne sont pas valides.
NOM_RESSOURCE_VIDE	Indiquez le nom de la ressource.
URL DE RESSOURCE_VIDE	Fournissez l'URL de la ressource.
NOM_RESSOURCE NON VALIDE	Indiquez le nom de la ressource contenant moins de 256 caractères.
URL_RESSOURCE NON VALIDE	Indiquez l'URL de la ressource contenant moins de 256 caractères.
DESCRIPTION_COURTE NON VALIDE	Fournissez une brève description de moins de 1 000 caractères.
DESCRIPTION_COURTE NON VALIDE	Fournissez une brève description.
ERREUR DE NUMÉRISATION	Corrigez la vulnérabilité de sécurité «" [y] "» sur l'image «" [x] "».
IMAGE NON TROUVÉE	L'URI de l'image publique [invalid_image_uri] n'est pas valide. Indiquez un URI valide.
AR_INVALIDE	Fournissez un ARN valide pour l'accès aux images.
IMAGE_INACCESSIBLE	Fournissez un ARN valide pour l'accès aux images.
NOM_ADDON_DUPLIQUÉ	Le AddOn nom que vous avez indiqué est déjà utilisé par un autre produit. Entrez un autre nom.
DUPLICATE_ADDON_VERSION	Le titre de la version complémentaire [duplicate_version_title] est déjà utilisé. Entrez un autre titre.
TYPE_ADDON NON VALIDE	Les types de modules complémentaires [invalid_types] ne sont pas valides. Indiquez un type dans la liste des types pris en charge : [eks_addon_do_supported_types].
VERSION_KUBERNETES_INVALIDE	Les versions de Kubernetes [invalid_versions] ne sont pas valides. Fournissez les versions de la liste prise en charge : [eks_addon_do_supported_kubernetes_versions].
VERSIONS DUPLIQUÉES DE KUBERNETES	Versions dupliquées de Kubernetes : [duplicate_versions]. Fournissez une liste de versions uniques.
ARCHITECTURE_INVALIDE	Les architectures [invalid_architectures] ne sont pas valides. Fournissez des architectures issues des architectures prises en charge par Amazon EKS : [eks_addon_do_supported_architectures].
ARCHITECTURES PRISES EN CHARGE PAR LA DUPLICATION	Architectures dupliquées : [duplicate_architectures]. Fournissez une liste d'architectures uniques prises en charge.
ÉTAT_DE VISIBILITÉ NON VALIDE	Les états [invalid_states] ne sont pas valides pour l'option de livraison {EKS_DO}. Fournissez un état de visibilité valide à partir des valeurs autorisées suivantes : Limité.
VALEUR_PARAMÈTRE_OVERRIDE_INVALIDE	Les valeurs des paramètres de remplacement [invalid_values] ne sont pas valides. Entrez une valeur valide dans la liste suivante : [eks_addon_do_environment_override_parameter_values].
DUPLICATE_ENVIRONMENT_OVERRIDE_PARAMETER_KEY	Les paramètres de remplacement de l'environnement contiennent des clés dupliquées : [duplicate_keys]. Retirez-les.
TROP D'OPTIONS DE LIVRAISON EKS_ADDON_DELIVERY_	Ne fournissez qu'une seule option de livraison du module complémentaire Amazon EKS pour cette version.
NOM_ADDON_INCOMPATIBLE	Le nom du module complémentaire [provided_name] ne correspond pas au nom existant. Réutilisez le nom existant de la version publique ou des versions précédentes de ce module complémentaire. Vous ne pouvez utiliser qu'un seul nom d'extension pour chaque produit.
TYPE_ADDON_INCOMPATIBLE	Le type de module complémentaire [provided_type] ne correspond pas au type existant. Réutilisez le type existant de la version publique ou des versions précédentes de ce module complémentaire. Vous ne pouvez utiliser qu'un seul type de module complémentaire pour chaque produit.
ESPACE DE NOMS INCOMPATIBLE_ADDON_	L'espace de noms du module complémentaire [provided_namespace] ne correspond pas à l'espace de noms existant. Réutilisez l'espace de noms existant de la version publique ou des versions précédentes de ce module complémentaire. Vous ne pouvez utiliser qu'un seul espace de noms d'extension pour chaque produit.
HELM_CHART_URI NON VALIDE	L'URI du graphique Helm [invalid_uri] n'est pas valide. Fournissez un URI au format SemVer 2.
INCOMPATIBLE_HELM_OBJECTS (INVALID_HELM_OBJECTS)	<unsupported-objects>Fournissez un Helm graphique sans utiliser les Helm objets non pris en charge suivants :.
CHARTS_DEPENDENT_HELM_INVALIDES	Fournissez un graphique Helm contenant les graphiques dépendants suivants directement dans le répertoire des graphiques parent et non provenant de sources externes :<invalid-subcharts>.
CONFIG_HELM_SENSITIVE_INVALIDE	Fournissez un schéma de configuration avancé sans informations sensibles ni secrets. Mots-clés : <sensitive-parameters-identified>
IMAGES_HELM_NON DÉCLARÉES	Fournissez les images du graphique Helm suivantes dans le cadre de l'option de livraison de la demande :<list-of-images>.
IMAGES_HELM_CHART_INVALIDES	Fournissez un graphique Helm contenant des images dans les référentiels créés via le type de AddRepositories modification. Images externes :<images-identified>.
HELM_LINT NON VALIDE	Fournissez un graphique Helm qui passe avec succès Helm Lint.
TEMPLATE_HELM_INVALIDE	Fournissez un graphique Helm qui passe avec succès le modèle Helm.
CHARTE_HELM_INVALIDE	Fournissez un tableau de bord conforme aux AWS Marketplace instructions indiquées dans la liste à puces Helm Charts du Guide du AWS Marketplace vendeur.
NOM_ADDON_INVALIDE	Entrez un AddOn nom qui suit le modèle d'expression régulière suivant : xx
ESPACE DE NOMS INVALID_ADDON_	Les valeurs d'espace de noms [invalid_namespaces] ne sont pas valides. L'espace de noms doit suivre l'expression régulière {EKS_ADD_ON_NAMESPACE_REGEX}. Par exemple, namespace, namespace-test.
MODÈLE_NOM_ADDON NON VALIDE	Indiquez un nom complémentaire commençant par une lettre ou un chiffre, puis une combinaison de lettres, de chiffres et de tirets. Par exemple, test-addon, eksaddon
MODÈLE_DE VERSION D'ADDON NON VALIDE	Fournissez une version complémentaire en utilisant le modèle suivant : "<major>. <minor>. <patch>"(par exemple, 1.2.3, 0.1.2, 0.1.1)
IDENTIFIANTS D'OPTION DE LIVRAISON VIDES	Fournissez une liste des identifiants des options de livraison.
OPTION_SAISIE_DE_LIVRAISON NON VALIDE	La liste contient une ou plusieurs options de livraison non valides. Fournissez une liste valide et assurez-vous que chaque option comporte un seul mode de livraison.
OVERRIDE_PARAMETER_KEYS_CONTAINS_SPECIAL_CHARS	Les clés de paramètre de remplacement [invalid_keys] contiennent des caractères non valides. Vos touches ne doivent contenir que des lettres, des chiffres, des guillemets (« ») et des signes plus (+).
REPOSIT_CONTENEUR_IMAGE NON VALIDE	Les référentiels [invalid_repositories] ne sont pas valides. Fournissez des référentiels créés via le type de AddRepositories modification.
FORMAT_CONTENEUR_IMAGE_TAG_INVALIDE	La balise d'image du conteneur [invalid_image_tag] n'est pas valide. Fournissez une balise conforme à l'expression régulière {CONTAINER_IMAGE_TAG_REGEX}.
CLÉS DE PARAMÉTRAGE DUPLIQUÉES	Les paramètres de remplacement contiennent des clés dupliquées [duplicate_keys]. Supprimez les doublons.
UNSUPPORTED_CONTAINER_IMAGE_URI	L'image du conteneur [unsupported_image] n'est pas prise en charge. Fournissez une image qui suit le manifeste d'image V 2, schéma 1.
NOMS_RÉFÉRENTIELS DUPLIQUÉS	Noms de dépôts dupliqués : [duplicate_repo_names]. Fournissez des noms uniques.
NAMESPACE_INVALIDE	Les valeurs d'espace de noms [invalid_namespaces] ne sont pas valides. Fournissez des valeurs conformes à l'expression régulière {HELM_RELEASE_PARAM_REGEX}.
NOM_DE_PUBLICATION NON VALIDE	Les valeurs ReleaseName [invalid_release_names] ne sont pas valides. Fournissez des valeurs conformes à l'expression régulière {HELM_RELEASE_PARAM_REGEX}.
OVERRIDE_PARAMETER_KEYS_CONTAINS_RESERVED_PARAMETER_KEYS	La clé de paramètre de remplacement pour les titres des options de livraison [invalid_keys] est réservée. Clés réservées : [reserved_param_keys]. Fournissez une autre clé.

Mettre à jour la visibilité d'un module complémentaire Amazon EKS

Vous pouvez utiliser l'API du catalogue pour mettre à jour la visibilité d'une option de livraison complémentaire Amazon EKS de la version de votre produit dans AWS Marketplace. Les options Helm de conteneur et de livraison pour votre produit en conteneur sont automatiquement créées avec le statut de visibilité « Public ».

Note

La possibilité de mettre à jour la visibilité de la version de votre produit n'est prise en charge que pour l'option de livraison du module complémentaire Amazon EKS à partir des versions répertoriées. Si votre produit n'est pas déjà « public », envoyez une demande pour publier le produit avec le statut de visibilité « public » en utilisant le Portail de gestion AWS Marketplace.

Par défaut, lorsque vous créez une version avec l'option de livraison du module complémentaire Amazon EKS, elle est publiée avec le statut « Limité ». Le statut « Limité » signifie que le produit n'est pas accessible au public dans toutes les régions pour que vos acheteurs puissent l'utiliser et le déployer dans un cluster Amazon EKS. Vous pouvez mettre à jour la visibilité de l'option de livraison de « Limitée » à « Publique » en appelant l'opération d'StartChangeSetAPI avec le type de UpdateDeliveryOptionsVisibility modification. Spécifiez la version DeliveryOptions Id de votre produit qui correspond à l'option de livraison du module complémentaire Amazon EKS.

Syntaxe de la demande



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

Pour ajouter le type de UpdateDeliveryOptionsVisibility modification, renseignez les champs suivants :

Entity(objet) (obligatoire) — Votre produit basé sur un conteneur.
- Identifier(string) (obligatoire) — L'identifiant de votre produit. Pour de plus amples informations, veuillez consulter Identifiant.
- Type(chaîne) (obligatoire) — Cela Type dépend du mode de livraison (type de produit) utilisé par votre produit :ContainerProduct@1.0.
DetailsDocument(objet) (obligatoire) — Détails de la demande, y compris les informations relatives aux référentiels que vous souhaitez créer. Les champs suivants sont tous obligatoires.
- DeliveryOptions(liste des objets) — Liste des DeliveryOption objets, y compris les détails de chacun :
  - Id(string) — Identifiant unique pourDeliveryOption. (Pour obtenir l'identifiant unique duDeliveryOption, lancez l'DescribeEntityaction sur le produit que vous mettez à jour.
  - TargetVisibility— La nouvelle visibilité prévue du produit.

Syntaxe de réponse

Un ensemble de modifications est créé pour votre demande. La réponse à cette demande vous donne l'ensemble ChangeSetArn de modifications ChangeSetId et de réponses.



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

Vous pouvez vérifier l'état de la demande via ou via le AWS Marketplace Catalog API en utilisant l'opération DescribeChangeSet API. Portail de gestion AWS Marketplace

Erreurs asynchrones

Le tableau suivant indique les erreurs spécifiques aux AddDeliveryOptions actions du AWS Marketplace Catalog API. Ces erreurs sont renvoyées lorsque vous appelez DescribeChangeSet après le traitement d'un ensemble de modifications. Pour plus d'informations sur l'utilisation DescribeChangeSet pour obtenir le statut d'une demande de modification, consultezTravailler avec des ensembles de modifications.

Code d’erreur	Message d’erreur
IDENTIFIANTS D'OPTION DE LIVRAISON VIDES	Fournissez une liste des identifiants des options de livraison.
ÉTAT_DE VISIBILITÉ NON VALIDE	L'`TargetVisibility`option que vous avez fournie n'est pas prise en charge. Veuillez réessayer avec une option autorisée. Les options autorisées sont les suivantes : `Public`
IDENTIFIANT_OPTION_DE_LIVRAISON NON VALIDES	Vous avez fourni des informations sur l'option de livraison non valides. Fournissez les identifiants des options de livraison qui se trouvent dans le produit. Identifiants introuvables : [x]
IDENTIFICATEURS D'OPTIONS DE LIVRAISON DUPLIQUÉS	Identifiants d'option de livraison dupliqués : [duplicate_ids]. Fournissez des identifiants d'option de livraison uniques.
ERREUR_AUDIT	Vous n'avez pas effectué les tests des fournisseurs de logiciels indépendants (ISV) pour toutes les versions de cluster Amazon EKS compatibles avec vos versions complémentaires Amazon EKS. Vous devez effectuer les tests avant que nous puissions publier les options de livraison.
TYPE_OPTION_DE LIVRAISON NON VALIDE	Le type d'option de livraison que vous avez indiqué n'est pas valide. Vérifiez que votre option de livraison est conforme au type : `EksAddOn` puis réessayez.
OBJETS_HELM_INCOMPATIBLES	Fournissez un Helm graphique sans objets non pris en charge : Helm les objets non pris en charge Helm sont les suivants : tous les objets Release (sauf .Name et .Namespace), les Helm hooks et les fonctions de recherche.
NOM_ADDON_INCOMPATIBLE	Le nom du module complémentaire [provided_name] ne correspond pas au nom de la version publique. Mettez à jour le nom public avant de le publier.
TYPE D'ADDON INCOMPATIBLE	Les types de modules complémentaires ne correspondent pas. Réutilisez le type de module complémentaire existant de la version complémentaire publique ou des versions complémentaires précédentes de ce produit. Un seul module complémentaire est pris en charge par produit.
ESPACE DE NOMS INCOMPATIBLE_ADDON_	L'espace de noms du module complémentaire [provided_namespace] fourni ne correspond pas à l'espace de noms de version public. Mettez à jour l'espace de noms du module complémentaire avant de le publier.

Création de référentiels et de ressources

Pour créer une nouvelle version d'un produit basé sur un conteneur, vous devez disposer des ressources correspondant à cette version dans AWS Marketplace des référentiels. Vous créez les référentiels, puis vous envoyez (téléchargez) les ressources Docker (etHelm) dans les référentiels. Pour savoir comment créer les référentiels via le Portail de gestion AWS Marketplace, voir Ajouter une nouvelle version de votre produit dans le Guide du AWS Marketplace vendeur.

Pour créer de nouveaux référentiels, appelez StartChangeSet avec le type de AddRepositories modification, comme indiqué dans l'exemple suivant.

Syntaxe de la demande


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

Fournissez des informations pour les champs permettant d'ajouter le type de AddRepositories modification :

Pour plus d'informations sur la création de référentiels, consultez la section Ajout d'une nouvelle version dans le Guide du AWS Marketplace vendeur.

Entity(objet) (obligatoire) — Votre produit basé sur un conteneur.
- Identifiant (chaîne) (obligatoire) — L'identifiant de votre produit. Pour de plus amples informations, veuillez consulter Identifiant.
- Type(chaîne) (obligatoire) — Cela dépend du mode de livraison (type de produit) que votre produit utilisera :ContainerProduct@1.0. Type
DetailsDocument(objet) (obligatoire) — Détails de la demande. Il inclut les informations relatives aux référentiels que vous souhaitez créer. Les champs inclus sont tous obligatoires.
- Repositories(tableau de structures) — Liste des objets du référentiel. Chaque objet du référentiel inclut un nom et un type.
  - RepositoryName(string) — Le nom du dépôt à créer.
  - RepositoryType(string) — Type du référentiel à créer. La seule valeur autorisée est ECR.

Note

Vous pouvez avoir jusqu'à 70 référentiels par produit, mais vous pouvez ajouter plusieurs ressources et versions de ressources à un seul référentiel en leur attribuant des balises différentes lorsque vous les publiez.

Après avoir créé un ou plusieurs référentiels, vous y ajoutez vos ressources. Pour plus d'informations sur la manière de transférer des ressources vers des référentiels, consultez la section Transmission d'une image dans le guide de l'utilisateur d'Amazon Elastic Container Registry. Pour plus d'informations sur les commandes push spécifiques nécessaires à l'un de vos référentiels, consultez la section Ajout d'une nouvelle version dans le Guide du AWS Marketplace vendeur.

Erreurs asynchrones

Les erreurs suivantes sont spécifiques aux AddRepositories actions du AWS Marketplace Catalog API. Ces erreurs sont renvoyées lorsque vous appelez DescribeChangeSet après le traitement d'un ensemble de modifications. Pour plus d'informations sur l'utilisation DescribeChangeSet pour obtenir le statut d'une demande de modification, consultezTravailler avec des ensembles de modifications.

Code d’erreur	Message d’erreur
NOM_ÉCR_DÉPÔT NON VALIDE	Indiquez le nom du référentiel au format : « nginx-web-app »
DUPLICATE_ECR_REPOSITORY_NAME	Le dépôt [duplicate_repo_names] existe déjà. Choisissez un autre nom.
INFORMATION_DE_REPOSITORY_MANQUANTES	Indiquez au moins un nom de référentiel.
NOM_ÉCR_DÉPÔT NON VALIDE	La longueur maximale de 256 caractères est atteinte. Le nombre de caractères inclut l'espace de noms du vendeur.

Informations de version de mise à jour

Vous pouvez utiliser l'API Catalog pour mettre à jour les détails d'une version existante de votre produit basé sur des conteneurs dans. AWS Marketplace

Note

Lorsqu'un produit est accessible au public, vous ne pouvez pas mettre à jour le titre de la version, les images du conteneur, le titre de l'option de livraison ou les ressources de déploiement de la version. Si vous devez mettre à jour ces aspects d'un produit, créez plutôt une nouvelle version.

Pour mettre à jour une version existante de votre produit basé sur un conteneur, appelez l'opération StartChangeSet API avec le type de UpdateDeliveryOptions modification, comme indiqué dans l'exemple suivant. Cela met à jour les informations détaillées des options de livraison que vous spécifiez, ainsi que de la version associée. Vous devez inclure au moins une option de livraison.

Syntaxe de demande de livraison d'images de conteneur


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

HelmSyntaxe de demande de livraison de graphiques


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

Syntaxe des demandes Add-On de livraison 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}"
                           }
                        ]
                     }
                  }
               }
            ]
         }
      }
   ]
}

Fournissez des informations pour les champs permettant d'ajouter le type de UpdateDeliveryOptions modification :

Pour plus d'informations sur ces champs, consultez la section Ajouter une nouvelle version dans le Guide du AWS Marketplace vendeur.

Entity(objet) (obligatoire) — Votre produit basé sur un conteneur.
- Identifier(string) (obligatoire) — L'identifiant de votre produit. Pour de plus amples informations, veuillez consulter Identifiant.
- Type(chaîne) (obligatoire) — Cela dépend du mode de livraison (type de produit) que votre produit utilisera :ContainerProduct@1.0. Type
DetailsDocument(objet) (obligatoire) — Détails de la demande. Il inclut toutes les informations relatives à la version de votre produit basé sur un conteneur que vous souhaitez mettre à jour. Les champs inclus sont tous facultatifs, mais vous devez inclure au moins un champ pour les mettre à jour.
- Version(object) — Détails sur la version du logiciel.
  - VersionTitle(string) — Le titre de la version que vous créez. Il s'agit généralement d'une description de la version, telle que Version 1.1 ou simplement1.1. Vos acheteurs pourront choisir la version à déployer dans la liste de tous les titres de version.
    
    Cette propriété ne peut pas être mise à jour si le produit est déjà publié publiquement.
  - ReleaseNotes(string) — Notes destinées aux acheteurs pour les informer des modifications apportées d'une version à l'autre.
- DeliveryOptions(liste des objets) — Liste des DeliveryOption objets, y compris les détails de chacun :
  - Id(string) — Identifiant unique pour le DeliveryOption (vous pouvez obtenir l'identifiant unique du DeliveryOption en appelant l'DescribeEntityaction sur le produit que vous mettez à jour).
  - Details(objet) — Contient les détails d'une option de livraison. Notez que cet objet de détails imbriqué n'a pas besoin d'être échappé deux fois.
    
    EcrDeliveryOptionDetails(object) — Détails de l'option de livraison des images du conteneur.
    
    DeliveryOptionTitle(chaîne) — Brève description qui permet à votre acheteur de choisir entre vos options de livraison.
    
    Cette propriété ne peut pas être mise à jour si le produit est déjà publié publiquement.
    
    ContainerImages(tableau de chaînes) — Tableau d'URL d'images de conteneurs utilisé par cette version. Le chemin sera le référentiel dans lequel vous avez chargé l'image, avec le tag correspondant à l'image utilisée par cette version. Si ce champ est inclus, la liste doit inclure toutes les images nécessaires, même les images qui ne changent pas.
    
    Cette propriété ne peut pas être mise à jour si le produit est déjà publié publiquement.
    
    DeploymentResources(ensemble d'objets) : ensemble d'autres ressources de déploiement nécessaires à la version, telles que des liens vers des Helm graphiques ou d'autres documents. Chaque ressource inclut un nom pour la décrire et une URL pointant vers la ressource. Sur la page de lancement de votre version, cela s'affiche sous forme de liste de liens.
    
    Cette propriété ne peut pas être mise à jour si le produit est déjà publié publiquement.
    
    Name(chaîne) — Le texte de l'hyperlien affiché à l'acheteur.
    
    Url(string) — URL du lien hypertexte présenté à l'acheteur.
    
    CompatibleServices(tableau de chaînes) — Ensemble de services avec lesquels la version est compatible. Options valides : ECSEKS,ECS-Anywhere,EKS-Anywhere, etBedrock-AgentCore.
    
    AgenticTypeType d'agent d'exécution. Options valides : AGENTMCP_SERVER, ouA2A_SERVER.
    
    Description(chaîne) — Description plus longue de l'option de livraison pour fournir des informations à votre acheteur. Vous pouvez également inclure un lien vers d'autres instructions hébergées ailleurs.
    
    UsageInstructions(string) — Fournissez des instructions sur le déploiement et l'utilisation de votre produit. Vous pouvez également ajouter un lien vers des instructions d'utilisation hébergées ailleurs. Peut comporter jusqu'à 4 000 caractères.
    
    EnvironmentVariables— Liste des variables d'environnement requises par le conteneur AgentCore Runtime et qui seront préremplies pour les acheteurs lors du déploiement. Pour chaque variable, fournissez un objet avec le nom attendu par votre conteneur, une description et une DefaultValue facultative. Pour les variables telles que les informations d'identification ou les clés d'API qui sont uniques, ne fournissez pas de valeur par défaut. Vous pouvez utiliser la description pour spécifier les détails de la variable ainsi que les valeurs possibles. Toutes les variables fournies avec leurs valeurs par défaut seront préremplies lorsque les acheteurs lanceront votre produit.
  - Id(string) — Identifiant unique pour le DeliveryOption (vous pouvez obtenir l'identifiant unique du DeliveryOption en appelant l'DescribeEntityaction sur le produit que vous mettez à jour).
  - Details(objet) — Contient les détails d'une option de livraison. Notez que cet objet de détails imbriqué n'a pas besoin d'être échappé deux fois.
    
    HelmDeliveryOptionDetails(objet) — Détails de l'option de livraison du Helm graphique.
    
    DeliveryOptionTitle(chaîne) — Brève description qui permet à votre acheteur de choisir entre vos options de livraison.
    
    Cette propriété ne peut pas être mise à jour si le produit est déjà publié publiquement.
    
    ContainerImages(tableau de chaînes) — Tableau d'URL d'images de conteneurs utilisé par cette version. Le chemin sera le référentiel dans lequel vous avez chargé l'image, avec le tag correspondant à l'image utilisée par cette version. La liste doit inclure toutes les images nécessaires, même les images qui n'ont pas changé par rapport aux versions précédentes. Consultez la section suivante pour plus d'informations sur la création de référentiels à l'aide de l'API Catalog.
    
    HelmChartUri(string) — URL du Helm graphique hébergé sur Amazon ECR que l'acheteur installera pour lancer le logiciel.
    
    CompatibleServices(tableau de chaînes) — Ensemble de services avec lesquels la version est compatible. Les options valides sont ECS et EKS.
    
    Description(chaîne) — Description plus longue de l'option de livraison pour fournir des informations à votre acheteur. Vous pouvez également inclure un lien vers d'autres instructions fournies ailleurs.
    
    UsageInstructions(string) — Fournissez des instructions concernant l'utilisation de cette option de livraison. Peut comporter jusqu'à 4 000 caractères.
    
    MarketplaceServiceAccountName(string) — Le nom du compte de Kubernetes service. Le compte de service sera utilisé pour se connecter afin d' Gestion des identités et des accès AWS obtenir l'autorisation d'appeler les AWS services.
    
    ReleaseName(chaîne) — Le nom de la Helm version fourni à la helm install commande que les acheteurs utilisent pour lancer le logiciel.
    
    Namespace(string) — L'espace de Kubernetes noms dans lequel le Helm graphique sera installé.
    
    OverrideParameters(tableau d'objets) — Paramètres qui seront utilisés dans les Helm commandes qui lancent l'application. Les acheteurs peuvent modifier les valeurs par défaut.
    
    Key(string) — La clé du paramètre en notation par points (override.example.key).
    
    DefaultValue(string) — La valeur par défaut de ce paramètre de remplacement.

Syntaxe de réponse

Un ensemble de modifications est créé pour votre demande. La réponse à cette demande vous donne l'ChangeSetIdensemble ChangeSetArn de modifications et ressemble à ce qui suit.


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

Vous pouvez vérifier l'état de la demande via ou directement via l' Portail de gestion AWS Marketplace API Catalog à l'aide de l'opération DescribeChangeSet API.

Erreurs asynchrones

Les erreurs suivantes sont spécifiques aux UpdateDeliveryOptions actions du AWS Marketplace Catalog API. Ces erreurs sont renvoyées lorsque vous appelez DescribeChangeSet après le traitement d'un ensemble de modifications. Pour plus d'informations sur l'utilisation DescribeChangeSet pour obtenir le statut d'une demande de modification, consultezTravailler avec des ensembles de modifications.

Code d’erreur	Message d’erreur
ÉTAT_DU PRODUIT INCOMPATIBLE	Utilisez un produit limité ou public existant.
SERVICES_INCOMPATIBLES	La liste des services contient des services incompatibles. [incompatible_services] Fournissez une liste valide de services compatibles.
AUCUN SERVICE SPÉCIFIÉ	Fournissez au moins un service compatible.
DUPLICATE_COMPATIBLE_AWS_SERVICES	La liste des services contient des entrées dupliquées. Retirez-les. Chaque entrée doit être unique.
TITRE_DE LA VERSION NON VALIDE	Supprimez les espaces devant le symbole de marque.
TITRE_DE LA VERSION NON VALIDE	Supprimez les caractères non pris en charge suivants : [x, y, z]
TITRE_DE LA VERSION NON VALIDE	Supprimez les espaces au début du titre de la version.
TITRE_DE LA VERSION NON VALIDE	Indiquez le titre de la version contenant moins de [x] caractères.
TITRE_DE_VERSION DUPLIQUÉ	Le titre de la version [duplicate_version_title] est un doublon. Supprimez ou modifiez le titre.
NOTES_DE_PUBLICATION NON VALIDES	Supprimez les espaces devant le symbole de marque.
NOTES_DE_PUBLICATION NON VALIDES	Supprimer les caractères non pris en charge : [x, y, z]
NOTES_DE_PUBLICATION NON VALIDES	Supprimez les espaces au début des notes de publication.
NOTES_DE_PUBLICATION NON VALIDES	Fournissez des notes de version contenant moins de (x) caractères.
INSTRUCTIONS D'UTILISATION NON VALIDES	Supprimez les espaces devant le symbole de marque.
INSTRUCTIONS D'UTILISATION NON VALIDES	Supprimer les caractères non pris en charge : [x, y, z]
INSTRUCTIONS D'UTILISATION NON VALIDES	Fournissez des instructions d'utilisation contenant moins de (x) caractères.
INSTRUCTIONS D'UTILISATION NON VALIDES	Fournissez des instructions d'utilisation.
IMAGES_CONTENEUR_MANQUANTES	Fournissez au moins une image du conteneur.
TROP D'IMAGES_CONTENEUR_D'IMAGES	Fournissez moins de 50 images de conteneurs.
IMAGES_CONTENEUR_DUPLIQUÉES	La liste des images du conteneur contient des images dupliquées : [duplicate_images]. Fournissez une liste d'images uniques.
IMAGES_CONTENEUR_INVALIDES	Fournissez un URI valide pour l'image du conteneur.
INVALID_CONTAINER_IMAGE_URI	L'image [invalid_image_uri] n'a pas accès à ce produit. Téléchargez l'image dans le référentiel de produits correspondant. Pour plus d'informations sur le téléchargement, voir Commencer à utiliser les produits conteneurisés.
IMAGE_CONTENEUR_TAG NON VALIDE	Évitez d'utiliser le tag « dernier ».
IDENTIFIANT_OPTION_DE_LIVRAISON MANQUANTS	Fournissez une option de livraison à partir de la liste d'identifiants existante.
IDENTIFIANTS D'OPTION DE LIVRAISON VIDES	Fournissez une liste non vide d'identifiants d'options de livraison.
IDENTIFICATEURS D'OPTIONS DE LIVRAISON DUPLIQUÉS	Identifiants d'option de livraison dupliqués : [duplicate_ids]. Fournissez des identifiants d'option de livraison uniques.
TITRES D'OPTIONS DE LIVRAISON DUPLIQUÉS	Titres des options de livraison dupliqués : [duplicate_titles]. Supprimer les doublons
TITRES_OPTION_DE LIVRAISON NON VALIDES	Les titres des options de livraison [existing_titles] existent déjà. Entrez un autre titre.
TITRE_OPTION_D'EXPÉDITION NON VALIDE	Indiquez le titre de l'option de livraison contenant moins de (x) caractères.
NOM_RESSOURCE_VIDE	Indiquez le nom de la ressource.
URL DE RESSOURCE_VIDE	Fournissez l'URL de la ressource.
NOM_RESSOURCE NON VALIDE	Indiquez le nom de la ressource contenant moins de 256 caractères.
URL_RESSOURCE NON VALIDE	Indiquez l'URL de la ressource contenant moins de 256 caractères.
DESCRIPTION_COURTE NON VALIDE	Fournissez une brève description de moins de 1 000 caractères.
DESCRIPTION_COURTE NON VALIDE	Fournissez une brève description.
AUCUNE CLÉ SECRÈTE DE LICENCE	Pour les produits Amazon EKS Anywhere, fournissez un paramètre de remplacement pour le secret de licence. Besoins `DefaultValue` de`"${AWSMP_LICENSE_SECRET}"`, voir l'exemple dans la section.
AUCUNE CONFIGURATION DE COMPTE DE SERVICE	Pour les produits payants, fournissez 1 paramètre de remplacement pour la configuration du compte de service. Besoins `DefaultValue` de`"${AWSMP_SERVICE_ACCOUNT}"`, voir l'exemple dans la section.
ERREUR DE NUMÉRISATION	Corrigez la vulnérabilité de sécurité «" [y] "» sur l'image «" [x] "».
LE CHAMP N'EST PAS AUTORISÉ À CHANGER	Le champ [x] ne peut pas être modifié.
OPTION_DE_LIVRAISON_STATUS NON VALIDE	Les identifiants de l'option de livraison [invalid_ids] ne sont pas valides. Offrez des options de livraison dans un État limité ou public.
AUCUNE MODIFICATION TROUVÉE	Fournissez au moins une modification.
MISE À JOUR DE PLUSIEURS VERSIONS	Fournissez les identifiants des options de livraison de la même version.
OVERRIDE_PARAMETER_KEYS_CONTAINS_SPECIAL_CHARS	Les clés de paramètre de remplacement [invalid_keys] contiennent des caractères non valides. Vos touches ne doivent contenir que des lettres, des chiffres, des guillemets (« ») et des signes plus (+).
REPOSIT_CONTENEUR_IMAGE NON VALIDE	Les référentiels [invalid_repositories] ne sont pas valides. Fournissez des référentiels créés via le type de AddRepositories modification.
FORMAT_CONTENEUR_IMAGE_TAG_INVALIDE	La balise d'image du conteneur [invalid_image_tag] n'est pas valide. Fournissez une balise conforme à l'expression régulière {CONTAINER_IMAGE_TAG_REGEX}.
CLÉS DE PARAMÉTRAGE DUPLIQUÉES	Les paramètres de remplacement contiennent des clés dupliquées [duplicate_keys]. Supprimez les doublons.
UNSUPPORTED_CONTAINER_IMAGE_URI	L'image du conteneur [unsupported_image] n'est pas prise en charge. Fournissez une image qui suit le manifeste d'image V 2, schéma 1.
NAMESPACE_INVALIDE	Les valeurs d'espace de noms [invalid_namespaces] ne sont pas valides. Fournissez des valeurs conformes à l'expression régulière {HELM_RELEASE_PARAM_REGEX}.
NOM_DE_PUBLICATION NON VALIDE	Les valeurs ReleaseName [invalid_release_names] ne sont pas valides. Fournissez des valeurs conformes à l'expression régulière {HELM_RELEASE_PARAM_REGEX}.
OVERRIDE_PARAMETER_KEYS_CONTAINS_RESERVED_PARAMETER_KEYS	La clé de paramètre de remplacement pour les titres des options de livraison [invalid_keys] est réservée. Clés réservées : [reserved_param_keys]. Fournissez une autre clé.
NOM_ADDON_INCOMPATIBLE	Le nom du module complémentaire [provided_name] ne correspond pas au nom existant. Réutilisez le nom existant de la version publique ou des versions précédentes de ce module complémentaire. Vous ne pouvez utiliser qu'un seul nom d'extension pour chaque produit.
ESPACE DE NOMS INCOMPATIBLE_ADDON_	L'espace de noms du module complémentaire [provided_namespace] ne correspond pas à l'espace de noms existant. Réutilisez l'espace de noms existant de la version publique ou des versions précédentes de ce module complémentaire. Vous ne pouvez utiliser qu'un seul espace de noms d'extension pour chaque produit.

Restreindre une version

Vous pouvez utiliser l'API Catalog pour restreindre une version de votre produit basé sur un conteneur dans. AWS Marketplace Cela empêche les nouveaux acheteurs d'utiliser cette version. Il doit y avoir au moins une version accessible au public dans un produit. Vous ne pouvez pas restreindre la seule version accessible au public restante pour un produit.

Pour restreindre une version, appelez l'opération StartChangeSet API avec le type de RestrictDeliveryOptions modification, comme indiqué dans l'exemple suivant.

Note

Le fait de restreindre une ou plusieurs options de livraison d'une version, mais pas toutes, empêchera ces options d'être disponibles pour vos acheteurs. Le fait de restreindre toutes les options de livraison pour une version supprimera cette version du AWS Marketplace catalogue.

La restriction d'un module complémentaire Amazon EKS n'est actuellement pas prise en charge par le biais de l'API Catalog.

Les versions restreintes sont toujours disponibles pour les clients existants.

Syntaxe de la demande


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

Fournissez des informations pour les champs permettant d'ajouter le type de RestrictDeliveryOptions modification :

Entity(objet) (obligatoire) — Votre produit basé sur un conteneur.
- Identifier(string) (obligatoire) — L'identifiant de votre produit. Pour de plus amples informations, veuillez consulter Identifiant.
- Type(chaîne) (obligatoire) — Cela dépend du mode de livraison (type de produit) que votre produit utilisera :ContainerProduct@1.0. Type
DetailsDocument(objet) (obligatoire) — Détails de la demande. Il inclut les identifiants des options de livraison de votre produit en conteneur que vous souhaitez restreindre.
- DeliveryOptionIds(tableau de chaînes) — Liste des DeliveryOption identifiants des versions que vous souhaitez restreindre. Vous pouvez obtenir l'identifiant unique du DeliveryOption en appelant l'DescribeEntityaction sur le produit que vous limitez.

Syntaxe de réponse

Un ensemble de modifications est créé pour votre demande. La réponse à cette demande vous donne l'ChangeSetIdensemble ChangeSetArn de modifications et ressemble à ce qui suit.


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

La demande de modification est ajoutée à une file d'attente et traitée. Ce processus peut prendre de quelques minutes à quelques heures.

Vous pouvez vérifier l'état de la demande via ou directement via l' Portail de gestion AWS Marketplace API Catalog à l'aide de l'opération DescribeChangeSet API.

Erreurs asynchrones

Les erreurs suivantes sont spécifiques aux RestrictDeliveryOptions actions du AWS Marketplace Catalog API. Ces erreurs sont renvoyées lorsque vous appelez DescribeChangeSet après le traitement d'un ensemble de modifications. Pour plus d'informations sur l'utilisation DescribeChangeSet pour obtenir le statut d'une demande de modification, consultezTravailler avec des ensembles de modifications.

Code d’erreur	Message d’erreur
ÉTAT_DU PRODUIT INCOMPATIBLE	Utilisez un produit public.
IDENTIFIANT_OPTION_DE_LIVRAISON MANQUANTS	Fournissez une option de livraison à partir de la liste d'identifiants existante.
OPTION_DE_LIVRAISON_STATUS NON VALIDE	Les identifiants de l'option de livraison [invalid_ids] ne sont pas valides. Fournir des options de livraison dans l'État public.
IDENTIFIANTS D'OPTION DE LIVRAISON VIDES	Fournissez une liste non vide d'identifiants d'options de livraison.
OPTIONS DE LIVRAISON PUBLIQUES MINIMALES NON VALIDES	Impossible de restreindre tous les identifiants d'options de livraison.
IDENTIFICATEURS D'OPTIONS DE LIVRAISON DUPLIQUÉS	Identifiants d'option de livraison dupliqués : [duplicate_ids]. Fournissez des identifiants d'option de livraison uniques.

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

Travaillez avec les composants EC2 Image Builder

Travaillez avec des produits SaaS