L'AWS Marketplace API Reference è stato ristrutturato. Per ulteriori informazioni sulle operazioni API supportate, consulta l'AWS Marketplace API Reference.

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Lavora con prodotti basati su container utilizzando Marketplace AWS API

Puoi utilizzare l'API Marketplace AWS Catalog per automatizzare le attività relative all'utilizzo di prodotti basati su contenitori.

Per informazioni sulla creazione di un prodotto basato su contenitori utilizzando l'API Catalog, consulta. Crea un prodotto

I seguenti argomenti descrivono come utilizzare l'API Catalog per eseguire azioni sui prodotti basati su contenitori:

Aggiungi una nuova versione

Se disponi già di un prodotto basato su container Marketplace AWS, puoi utilizzarlo AWS Marketplace Catalog API per aggiungere una nuova versione. Ciò richiede che abbiate già creato dei repository Marketplace AWS per ogni immagine o elemento del contenitore che fa parte del prodotto e che possiate copiarli dal locale e dai file. Docker Helm

Per aggiungere una nuova versione, richiamate l'operazione StartChangeSet API con il tipo di AddDeliveryOptions modifica, come illustrato nell'esempio seguente.

Sintassi della richiesta di consegna delle immagini del contenitore

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

Sintassi della richiesta di consegna AgentCore di Amazon Bedrock Runtime

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

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

HelmSintassi della richiesta di consegna del grafico

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

Sintassi della richiesta Add-On di consegna di 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"
    }
  ]
}

Fornisci informazioni sui campi per aggiungere il tipo di AddDeliveryOptions modifica:

Sintassi della risposta

Viene creato un set di modifiche per la richiesta. La risposta a questa richiesta fornisce l'ChangeSetIde ChangeSetArn per il set di modifiche ed è simile alla seguente.

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

La richiesta di modifica viene aggiunta a una coda ed elaborata, inclusa la scansione delle immagini del contenitore e di altre informazioni per garantire che soddisfi le Marketplace AWS linee guida per i prodotti in contenitore. Questo processo può richiedere da alcuni minuti a ore, a seconda del numero e delle dimensioni dei contenitori.

Puoi controllare lo stato della richiesta tramite o direttamente tramite l' Portale di gestione Marketplace AWS API Catalog utilizzando l'operazione DescribeChangeSet API.

Per ulteriori informazioni sui set di modifiche, consulta Utilizzo dei set di modifiche. Per maggiori informazioni sugli errori nei set di modifiche ai prodotti del venditore, consultaModifica lo stato e gli errori del set.

Errori asincroni

I seguenti errori sono specifici AddDeliveryOptions delle azioni in. AWS Marketplace Catalog API Questi errori vengono restituiti quando si chiama DescribeChangeSet dopo l'elaborazione di un set di modifiche. Per ulteriori informazioni sull'utilizzo DescribeChangeSet per ottenere lo stato di una richiesta di modifica, vedereUtilizzo dei set di modifiche.

Aggiorna la visibilità per un componente aggiuntivo Amazon EKS

Puoi utilizzare l'API Catalog per aggiornare la visibilità di un'opzione di distribuzione aggiuntiva Amazon EKS della versione del prodotto in Marketplace AWS. Le opzioni Helm di container e spedizione per il tuo prodotto in container vengono create automaticamente con lo stato di visibilità «Pubblico».

Per impostazione predefinita, quando crei una versione con l'opzione di distribuzione del componente aggiuntivo Amazon EKS, viene pubblicata con lo stato «Limitato». Lo stato «Limitato» significa che il prodotto non è disponibile al pubblico in tutte le regioni per essere utilizzato e distribuito dagli acquirenti in un cluster Amazon EKS. Puoi aggiornare la visibilità dell'opzione di consegna da «Limitata» a «Pubblica» chiamando l'operatore dell'StartChangeSetAPI con il tipo di UpdateDeliveryOptionsVisibility modifica. DeliveryOptions IdSpecificate la versione del prodotto che corrisponde all'opzione di consegna del componente aggiuntivo Amazon EKS.

Sintassi della richiesta

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

Per aggiungere il tipo di UpdateDeliveryOptionsVisibility modifica, fornisci informazioni per i seguenti campi:

Sintassi della risposta

Viene creato un set di modifiche per la richiesta. La risposta a questa richiesta fornisce l'ChangeSetIde ChangeSetArn per il set di modifiche.

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

La richiesta di modifica viene aggiunta a una coda ed elaborata, inclusa la scansione delle immagini del contenitore e di altre informazioni per garantire che soddisfi le Marketplace AWS linee guida per i prodotti in contenitore. Questo processo può richiedere da alcuni minuti a ore, a seconda del numero e delle dimensioni dei contenitori.

Puoi controllare lo stato della richiesta tramite o AWS Marketplace Catalog API tramite l'operazione DescribeChangeSet API. Portale di gestione Marketplace AWS

Per ulteriori informazioni sui set di modifiche, consulta Utilizzo dei set di modifiche. Per maggiori informazioni sugli errori nei set di modifiche ai prodotti del venditore, consultaModifica lo stato e gli errori del set.

Errori asincroni

La tabella seguente mostra gli errori specifici delle AddDeliveryOptions azioni in. AWS Marketplace Catalog API Questi errori vengono restituiti quando si chiama DescribeChangeSet dopo l'elaborazione di un set di modifiche. Per ulteriori informazioni sull'utilizzo DescribeChangeSet per ottenere lo stato di una richiesta di modifica, vedereUtilizzo dei set di modifiche.

Crea repository e risorse

