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 i prodotti del venditore

Puoi utilizzarlo AWS Marketplace Catalog API per automatizzare le attività relative all'utilizzo dei prodotti del venditore. Ciò include la possibilità di creare, aggiornare, visualizzare, elencare e ordinare i prodotti. Ciò consente di automatizzare la gestione dei prodotti. Ad esempio, è possibile fornire funzionalità di pubblicazione self-service su. Portale di gestione Marketplace AWS

Un prodotto è un'unità o una risorsa che intendi vendere Marketplace AWS, spesso definita prodotto di base. Gli acquirenti non possono utilizzare un prodotto di base finché non aggiungono informazioni sul prodotto, attributi di distribuzione e dati di fatturazione.

Un prodotto descrive le informazioni sul prodotto, gli attributi di distribuzione del software e il meccanismo di fatturazione dell'inserzione che intendi vendere. Il prodotto deve essere abbinato a un'offerta per diventare un'unità negoziabile che puoi vendere e utilizzare per gli acquirenti. Marketplace AWS

Puoi anche utilizzare il file per: AWS Marketplace Catalog API

Ogni tipo di prodotto ha un'entità di prodotto diversa. Un'entità può essere un prodotto o un'offerta su Marketplace AWS. Sono supportati i seguenti tipi di prodotto ed entità:

I seguenti argomenti presuppongono che tu abbia accesso all'API e che tu abbia completato tutti i prerequisiti per il venditore, come descritto inControllo degli accessi per Marketplace AWS Catalogo API.

Consulta le seguenti risorse:

I seguenti argomenti descrivono come utilizzare l'API Catalog per eseguire azioni sui prodotti con AMI singola, sui prodotti basati su container o sui prodotti SaaS.

Crea un prodotto

Puoi utilizzare l'API Catalog per creare un documento di prodotto AMI, contenitore, machine learning o SaaS con identificatori (codice prodotto e ID prodotto) in. Marketplace AWS

È possibile creare un prodotto nello Draft stato richiamando l'operazione StartChangeSet API con il tipo di CreateProduct modifica.

Se la tua richiesta viene elaborata correttamente, AWS Marketplace Catalog API genera automaticamente Draft un prodotto disponibile. Si tratta di un prodotto incompleto e non è visibile agli acquirenti in Marketplace AWS.

Utilizza quindi i tipi di Update modifica per completare il processo di creazione del prodotto: UpdateInformationUpdateDimensions, UpdateTargeting, e UpdateVisibility.

Una volta completato il prodotto, puoi utilizzare il tipo di ReleaseProductmodifica per completare il processo di creazione del prodotto e quindi rilasciare l'offerta. Questo processo convalida l'intero prodotto e sposta il prodotto allo Limited stato.

Per creare un prodotto nello Draft stato, chiamate l'operazione StartChangeSet API con il tipo di CreateProduct modifica, come illustrato nell'esempio seguente.

Sintassi della richiesta

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

{
"Catalog": "AWSMarketplace",
"ChangeSet": [ 
  { 
    "ChangeType":"CreateProduct",
    "Entity":{
      "Type": "SaaSProduct@1.0" // choose from ["AmiProduct@1.0", "ContainerProduct@1.0", "SaaSProduct@1.0", "MachineLearningProduct@1.0"]
     },
     "DetailsDocument": {
        "ProductTitle": "Test product title set in CreateProduct"
     }
  }
]
}

Fornisci informazioni sui campi per aggiungere il tipo di CreateProduct modifica. Questo tipo di modifica può includere un ProductTitle attributo, soggetto alle stesse restrizioni applicate al tipo di UpdateInformation 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.

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

Quando la richiesta è completa (se lo Status èSUCCEEDED), ne ProductId viene generata una nuova.

Validazioni sincrone

Le convalide dello schema seguenti sono specifiche delle CreateProduct azioni in. AWS Marketplace Catalog API Queste convalide vengono eseguite quando si chiama. StartChangeSet Se la richiesta non soddisfa i seguenti requisiti, avrà esito negativo con una risposta HTTP.

Errori asincroni

I seguenti errori sono specifici CreateProduct 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 dettagli sull'utilizzo DescribeChangeSet per ottenere lo stato di una richiesta di modifica, consultaUtilizzo dei set di modifiche.

Aggiorna i dettagli del prodotto

Se hai già un prodotto Marketplace AWS, puoi utilizzare l'API Catalog per aggiornare i dettagli del prodotto per un prodotto AMI, container, ML o SaaS.

Per aggiornare i dettagli del prodotto, richiama l'operazione StartChangeSet API con il tipo di UpdateInformation modifica e i dettagli che desideri modificare, come mostrato nell'esempio seguente.

Sintassi della richiesta

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateInformation",
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "AmiProduct@1.0"
      },
      "DetailsDocument":
      {
        "ProductTitle": "My Product Title",
        "ShortDescription": "My product short description.",
        "LongDescription": "My product longer description.",
        "Sku": "123example456",
        "LogoUrl": "https://awsmp-logos.s3.amazonaws.com/ca60b754fe05a24257176cdbf31c4e0d",
        "VideoUrls":
        [
          "https://example.com/my-video"
        ],
        "Highlights":
        [
          "123example45"
        ],
        "AdditionalResources":
        [
          {
            "Text": "123example456",
            "Url": "https://example.com/some-link"
          }
        ],
        "SupportDescription": "Need help? Contact our experts at support@example.com \n\nYour purchase includes 24x7 support.",
        "Categories":
        [
          "Operating Systems",
          "Network Infrastructure",
          "Application Development"
        ],
        "SearchKeywords":
        [
          "123example456"
        ]
      }
    }
  ]
}

Fornisci informazioni sui campi in cui aggiungere il tipo di UpdateInformation 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.

Per verificare lo stato della richiesta, usa Portale di gestione Marketplace AWS o chiama l'DescribeChangeSetAPI.

Convalide sincrone

Le convalide dello schema seguenti sono specifiche delle UpdateInformation azioni in. AWS Marketplace Catalog API Queste convalide vengono eseguite quando si chiama. StartChangeSet Se la richiesta non soddisfa i seguenti requisiti, avrà esito negativo con una risposta HTTP.

Errori asincroni

I seguenti errori sono specifici UpdateInformation 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.

Aggiungi dimensioni di prezzo

Puoi utilizzare AWS Marketplace Catalog Service Actions per aggiungere dimensioni di prezzo fatturabili che consentano di addebitare agli utenti prodotti AMI, container o SaaS.

Una dimensione relativa ai prezzi è un'unità di misura che i venditori definiscono per addebitare gli acquirenti. I venditori devono impostare queste informazioni per fatturare agli acquirenti l'utilizzo del prodotto, indipendentemente dal fatto che si tratti di un modello di prezzo basato sull'utilizzo o basato sul contratto. Il tipo di dimensione dipende dal modello di prezzo del prodotto.

Per ulteriori informazioni sui prezzi dei prodotti, consulta i seguenti argomenti nella Guida al Marketplace AWS venditore:

Per maggiori informazioni sull'aggiunta di dimensioni di prezzo utilizzando il Portale di gestione Marketplace AWS, consulta i seguenti argomenti nella Guida al Marketplace AWS venditore:

Per aggiungere dimensioni di prezzo, chiama l'StartChangeSetAPI con il tipo di AddDimensions modifica, come illustrato nell'esempio seguente.

Sintassi della richiesta

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "AddDimensions",
      "DetailsDocument":
      [
        {
          "Description": "Description of the dimension",
          "Key": "UniqueApiKey",
          "Unit": "HostHrs",
          "Name": "First Dimension",
          "Types":
          [
            "ExternallyMetered"
          ]
        }
      ],
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "SaaSProduct@1.0"
      }
    }
  ]
}

Fornisci i seguenti campi per il tipo di AddDimensions 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. Ciò include la convalida delle informazioni per garantire che soddisfino le linee guida. Marketplace AWS Il processo di convalida può richiedere da pochi minuti a qualche ora.

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

Convalide sincrone