Per creare una nuova versione di un prodotto basato su contenitori, è necessario disporre delle risorse per la versione disponibili nei repository. Marketplace AWS Crei i repository e poi inserisci (carica) le Docker (eHelm) risorse nei repository. Per informazioni su come creare gli archivi tramite Portale di gestione Marketplace AWS, consulta Aggiungere una nuova versione del prodotto nella Guida al Marketplace AWS venditore.

Per creare nuovi repository, richiamate StartChangeSet specificando il tipo di AddRepositories modifica, come illustrato nell'esempio seguente.

Sintassi della richiesta

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

Fornisci informazioni sui campi in cui aggiungere il tipo di AddRepositories modifica:

Per maggiori informazioni sulla creazione di repository, consulta Aggiungere una nuova versione nella Guida al Marketplace AWS venditore.

Dopo aver creato uno o più repository, aggiungi le tue risorse ai repository. Per informazioni su come inviare risorse ai repository, consulta Pushing an image nella Amazon Elastic Container Registry User Guide. Per informazioni sui comandi push specifici necessari per uno dei tuoi repository, consulta Aggiungere una nuova versione nella Seller Guide.Marketplace AWS

Errori asincroni

I seguenti errori sono specifici AddRepositories delle azioni in. AWS Marketplace Catalog API Questi errori vengono restituiti quando si chiama DescribeChangeSet dopo l'elaborazione di un set di modifiche. Per ulteriori informazioni sull'utilizzo DescribeChangeSet per ottenere lo stato di una richiesta di modifica, vedereUtilizzo dei set di modifiche.

Aggiorna le informazioni sulla versione

Puoi utilizzare l'API Catalog per aggiornare i dettagli di una versione esistente del tuo prodotto basato su contenitori in. Marketplace AWS

Per aggiornare una versione esistente del prodotto basato su contenitori, richiama l'operazione StartChangeSet API con il tipo di UpdateDeliveryOptions modifica, come illustrato nell'esempio seguente. Ciò aggiorna le informazioni dettagliate per le opzioni di consegna specificate, nonché la versione associata. È necessario includere almeno un'opzione di consegna.

Sintassi della richiesta di consegna delle immagini del contenitore

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

HelmSintassi della richiesta di consegna del grafico

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

Sintassi della richiesta Add-On di consegna di 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}"
                           }
                        ]
                     }
                  }
               }
            ]
         }
      }
   ]
}

Fornisci informazioni sui campi per aggiungere il tipo di UpdateDeliveryOptions modifica:

Per maggiori informazioni su questi campi, consulta Aggiungere una nuova versione nella Guida al Marketplace AWS venditore.

Sintassi della risposta

Viene creato un set di modifiche per la richiesta. La risposta a questa richiesta fornisce l'ChangeSetIde ChangeSetArn per il set di modifiche ed è simile alla seguente.

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

La richiesta di modifica viene aggiunta a una coda ed elaborata, inclusa la scansione delle immagini del contenitore e di altre informazioni per garantire che soddisfi le Marketplace AWS linee guida per i prodotti in contenitore. Questo processo può richiedere da alcuni minuti a ore, a seconda del numero e delle dimensioni dei contenitori.

Puoi controllare lo stato della richiesta tramite o direttamente tramite l' Portale di gestione Marketplace AWS API Catalog utilizzando l'operazione DescribeChangeSet API.

Per ulteriori informazioni sui set di modifiche, consulta Utilizzo dei set di modifiche. Per maggiori informazioni sugli errori nei set di modifiche ai prodotti del venditore, consultaModifica lo stato e gli errori del set.

Errori asincroni

I seguenti errori sono specifici UpdateDeliveryOptions delle azioni in. AWS Marketplace Catalog API Questi errori vengono restituiti quando si chiama DescribeChangeSet dopo l'elaborazione di un set di modifiche. Per ulteriori informazioni sull'utilizzo DescribeChangeSet per ottenere lo stato di una richiesta di modifica, vedereUtilizzo dei set di modifiche.

Limita una versione

Puoi utilizzare l'API Catalog per limitare una versione del tuo prodotto basato su contenitori. Marketplace AWS Ciò impedisce ai nuovi acquirenti di utilizzare quella versione. In un prodotto deve essere presente almeno una versione disponibile al pubblico. Non è possibile limitare l'unica versione disponibile pubblicamente rimasta per un prodotto.

Per limitare una versione, chiamate l'operazione StartChangeSet API con il tipo di RestrictDeliveryOptions modifica, come illustrato nell'esempio seguente.

Sintassi della richiesta

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

Fornisci informazioni sui campi per aggiungere il tipo di RestrictDeliveryOptions modifica:

Sintassi della risposta

Viene creato un set di modifiche per la richiesta. La risposta a questa richiesta fornisce l'ChangeSetIde ChangeSetArn per il set di modifiche ed è simile alla seguente.

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

La richiesta di modifica viene aggiunta a una coda ed elaborata. Questo processo può richiedere da alcuni minuti a ore.

Puoi controllare lo stato della richiesta tramite o direttamente tramite l' Portale di gestione Marketplace AWS API Catalog utilizzando l'operazione DescribeChangeSet API.

Per ulteriori informazioni sui set di modifiche, consulta Utilizzo dei set di modifiche. Per maggiori informazioni sugli errori nei set di modifiche ai prodotti del venditore, consultaModifica lo stato e gli errori del set.

Errori asincroni

I seguenti errori sono specifici RestrictDeliveryOptions delle azioni in. AWS Marketplace Catalog API Questi errori vengono restituiti quando si chiama DescribeChangeSet dopo l'elaborazione di un set di modifiche. Per ulteriori informazioni sull'utilizzo DescribeChangeSet per ottenere lo stato di una richiesta di modifica, vedereUtilizzo dei set di modifiche.