Le convalide dello schema seguenti sono specifiche delle AddDimensions azioni in. AWS Marketplace Catalog API Queste convalide vengono eseguite quando si chiama. StartChangeSet Se la richiesta non soddisfa i seguenti requisiti, avrà esito negativo con una risposta HTTP.

Errori asincroni

I seguenti errori sono specifici AddDimensions 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 dimensioni dei prezzi

Puoi utilizzare l'API Catalog per aggiornare le dimensioni dei prezzi esistenti di un AMI, un contenitore o un prodotto SaaS in. Marketplace AWS

Ogni dimensione è identificata in modo univoco dalla chiave e dai tipi di dimensione utilizzati per eseguire l'aggiornamento. L'aggiornamento di una dimensione non influisce sulle offerte attive o sui clienti creati dalla dimensione originale.

Per aggiornare le dimensioni dei prezzi, richiama l'operazione StartChangeSet API con il tipo di UpdateDimensions modifica, come illustrato nell'esempio seguente.

Sintassi della richiesta

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateDimensions",
      "DetailsDocument":
      [
        {
          "Key": "UniqueApiKey",
          "Types":
          [
            "ExternallyMetered"
          ],
          "Name": "First Dimension",
          "Description": "Description of the dimension"
        }
      ],
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "SaaSProduct@1.0"
      }
    }
  ]
}

Utilizza i seguenti campi con il tipo di UpdateDimensions 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. Ciò ha incluso la convalida delle informazioni per garantire che soddisfino le Marketplace AWS linee guida. Il processo di convalida può richiedere da pochi minuti a qualche ora.

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

Convalide sincrone

Le convalide dello schema seguenti sono specifiche delle UpdateDimensions azioni in. AWS Marketplace Catalog API Queste convalide vengono eseguite quando si chiama. StartChangeSet Se la richiesta non soddisfa i seguenti requisiti, avrà esito negativo con una risposta HTTP.

Errori asincroni

I seguenti errori sono specifici UpdateDimensions 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 le dimensioni dei prezzi

Puoi utilizzare l'API Catalog per limitare le dimensioni di prezzo esistenti di un prodotto AMI o SaaS. Marketplace AWS

Ogni dimensione è identificata in modo univoco dalla chiave e dai tipi di dimensione utilizzati per eseguire l'aggiornamento. La limitazione di una dimensione non influisce sulle offerte attive o sui clienti creati dalla dimensione originale.

Per limitare le dimensioni dei prezzi, chiama l'StartChangeSetAPI con il tipo di RestrictDimensions modifica.

L'esempio seguente mostra come limitare la Entitled dimensione per un prodotto SaaS.

Sintassi della richiesta

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "RestrictDimensions",
      "DetailsDocument":
      [
        {
          "Key": "UniqueApiKey",
          "Types": ["Entitled"]
        }
      ],
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "SaaSProduct@1.0"
      }
    }
  ]
}

Utilizza i seguenti campi con il tipo di RestrictDimensions 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. Ciò ha incluso la convalida delle informazioni per garantire che soddisfino le Marketplace AWS linee guida. Il processo di convalida può richiedere da pochi minuti a qualche ora.

Puoi controllare lo stato della richiesta tramite o chiamando l'DescribeChangeSetAPI. Portale di gestione Marketplace AWS

Convalide sincrone

Le convalide dello schema seguenti sono specifiche delle RestrictDimensions azioni in. AWS Marketplace Catalog API Queste convalide vengono eseguite quando si chiama. StartChangeSet Se la richiesta non soddisfa i seguenti requisiti, avrà esito negativo con una risposta HTTP.

Errori asincroni

I seguenti errori sono specifici RestrictDimensions delle azioni in. AWS Marketplace Catalog API Questi errori vengono restituiti quando si chiama DescribeChangeSet durante 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 configurazione del targeting

Puoi utilizzare l'API Catalog per aggiungere Account AWS ID autorizzati a visualizzare il prodotto AMI, container, ML o SaaS Marketplace AWS prima che venga spostato in uno Public stato chiamando il tipo di UpdateTargeting modifica.

Gli account Managed Catalog Operations (MCO) vengono aggiunti automaticamente all'elenco degli account consentiti quando vengono creati nuovi prodotti. Questi account MCO sono visibili ai venditori nel Marketplace AWS Management Portal (AMMP) durante la visualizzazione degli account consentiti e nella Targeting sezione della risposta API. DescribeEntity

Per aggiungere Account AWS ID autorizzati a visualizzare l'AMI, il contenitore, il machine learning o il prodotto SaaS, chiama l'operazione StartChangeSet API con il tipo di UpdateTargeting modifica, come mostrato nell'esempio seguente.

Sintassi della richiesta

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateTargeting",
      "Entity":
      {
        "Type": "SaaSProduct@1.0",
        "Identifier": "prod-example12345"
      },
      "DetailsDocument":
      {
        "PositiveTargeting":
        {
          "BuyerAccounts":
          [
            "1112223334444"
          ]
        }
      }
    }
  ]
}

Utilizza i seguenti campi con il tipo di UpdateTargeting 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. Ciò ha incluso la convalida delle informazioni per garantire che soddisfino le Marketplace AWS linee guida. Il processo di convalida può richiedere da pochi minuti a qualche ora.

Per verificare lo stato della richiesta, utilizza Portale di gestione Marketplace AWS o chiama l'DescribeChangeSetAPI.

Quando la richiesta è completa (se lo Status èSUCCEEDED), ne ProductId viene generata una nuova.

Validazioni sincrone

Le convalide dello schema seguenti sono specifiche delle UpdateTargeting azioni in. AWS Marketplace Catalog API Queste convalide vengono eseguite quando si chiama. StartChangeSet Se la richiesta non soddisfa i seguenti requisiti, avrà esito negativo con una risposta HTTP.

Errori asincroni

I seguenti errori sono specifici DescribeChangeSet 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à del prodotto

Puoi utilizzare l'API Catalog per aggiornare la visibilità (nota anche come stato del ciclo di vita) di un prodotto AMI, container, ML o SaaS in. Marketplace AWS

Gli stati del ciclo di vita di destinazione consentiti sono LimitedPublic, o. Restricted

Per aggiornare la visibilità del prodotto, richiama l'operazione StartChangeSet API con il tipo di UpdateVisibility modifica, come mostrato nell'esempio seguente.

Sintassi della richiesta

Per quando TargetVisibility è Public oLimited.

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateVisibility",
      "Entity":
      {
        "Type": "SaaSProduct@1.0",
        "Identifier": "prod-example12345"
      },
      "DetailsDocument":
      {
        "TargetVisibility": "Public"
      }
    }
  ]
}

Per quando TargetVisibility èRestricted.

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateVisibility",
      "Entity":
      {
        "Type": "SaaSProduct@1.0",
        "Identifier": "prod-example12345"
      },
      "DetailsDocument":
      {
        "TargetVisibility": "Restricted",
        "ReplacementProductId": "prod-example54321"
      }
    }
  ]
}

Fornisci informazioni sui campi per aggiungere il tipo di UpdateVisibility modifica.

Convalide sincrone

Le convalide dello schema seguenti sono specifiche delle UpdateVisibility azioni in. AWS Marketplace Catalog API Queste convalide vengono eseguite quando si chiama. StartChangeSet Se la richiesta non soddisfa i seguenti requisiti, avrà esito negativo con una risposta HTTP.

Dopo aver attivato questo tipo di modifica, il completamento del processo può richiedere fino a 37 giorni. Ciò include il tempo necessario al team operativo del Marketplace AWS venditore per esaminare, controllare e approvare. Quando applichi una limitazione a un prodotto, hai 24 ore di tempo per cambiare idea, chiamandoCancelChangeSet, prima che il team operativo del Marketplace AWS venditore inizi l'audit. Per ulteriori informazioni, consulta CancelChangeSet.

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. Ciò ha incluso la convalida delle informazioni per garantire che soddisfino le Marketplace AWS linee guida. Il processo di convalida può richiedere da pochi minuti a qualche ora.

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

Quando la richiesta è completa (se lo Status èSUCCEEDED), ne ProductId viene generata una nuova.

Errori asincroni

I seguenti errori sono specifici UpdateVisibility 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.

Pubblica un prodotto

Puoi utilizzare l'API Catalog per pubblicare un prodotto Draft AMI, container, ML o SaaS in Limited state in. Marketplace AWS

Per pubblicare un prodotto, chiamate l'operazione StartChangeSet API con il tipo di ReleaseProduct modifica, come illustrato nell'esempio seguente.

Sintassi della richiesta

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "ReleaseProduct",
      "Entity":
      {
        "Type": "SaaSProduct@1.0",
        "Identifier": "prod-example12345"
      },
      "DetailsDocument": {}
    }
  ]
}

Fornisci informazioni sui campi da aggiungere al tipo di ReleaseProduct modifica. Questo tipo di modifica non richiede alcun payload di parametri.

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. Ciò ha incluso la convalida delle informazioni per garantire che soddisfino le Marketplace AWS linee guida. Il processo di convalida può richiedere da pochi minuti a qualche ora.

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

Quando la richiesta è completa (se lo Status èSUCCEEDED), ne ProductId viene generata una nuova.

Errori asincroni

I seguenti errori sono specifici ReleaseProduct 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.

Trova l'ID del tuo prodotto

Devi ottenere l'ID del prodotto prima di poterlo modificare con l'API Marketplace AWS del catalogo. Esistono due modi per trovare l'ID del prodotto per i prodotti server:

I seguenti argomenti spiegano come trovare un prodotto filtrando in base all'ID dell'entità, al titolo del prodotto, alla data dell'ultima modifica o alla visibilità.

Trova un prodotto in base al titolo del prodotto

Richiesta

POST /ListEntities HTTP/1.1
Content-Type: application/json
      
{
    "Catalog": "AWSMarketplace",
    "EntityType": "AmiProduct",
    "MaxResults": 10,
    "EntityTypeFilters": {
        "AmiProductFilters": {
            "ProductTitle": {
                "WildCardValue": "XYZ"
            }
        }
    }
}

Risposta

HTTP/1.1 200
Content-type: application/json

{ 
  "EntitySummaryList": [ 
    { 
      "EntityArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/AmiProduct/example-abcd-1234",
      "EntityId": "example1-abcd-1234-5ef6-7890abcdef12@1",
      "EntityType": "AmiProduct",
      "LastModifiedDate": "2018-02-27T13:45:22Z",
       "AmiProductSummary": {
            "ProductTitle": "ABC-XYZ-123",
            "Visibility": "Public"
       }
    } 
  ],
  "NextToken": "" 
}

Trova un prodotto in base alla data dell'ultima modifica

Richiesta

POST /ListEntities HTTP/1.1
Content-Type: application/json
      
{
    "Catalog": "AWSMarketplace",
    "EntityType": "AmiProduct",
    "MaxResults": 10,
    "EntityTypeFilters": {
        "AmiProductFilters": {
            "LastModifiedDate": {
                "DateRange": {
                    "BeforeValue": "2018-03-27T13:45:22Z",
                    "AfterValue": "2018-01-27T13:45:22Z"
                }
            }
        }
    }
}

Risposta

HTTP/1.1 200
Content-type: application/json

{ 
  "EntitySummaryList": [ 
    { 
      "EntityArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/AmiProduct/example-abcd-1234",
      "EntityId": "example1-abcd-1234-5ef6-7890abcdef12@1",
      "EntityType": "AmiProduct",
      "LastModifiedDate": "2018-02-27T13:45:22Z",
       "AmiProductSummary": {
            "ProductTitle": "ABC-XYZ-123",
            "Visibility": "Public"
       }
    } 
  ],
  "NextToken": "" 
}

Trova un prodotto in base alla visibilità del prodotto

Richiesta

POST /ListEntities HTTP/1.1
Content-Type: application/json
      
{
    "Catalog": "AWSMarketplace",
    "EntityType": "AmiProduct",
    "MaxResults": 10,
    "EntityTypeFilters": {
        "AmiProductFilters": {
            "Visibility": {
                "ValueList": [
                    "Public"
                ]
            }
        }
    }
}

Risposta

HTTP/1.1 200
Content-type: application/json

{ 
  "EntitySummaryList": [ 
    { 
      "EntityArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/AmiProduct/example-abcd-1234",
      "EntityId": "example1-abcd-1234-5ef6-7890abcdef12@1",
      "EntityType": "AmiProduct",
      "LastModifiedDate": "2018-02-27T13:45:22Z",
       "AmiProductSummary": {
            "ProductTitle": "ABC-XYZ-123",
            "Visibility": "Public"
       }
    } 
  ],
  "NextToken": "" 
}

Trova un prodotto in base al titolo del prodotto, alla data dell'ultima modifica e alla visibilità del prodotto

Richiesta

POST /ListEntities HTTP/1.1
Content-Type: application/json
      
{
    "Catalog": "AWSMarketplace",
    "EntityType": "AmiProduct",
    "MaxResults": 10,
    "EntityTypeFilters": {
        "AmiProductFilters": {
            "LastModifiedDate": {
                "DateRange": {
                    "BeforeValue": "2018-03-27T13:45:22Z",
                    "AfterValue": "2018-01-27T13:45:22Z"
                }
            },
            "Visibility": {
                "ValueList": [
                    "Public"
                ]
            },
            "ProductTitle": {
                "ValueList": [
                    "ABC-XYZ-123"
                ]
            }
        }
    }
}

Risposta

HTTP/1.1 200
Content-type: application/json

{ 
  "EntitySummaryList": [ 
    { 
      "EntityArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/AmiProduct/example-abcd-1234",
      "EntityId": "example1-abcd-1234-5ef6-7890abcdef12@1",
      "EntityType": "AmiProduct",
      "LastModifiedDate": "2018-02-27T13:45:22Z",
       "AmiProductSummary": {
            "ProductTitle": "ABC-XYZ-123",
            "Visibility": "Public"
       }
    } 
  ],
  "NextToken": "" 
}

Ottieni ulteriori dettagli su un prodotto

Puoi ottenere ulteriori dettagli sul prodotto utilizzando l'ID dell'entità associato all'DescribeEntityazione.

Richiesta

GET /DescribeEntity?catalog=AWSMarketplace&entityId=example-abcd-1234 HTTP/1.1

Risposta

HTTP/1.1 200
Content-type: application/json

{
   "DetailsDocument": {
        "ProductTitle": "ABC-XYZ-123",
        "ShortDescription": "My product short description.", 
        "LongDescription": "My product longer description.", 
        "Sku": "123example456", 
        "SupportDescription": "Need help? Contact our experts at support@example.com \n\nYour purchase includes 24x7 support.", 
        "Categories": [ 
            "Operating Systems", 
            "Network Infrastructure", 
            "Application Development" 
            ] 
   }
    "EntityArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/AmiProduct/example-abcd-1234",
    "EntityId": "example1-abcd-1234-5ef6-7890abcdef12@1",
    "EntityType": "AmiProduct",
    "LastModifiedDate": "2018-02-27T13:45:22Z",
}

Modifica lo stato e gli errori del set

Apportare modifiche ai prodotti del venditore nell'API Marketplace AWS Catalog implica la creazione di set di modifiche che descrivono le modifiche che desideri apportare e quindi l'utilizzo dell'StartChangeSetazione per avviare le modifiche. Il completamento delle modifiche alla richiesta può richiedere da minuti a ore o più, a seconda della richiesta. La risposta a questa richiesta è 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 dei file e delle informazioni per garantire che soddisfi le Marketplace AWS linee guida relative ai prodotti. A seconda delle richieste di modifica, questo processo può richiedere da alcuni minuti a giorni. Puoi controllare lo stato della richiesta tramite o nell'API Catalog con l'DescribeChangeSetazione. Portale di gestione Marketplace AWS Per ulteriori informazioni sui set di modifiche, consulta Utilizzo dei set di modifiche.

Per verificare lo stato della richiesta, utilizza l'DescribeChangeSetazione.

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

{
   "Catalog": "AWSMarketplace",
   "ChangeSetID": "example123456789012abcdef"
}

Il risultato di questa chiamata è simile al seguente (in questo caso, per aggiungere una nuova versione a un prodotto contenitore).

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef",
  "ChangeSetName": "Submitted by 123456789012",
  "StartTime": "2020-10-27T22:21:26Z",
  "EndTime": "2020-10-27T22:32:19Z",
  "Status": "SUCCEEDED",
  "ChangeSet":
  [
    {
      "ChangeType": "AddDeliveryOptions",
      "Entity":
      {
        "Type": "ContainerProduct@1.0",
        "Identifier": "example-1234-abcd-56ef-abcdef12345678@4"
      },
      "Details": "{\"Version\": {\"VersionTitle\": \"1.1\",\"ReleaseNotes\": \"Minor bug fix\"},\"DeliveryOptions\": [{\"DeliveryOptionTitle\": \"EKSDelivery\",\"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\"}}},{\"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}\"}]}}}]}",
      "DetailsDocument":
      {
        "Version":
        {
          "VersionTitle": "1.1",
          "ReleaseNotes": "Minor bug fix"
        },
        "DeliveryOptions":
        [
          {
            "DeliveryOptionTitle": "EKSDelivery",
            "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"
              }
            }
          },
          {
            "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}"
                  }
                ]
              }
            }
          }
        ]
      },
      "ErrorDetailList":
      []
    }
  ]
}

Il Status campo mostra lo stato corrente della richiesta, in questo caso,SUCCEEDED.

In caso di errori, il risultato può includere due tipi di errori. Per la maggior parte degli errori, il messaggio di errore viene incluso direttamente. Tuttavia, gli errori rilevati durante la scansione del prodotto alla ricerca di vulnerabilità di sicurezza includono invece un URL a un file che elenca tutti gli errori rilevati, nel ErrorMessage campo. Gli errori rilevati durante la scansione hanno il simbolo ErrorCode "SCAN_ERROR».

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef",
  "ChangeSetName": "Submitted by 123456789012",
  "StartTime": "2020-10-27T22:21:26Z",
  "EndTime": "2020-10-27T22:32:19Z",
  "Status": "FAILED",
  "FailureDescription": "Change set preparation has failed. For details see 'ErrorDetailList'.",
  "ChangeSet":
  [
    {
      "ChangeType": "AddDeliveryOptions",
      "Entity":
      {
        "Type": "ContainerProduct@1.0",
        "Identifier": "example-1234-abcd-56ef-abcdef12345678@4"
      },
      "Details": "{\"Version\": {\"VersionTitle\": \"1.1\",\"ReleaseNotes\": \"Minor bug fix\"},\"DeliveryOptions\": [{\"DeliveryOptionTitle\": \"EKSDelivery\",\"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\"}}},{\"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}\"}]}}}]}",
      "DetailsDocument":
      {
        "Version":
        {
          "VersionTitle": "1.1",
          "ReleaseNotes": "Minor bug fix"
        },
        "DeliveryOptions":
        [
          {
            "DeliveryOptionTitle": "EKSDelivery",
            "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"
              }
            }
          },
          {
            "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}"
                  }
                ]
              }
            }
          }
        ]
      },
      "ErrorDetailList":
      [
        {
          "ErrorCode": "DUPLICATE_VERSION_TITLE",
          "ErrorMessage": "The version title must be different from any other version titles of this product."
        },
        {
          "ErrorCode": "SCAN_ERROR",
          "ErrorMessage": "https://123sample456.cloudfront.net/example-1234-abcd-5678-abcdef12345678/1234abcdef567890"
        }
      ]
    }
  ]
}

In questo esempio, viene segnalato direttamente un errore (DUPLICATE_VERSION_TITLE). L'altro errore contiene un file con messaggi di errore (in un singolo errore SCAN_ERROR possono essere rilevati più errori nel file collegato).