L'AWS Marketplace API Reference è stato ristrutturato. Per ulteriori informazioni sulle operazioni API supportate, consulta l'[AWS Marketplace API Reference](https://docs.aws.amazon.com/marketplace/latest/APIReference/Welcome.html).
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
+ [Lavora con offerte private utilizzando il Marketplace AWS API](work-with-private-offers.md)
+ [Lavora con le autorizzazioni di rivendita utilizzando il Marketplace AWS API](work-with-resale-authorizations.md)
+ [Collabora con le offerte private dei partner di canale utilizzando il Marketplace AWS API](work-with-cppos.md)
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à:
| Tipo di prodotto | Entità |
| --- | --- |
| Prodotti Amazon Machine Image (AMI) | AmiProduct@1.0 |
| Prodotti container | ContainerProduct@1.0 |
| Prodotti Software as a Service (SaaS) | SaaSProduct@1.0 |
| Prodotti per l'apprendimento automatico (ML) | MachineLearningProduct@1.0 |
**Nota**
Single-AMI con i tipi di CloudFormation prodotto, AWS Data Exchange i prodotti di dati e i servizi professionali i prodotti non sono supportati.
I seguenti argomenti presuppongono che tu abbia accesso all'API e che tu abbia completato tutti i prerequisiti per il venditore, come descritto in[Controllo degli accessi per Marketplace AWS Catalogo API](catalog-api-access-control.md).
Consulta le seguenti risorse:
+ Per comprendere le nozioni di base sull'utilizzo dell'API Marketplace AWS Catalog, consulta. [Utilizzo di Marketplace AWS Catalogo API](catalog-apis.md)
+ *Per laboratori completi con esempi di codice funzionanti, consulta [Gestire i prodotti con l'API](https://catalog.workshops.aws/mpseller/en-US/manage-products-with-api) nel workshop per i venditori.Marketplace AWS *
+ Per esempi di codice di richieste API, consulta Esempi in [Python](https://github.com/aws-samples/aws-marketplace-reference-code/tree/main/python/src/catalog_api/products) e [Java](https://github.com/aws-samples/aws-marketplace-reference-code/tree/main/java/resources/changeSets/products) in *AWS Samples* on. GitHub
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.
**Topics**
+ [Crea un prodotto](#create-product)
+ [Aggiorna i dettagli del prodotto](#update-information)
+ [Aggiungi dimensioni di prezzo](#add-dimensions)
+ [Aggiorna le dimensioni dei prezzi](#update-dimensions)
+ [Limita le dimensioni dei prezzi](#restrict-dimensions)
+ [Aggiorna la configurazione del targeting](#update-targeting)
+ [Aggiorna la visibilità del prodotto](#update-visibility)
+ [Pubblica un prodotto](#release-product)
+ [Trova l'ID del tuo prodotto](#seller-product-id)
+ [Modifica lo stato e gli errori del set](#seller-product-change-set-errors)
+ [Lavora con AMI-based i prodotti](work-with-single-ami-products.md)
+ [Lavora con i prodotti componenti EC2 Image Builder](work-with-ec2-image-builder-products.md)
+ [Lavora con prodotti basati su container utilizzando Marketplace AWS API](work-with-container-products.md)
+ [Lavora con prodotti SaaS utilizzando Marketplace AWS API](work-with-saas-products.md)
+ [Lavora con prodotti di machine learning utilizzando Marketplace AWS API](work-with-ml-products.md)
## Crea un prodotto
**Nota**
Questo tipo di modifica è necessario solo quando intendi creare un'entità di prodotto nuova di zecca nel Marketplace AWS catalogo. Non è necessario per aggiornare i prodotti esistenti.
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: [UpdateInformation[UpdateDimensions](#update-dimensions)](#update-information), [UpdateTargeting](#update-targeting), e [UpdateVisibility](#update-visibility).
Una volta completato il prodotto, puoi utilizzare il tipo di [ReleaseProduct](#release-product)modifica 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.
**Nota**
Per maggiori informazioni sulla creazione di un prodotto utilizzando il Portale di gestione Marketplace AWS, consulta i seguenti argomenti nella *Guida al Marketplace AWS venditore*:
[Crea il tuo prodotto Single-AMI](https://docs.aws.amazon.com/marketplace/latest/userguide/ami-single-ami-products.html#ami-create-product)
Non è possibile aggiornare l'AMI per la versione. Se devi aggiornare l'AMI, crea invece una nuova versione.
[Creazione di un prodotto contenitore](https://docs.aws.amazon.com/marketplace/latest/userguide/container-product-getting-started.html#create-container-product)
[Creazione di un prodotto SaaS](https://docs.aws.amazon.com/marketplace/latest/userguide/saas-create-product.html)
[Creazione di un prodotto di machine learning](https://docs.aws.amazon.com/marketplace/latest/userguide/ml-creating-your-listing.html)
Se utilizzi il Portale di gestione Marketplace AWS per creare un prodotto, il prodotto sarà nello `Staging` 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.
+ `Entity`(oggetto) (obbligatorio) — Il tipo di oggetto denominato che viene creato.
+ `Type`(stringa) (obbligatorio): si `Type` basa sul metodo di spedizione (tipo di prodotto) che verrà utilizzato dal prodotto:`AmiProduct@1.0`,`ContainerProduct@1.0`, `MachineLearningProduct@1.0` oppure`SaaSProduct@1.0`. Per ulteriori informazioni, consulta [Identificatore](catalog-apis.md#identifier).
+ `DetailsDocument`(oggetto) (obbligatorio): potrebbe essere vuoto.
+ `ProductTitle`(opzionale): il titolo del prodotto, la lunghezza massima è di 72 caratteri. Tieni presente che puoi anche impostare o aggiornare successivamente il titolo del prodotto tramite il tipo di `UpdateInformation` modifica.
**Sintassi della risposta**
Viene creato un set di modifiche per la richiesta. La risposta a questa richiesta fornisce l'`ChangeSetId`e `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](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_DescribeChangeSet.html)` 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.
| Campo di input | Regola di convalida | Codice HTTP |
| --- | --- | --- |
| ProductTitle (Stringa) | Lunghezza massima: 72 | 400 |
**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, consulta[Utilizzo dei set di modifiche](catalog-apis.md#working-with-change-sets).
| Codice di errore | Messaggio di errore |
| --- | --- |
| INVALID\_INPUT | Contenuto inappropriato '{InappropriateContent}' trovato nel campo. ProductTitle Non ProductTitle fornire contenuti inappropriati. |
## 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.
**Nota**
Per maggiori informazioni sull'aggiornamento dei dettagli del prodotto utilizzando il Portale di gestione Marketplace AWS, consulta i seguenti argomenti nella *Guida al Marketplace AWS venditore*:
AMI-based prodotto: [aggiorna le informazioni sul prodotto](https://docs.aws.amazon.com/marketplace/latest/userguide/ami-single-ami-products.html#single-ami-updating-product)
Container-based prodotto: [creazione o aggiornamento delle informazioni sul prodotto per il prodotto contenitore](https://docs.aws.amazon.com/marketplace/latest/userguide/container-product-getting-started.html#container-product-updating-version)
SaaS-based prodotto: [aggiorna le informazioni sul prodotto](https://docs.aws.amazon.com/marketplace/latest/userguide/saas-product-settings.html#update-product-information)
Prodotto di apprendimento automatico: [aggiornamento delle informazioni sul prodotto](https://docs.aws.amazon.com/marketplace/latest/userguide/ml-update-product.html)
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:
+ `Entity`(oggetto) (obbligatorio): il tipo denominato di entità che viene creata.
+ `Identifier`(string) (obbligatorio) — L'ID del prodotto. Per ulteriori informazioni, consulta [Identificatore](catalog-apis.md#identifier).
+ `Type`(stringa) (obbligatorio): si `Type` basa sul metodo di spedizione (tipo di prodotto) che verrà utilizzato dal prodotto: `AmiProduct@1.0``ContainerProduct@1.0`,`MachineLearningProduct@1.0`, o`SaaSProduct@1.0`.
+ `DetailsDocument`(oggetto) (obbligatorio): i dettagli della richiesta, incluse le informazioni che desideri aggiornare per il prodotto. Ogni campo è facoltativo, ma è necessario includere almeno una modifica da aggiornare.
+ `ProductTitle`(stringa) — Il nome del prodotto da mostrare agli acquirenti.
+ `ShortDescription`(stringa) — La descrizione degli aspetti chiave del prodotto da mostrare agli acquirenti. Di solito si tratta di 2-3 frasi.
+ `LongDescription`(stringa): la descrizione più lunga del prodotto da mostrare agli acquirenti. Di solito si tratta di 1-3 paragrafi.
+ `Sku`(string o null) — La stringa in formato libero definita come riferimento per uso personale. Si usa per annullare l'`null`impostazione di questo campo.
+ `LogoUrl`(stringa) — L'URL di un'immagine in un bucket Amazon Simple Storage Service (Amazon S3) accessibile al pubblico. Per ulteriori informazioni, consulta Requisiti per il [logo dell'azienda e del prodotto](https://docs.aws.amazon.com/marketplace/latest/userguide/product-submission.html#seller-and-product-logos).
+ `VideoUrls`(serie di stringhe): l'elenco degli URL dei video disponibili pubblicamente e ospitati esternamente da fornire come riferimento agli acquirenti nelle informazioni sul prodotto.
**Nota**
Attualmente, Marketplace AWS supporta un solo URL nell'array.
+ `Highlights`(matrice di stringhe): l'elenco di brevi callout per le funzionalità chiave del prodotto.
+ `AdditionalResources`(serie di strutture): elenco di riferimenti a risorse aggiuntive per conoscere il prodotto. Ogni riferimento è composto da un nome testuale e da un URL:
+ `Text`(stringa) — Il nome o il titolo della risorsa.
+ `Url`(stringa): l'URL di una risorsa che potrebbe essere utile all'acquirente per comprendere il tuo prodotto.
+ `SupportDescription`(stringa) — I dettagli sulla tua offerta di assistenza per il tuo prodotto.
+ `Categories`(matrice di stringhe): l'elenco delle categorie di prodotti Marketplace AWS definite che descrivono il prodotto. Per ulteriori informazioni, consulta [Categorie di prodotti](https://docs.aws.amazon.com/marketplace/latest/buyerguide/buyer-product-categories.html) nella *Guida all'Marketplace AWS acquisto*.
+ `SearchKeywords`(matrice di stringhe): l'elenco di parole chiave per il prodotto per migliorare l'esperienza di ricerca. Il nome del venditore, il nome del prodotto e le categorie di prodotti vengono inclusi automaticamente nelle parole chiave di ricerca e non devono essere ripetuti qui.
**Nota**
Quando compili inizialmente le informazioni sul prodotto (metadati) per un `Draft` prodotto, dovrai fornire tutte le seguenti informazioni nel tipo di `DetailsDocument` oggetto di `UpdateInformation` modifica:`ProductTitle`,`ShortDescription`,`LongDescription`,`LogoUrl`,`Highlights`, `AdditionalResources` `SupportDescription``Categories`, e. `SearchKeywords`
`ProductTitle`Può essere omesso se è già stato fornito durante `CreateProduct` la modifica del tipo. Tuttavia, quando si aggiornano i campi esistenti sul prodotto, è possibile includere solo gli attributi che devono essere modificati nell'`DetailsDocument`oggetto del tipo di `UpdateInformation` modifica.
**Sintassi della risposta**
Viene creato un set di modifiche per la richiesta. La risposta a questa richiesta fornisce l'`ChangeSetId`e `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'`[DescribeChangeSet](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_DescribeChangeSet.html)`API.
**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.
| Campo di input | Regola di convalida | Codice HTTP |
| --- | --- | --- |
| Stringa (generale) | Nessun carattere di controllo «\\\\ x00-\\\\ x08\\\\ x0B-\\\\ x1F» | 400 |
| ProductTitle (Stringa) | Lunghezza massima: 72 Richiesto | 400 |
| ShortDescription (Stringa) | Lunghezza massima: 1000 Richiesto | 400 |
| LongDescription (Stringa) | Lunghezza massima: 5000 Richiesto | 400 |
| Sky (stringa) | Lunghezza massima: 100 Facoltativo | 400 |
| LogoUrl (Stringa) | Modello di URL:
^ https://(www\\.)? [-a-z A-Z0 - 9@.] {1.256}\\. [a-z A-Z0-9 ()] {2,63}\\ b ([-a-za- @\+./] \*) Z0-9
Richiesto | 400 |
| VideoUrls (matrice di stringhe) | Modello URL:
https://(www\\\\.)? [-a-z A-Z0 - 9@.\_] {1.256}\\\\. [a-z A-Z0-9 ()] {2,63}\\\\ b ([-a-z @\_ \+.\\/] A-Z0-9
Facoltativo | 400 |
| Punti salienti (matrice di stringhe) | Richiesto: Min 1 - Max 3 | 400 |
| AdditionalResources (serie di strutture) | Lunghezza massima: 500 Facoltativo | 400 |
| SupportDescription (Stringa) | Lunghezza massima: 2000Richiesto | 400 |
| Categorie (matrice di stringhe) | Minimo 1 - Massimo 3 Richiesto | 400 |
| SearchKeywords (matrice di stringhe) | Minimo 1 - Massimo 15 Massimo 50 caratteri per ogni articolo
Richiesto | 400 |
**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, vedere[Utilizzo dei set di modifiche](catalog-apis.md#working-with-change-sets).
| Codice di errore | Messaggio di errore |
| --- | --- |
| MISSING\_DATA | Nessun dato fornito per eseguire un aggiornamento. Fornisci dati per almeno 1 campo del prodotto. |
| INVALID\_INPUT | Fornire. LogoUrl |
| INVALID\_INPUT | Fornire. ProductTitle |
| INVALID\_INPUT | Fornire. ShortDescription |
| INVALID\_INPUT | Fornire. LongDescription |
| INVALID\_INPUT | Fornire. SupportDescription |
| INVALID\_INPUT | Fornisci almeno una parola chiave di ricerca. |
| INVALID\_INPUT | Fornisci almeno un'evidenziazione. |
| INVALID\_INPUT | Fornisci da 1 a 3 categorie di prodotti. |
| INVALID\_INPUT | Contenuto inappropriato '{InappropriateContent}' trovato nel campo. ProductTitle Non ProductTitle fornire contenuti inappropriati. |
| INVALID\_INPUT | Contenuto inappropriato '{InappropriateContent}' trovato nel campo. ShortDescription Non ShortDescription fornire contenuti inappropriati. |
| INVALID\_INPUT | Contenuto inappropriato '{InappropriateContent}' trovato nel campo. LongDescription Non LongDescription fornire contenuti inappropriati. |
| INVALID\_INPUT | Contenuto inappropriato '{InappropriateContent}' trovato nel campo. SupportDescription Non SupportDescription fornire contenuti inappropriati. |
| INVALID\_INPUT | Campo non valido. ProductTitle Rimuovi gli spazi prima del simbolo del marchio. |
| INVALID\_INPUT | Campo non valido. ShortDescription Rimuovi gli spazi prima del simbolo del marchio. |
| INVALID\_INPUT | Campo non valido. LongDescription Rimuovi gli spazi prima del simbolo del marchio. |
| INVALID\_INPUT | Campo non valido. SupportDescription Rimuovi gli spazi prima del simbolo del marchio. |
| INVALID\_INPUT | Campo non valido. ProductTitle Rimuovi caratteri non supportati []UnsupportedCharacters. |
| INVALID\_INPUT | Campo non valido. ShortDescription Rimuovi caratteri non supportati []UnsupportedCharacters. |
| INVALID\_INPUT | Campo non valido. LongDescription Rimuovi caratteri non supportati []UnsupportedCharacters. |
| INVALID\_INPUT | Campo non valido. SupportDescription Rimuovi caratteri non supportati []UnsupportedCharacters. |
| INVALID\_INPUT | Le parole chiave di ricerca non devono contenere più di 250 caratteri combinati. |
| INVALID\_INPUT | Impossibile leggere l'input per questo tipo di modifica. Invia un input formattato correttamente. |
| INVALID\_ADDITIONAL\_RESOURCES | URL non validi in: [] Fornisci URL validi. AdditionalResources InvalidAdditionalResourcesUrls |
| NOMI\_CATEGORI\_INVALIDI | Fornisci nomi di categoria validi supportati da. Marketplace AWS |
| InvalidImageProperties | Errori di convalida rilevati: il file non è di tipo di immagine. Tipi di immagini supportati: [png\|jpg\|gif]. |
| CONTENUTO\_ESPLICITO | Contenuto esplicito: '{}ExplicitContent' rilevato. Fornisci contenuti multimediali senza contenuti espliciti. |
| INVALID\_MEDIA | URL non valido: {MediaUrl} Fornisci un nuovo URL per i file multimediali archiviati in S3. |
| INVALID\_MEDIA | URL non valido: {MediaUrl} Fornisci un URL valido che non superi i 2048 caratteri. |
| INVALID\_MEDIA | Posizione fornita non accessibile: {MediaUrl} Fornisci un URL accessibile per i file multimediali archiviati in S3. |
| INVALID\_MEDIA | Si è verificato un problema durante la copia dei file multimediali da S3. La dimensione dell'immagine supera i 5 MB. Fornisci un'immagine di dimensioni inferiori a 5 MB. |
| INVALID\_MEDIA | Malware rilevato nei media. Invia nuovamente i file multimediali senza malware. |
| TOO\_MANY\_MEDIA | Fornisci non più di 15 elementi multimediali. |
| MEDIA\_DUPLICATI | I file multimediali duplicati non sono consentiti per un prodotto. Fornisci contenuti multimediali senza duplicati. |
## Aggiungi dimensioni di prezzo
Puoi utilizzare [AWS Marketplace Catalog Service Actions](https://docs.aws.amazon.com/marketplace/latest/APIReference/API_Operations_AWS_Marketplace_Catalog_Service.html) 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.
**Nota**
Per i prodotti SaaS con modello di prezzo gratuito, è necessario creare almeno una dimensione con UsageBasedPricingTerm o ConfigurableUpfrontPricingTerm e tutte le dimensioni devono avere un prezzo di 0,00 USD. Questo requisito è esclusivo dei prodotti SaaS e non si applica ai prodotti AMI, container o machine learning.
**Nota**
Le nuove dimensioni dei prezzi hanno i seguenti impatti sugli acquirenti SaaS:
Per gli acquirenti con accordi creati sulla base di offerte pubbliche, è possibile segnalare i consumi in base alle nuove dimensioni, anche se tali valori non erano inclusi nell'offerta al momento della creazione dell'accordo.
Per gli acquirenti con contratti creati a partire da offerte private, non è possibile segnalare i consumi nelle nuove dimensioni, in quanto tali dati non esistevano nell'offerta privata al momento della creazione dell'accordo. Le chiamate all'[BatchMeterUsage](https://docs.aws.amazon.com/marketplace/latest/APIReference/API_marketplace-metering_BatchMeterUsage.html)API avranno esito positivo, ma all'acquirente non verrà addebitata alcuna fattura, quindi devi tenere traccia di quali acquirenti possono e non possono ricevere la fatturazione per eventuali nuove dimensioni. Puoi anche utilizzare l'[GetAgreementTerms](https://docs.aws.amazon.com/marketplace/latest/APIReference/API_marketplace-agreements_GetAgreementTerms.html)API per visualizzare le dimensioni incluse in ogni contratto di acquisto.
Per segnalare i consumi relativi a una nuova dimensione e fatturare all'acquirente, devi [estendere un'offerta sostitutiva](https://docs.aws.amazon.com/marketplace/latest/userguide/private-offers-upgrades-and-renewals.html#private-offers-upgrades-and-renewals-supported-products) che includa la dimensione e l'acquirente deve accettare l'offerta.
Per ulteriori informazioni sui prezzi dei prodotti, consulta i seguenti argomenti nella *Guida al Marketplace AWS venditore*:
+ [Prezzi dei prodotti AMI](https://docs.aws.amazon.com/marketplace/latest/userguide/pricing-ami-products.html)
+ [Prezzi dei prodotti container](https://docs.aws.amazon.com/marketplace/latest/userguide/pricing-container-products.html)
+ [Prezzi dei prodotti SaaS](https://docs.aws.amazon.com/marketplace/latest/userguide/saas-pricing-models.html)
+ [Prezzi dei prodotti di machine learning](https://docs.aws.amazon.com/marketplace/latest/userguide/machine-learning-pricing.html)
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*:
+ AMI-based prodotti: [aggiorna i prezzi](https://docs.aws.amazon.com/marketplace/latest/userguide/ami-single-ami-products.html#single-ami-update-product-pricing).
+ Container-based prodotti: [aggiunta di una dimensione relativa ai prezzi](https://docs.aws.amazon.com/marketplace/latest/userguide/container-product-getting-started.html#container-add-pricing-dimensions).
+ SaaS-based prodotti: [aggiungi dimensioni di prezzo](https://docs.aws.amazon.com/marketplace/latest/userguide/saas-product-settings.html#saas-add-pricing-dimensions).
+ Prodotti ML: non supportati. I prodotti di machine learning hanno dimensioni di prezzo fisse. Tuttavia, puoi [aggiornare i prezzi](https://docs.aws.amazon.com/marketplace/latest/userguide/ami-single-ami-products.html#single-ami-update-product-pricing).
Per aggiungere dimensioni di prezzo, chiama l'`StartChangeSet`API con il tipo di `AddDimensions` modifica, come illustrato nell'esempio seguente.
**Nota**
Dopo aver inviato il primo tipo di `AddDimensions` modifica con dimensioni che specificano un tipo di modello di prezzo (utilizzo, contratto o contratto con consumo), devi collaborare con il team Operativo del Marketplace AWS venditore. Ti aiutano ad aggiungere una dimensione con tipi che non rientrano nel modello di prezzo originale.
**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.
+ `DetailsDocument`(matrice di oggetti) (obbligatorio) — Dettagli della richiesta.
+ `Description`(stringa) (obbligatorio): dettagli completi della dimensione che costituirà la descrizione completa nella pagina di visualizzazione dell'acquirente.
+ `Key`(stringa) (obbligatorio) — Inserisci il facet che verrà utilizzato per definire le tariffe dell'offerta. Inoltre, inserisci le dimensioni pubblicate su AWS Marketplace Metering Service (MMS) se la dimensione non può essere misurata esternamente. Una volta creata, la dimensione non può essere modificata.
+ `Units`(string) (obbligatorio) — Il tipo di unità per la dimensione. Le unità possibili sono Utenti, Host, GB, MB, TB, Gbps, Mbps, Richieste, Unità UserHrs UnitHrs,,, HostHrs TierHrs, e. TaskHrs
+ `Name`(stringa) (obbligatorio): il nome visualizzato per la dimensione sul sito Web e la fattura del cliente.
+ `Types`(matrice di stringhe) (obbligatoria) (nota anche come **tag**): indicano se la dimensione copre la misurazione, l'autorizzazione o il supporto per la misurazione esterna. Questo non è modificabile dopo la creazione della dimensione.
+
+ `Metered`— Indica che è necessario creare tipi di utilizzo della piattaforma Commerce per consentire la misurazione per questa dimensione.
+ `ExternallyMetered`— Indica che le dimensioni del servizio di Marketplace AWS misurazione (MMS) devono essere create durante la pubblicazione per consentire ai venditori di misurare tramite l'SDK. AWS
+ `Entitled`— Indica che è possibile concedere diritti per la dimensione durante la pubblicazione del prodotto o dell'offerta.
La tabella seguente elenca le combinazioni supportate di dimensioni di prezzo e prodotti.
[See the AWS documentation website for more details](http://docs.aws.amazon.com/it_it/marketplace/latest/developerguide/work-with-seller-products.html)
+ `Entity`(oggetto) (obbligatorio) — Il tipo denominato di entità che viene creata.
+ `Identifier`(string) (obbligatorio) — L'ID del prodotto. Per ulteriori informazioni, consulta [Identificatore](catalog-apis.md#identifier).
+ `Type`(stringa) (obbligatorio): si `Type` basa sul metodo di spedizione (tipo di prodotto) che verrà utilizzato dal prodotto: `AmiProduct@1.0` oppure`SaaSProduct@1.0`.
**Sintassi della risposta**
Viene creato un set di modifiche per la richiesta. La risposta a questa richiesta fornisce l'`ChangeSetId`e `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](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_DescribeChangeSet.html)` 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.
| Campo di input | Regola di convalida | Codice HTTP |
| --- | --- | --- |
| Description | Lunghezza massima: 1000 Richiesto | 400 |
| Chiave | Lunghezza massima: 100 Modello: [A-Za-z0-9\_.-] \+$
Richiesto | 400 |
| Unità di dimensione | Lunghezza massima: 20 Richiesto | 400 |
| Nome | Lunghezza massima: 500 Richiesto | 400 |
| Tipo (tag) | Richiesto: Min 1 - Max 3
Ingressi: autorizzati, misurati, ExternallyMetered
Richiesto | 400 |
**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, vedere[Utilizzo dei set di modifiche](catalog-apis.md#working-with-change-sets).
| Codice di errore | Messaggio di errore |
| --- | --- |
| MISSING\_DATA | Nessun dato fornito per eseguire un aggiornamento. Fornisci dati per almeno 1 dimensione. |
| INVALID\_DIMENSION | Fornisci non più di 200 dimensioni. |
| INVALID\_DIMENSION | Impossibile aggiungere dimensioni duplicate. |
| INVALID\_DIMENSION | La dimensione non può essere aggiunta nello stato corrente «%s». Gli stati che supportano gli aggiornamenti delle dimensioni sono %s. |
| INVALID\_DIMENSION | Impossibile aggiungere una dimensione. Il campo «%s» ha valori duplicati «%s» in altre dimensioni. |
| DIMENSIONE\_NON VALIDA | Fornisci campi non vuoti (chiave, unità, nome, tipi) per ogni dimensione. |
| IINVALID\_TYPE | Rimuovi il tipo non valido «%s». I tipi validi sono ["Metered», «Entitled», "«]. ExternallyMetered |
| INVALID\_UNIT | Rimuovi l'unità non valida «%s». Le unità valide sono ["GB», «Gbps», "HostHrs«, «Hosts», «MB», «Mbps», «Richieste», "TaskHrs«TB», "«," TierHrs «, UnitHrs «Unità», "«, UserHrs «Utenti"]. |
| INVALID\_INPUT | È stato trovato un contenuto non appropriato «%s» nel campo %s. Fornisci a %s nessun contenuto inappropriato. |
| INVALID\_INPUT | Campo '%s' non valido. Rimuovi gli spazi prima del simbolo del marchio. |
| INVALID\_INPUT | Campo '%s' non valido. Rimuovi i caratteri non supportati %s. |
| INVALID\_DIMENSION | Rimuove la combinazione di tipi di dimensione non valida %s. I valori consentiti sono %s. |
| INVALID\_DIMENSION | Rimuove la chiave di dimensione «%s» non valida per la dimensione misurata. |
| DIMENSIONE\_NON VALIDA | La dimensione denominata «%s» per ProductCode «%s» non ha Marketplace AWS superato la convalida del servizio di misurazione %s. |
| DIMENSIONE\_NON VALIDA | La dimensione denominata «%s» per ProductCode «%s» non ha alcun record di misurazione presente nel servizio di misurazione. Il prodotto non è mai stato lanciato per essere testato oppure è configurato in modo errato e non effettua le chiamate appropriate al servizio di misurazione. Marketplace AWS |
## 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.
**Nota**
Per maggiori informazioni sull'aggiornamento delle dimensioni di prezzo utilizzando la Portale di gestione Marketplace AWS, consulta i seguenti argomenti nella *Guida del Marketplace AWS venditore*:
AMI-based prodotto: [Aggiorna i prezzi](https://docs.aws.amazon.com/marketplace/latest/userguide/ami-single-ami-products.html#single-ami-update-product-pricing)
Container-based prodotto: [aggiornamento delle informazioni sulle dimensioni](https://docs.aws.amazon.com/marketplace/latest/userguide/container-product-getting-started.html#container-update-dimensions-information)
SaaS-based prodotto: [aggiorna le dimensioni dei prezzi](https://docs.aws.amazon.com/marketplace/latest/userguide/saas-product-settings.html#saas-update-dimension)
Prodotto di machine learning: [aggiorna i prezzi del prodotto](https://docs.aws.amazon.com/marketplace/latest/userguide/ml-update-public-offer.html)
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:
+ `DetailsDocument`(matrice di oggetti) (obbligatorio) — Dettagli della richiesta.
+ `Key`(stringa) (obbligatorio): fornisce la chiave della dimensione esistente del prodotto su cui modificare la descrizione e il nome. Infatti`UpdateDimension`, questo campo serve solo a identificare la dimensione da modificare.
+ `Types`(matrice di stringhe) (obbligatorio) (noto anche come **tag**): indicano se la dimensione copre la misurazione, l'autorizzazione o il supporto per la misurazione esterna. Questo non è modificabile dopo la creazione della dimensione.
+ `Metered`— Indica che è necessario creare tipi di utilizzo della piattaforma Commerce per consentire la misurazione per questa dimensione.
+ `ExternallyMetered`— Indica che le dimensioni AWS Marketplace Metering Service (MMS) devono essere create durante la pubblicazione per consentire ai venditori di contabilizzare tramite l'SDK. AWS
+ `Entitled`— Indica che è possibile concedere i diritti per la dimensione durante la pubblicazione. product/offer
**Combinazioni di tipi di dimensioni di prezzo valide**
[See the AWS documentation website for more details](http://docs.aws.amazon.com/it_it/marketplace/latest/developerguide/work-with-seller-products.html)
+ `Description`(stringa) (opzionale): descrizione completa della dimensione, che sarà la descrizione estesa nella pagina di visualizzazione dell'acquirente.
+ `Name`(stringa) opzionale: visualizza il nome della dimensione sul sito Web e la fattura del cliente.
+ `Entity`(oggetto) (obbligatorio) — Il tipo denominato di entità che viene creata.
+ `Identifier`(string) (obbligatorio) — L'ID del prodotto. Per ulteriori informazioni, consulta [Identificatore](catalog-apis.md#identifier).
+ `Type`(stringa) (obbligatorio): si `Type` basa sul metodo di spedizione (tipo di prodotto) che verrà utilizzato dal prodotto: `AmiProduct@1.0` oppure`SaaSProduct@1.0`.
**Sintassi della risposta**
Viene creato un set di modifiche per la richiesta. La risposta a questa richiesta fornisce l'`ChangeSetId`e `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](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_DescribeChangeSet.html)` 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.
| Campo di input | Regola di convalida | Codice HTTP |
| --- | --- | --- |
| Description | Lunghezza massima: 1000
Richiesto | 400 |
| Chiave | Lunghezza massima: 100
Modello: [A-Za-z0-9\_.-] \+$
Richiesto | 400 |
| Nome | Lunghezza massima: 5
Richiesto | 400 |
| Tipi (tag) | Richiesto: Min 1 - Max 3
Ingressi:`Entitled`,, `Metered` `ExternallyMetered`
Richiesto | 422 |
**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, vedere[Utilizzo dei set di modifiche](catalog-apis.md#working-with-change-sets).
| Codice di errore | Messaggio di errore |
| --- | --- |
| INVALID\_INPUT | Campo '%s' non valido. Rimuovi gli spazi prima del simbolo del marchio. |
| INVALID\_INPUT | Campo '%s' non valido. Rimuovi i caratteri non supportati %s. |
| INVALID\_DIMENSION | Fornisci campi non vuoti (Key,Types, Name and/orDescription) per ogni dimensione. |
| DIMENSIONE\_NON VALIDA | Impossibile aggiornare la dimensione. Il campo Name ha valori duplicati '%s' in altre dimensioni. |
| DIMENSIONE\_NON VALIDA | Impossibile aggiornare la stessa dimensione con la chiave «%s» e digitare «%s» più volte nella stessa richiesta. |
| INVALID\_DIMENSION | Impossibile limitare la dimensione. La chiave di dimensione «%s» con i tipi «%s» non esiste. |
| DIMENSIONE\_NON VALIDA | Impossibile aggiornare la dimensione. La chiave di dimensione '%s' èMetered. |
| INVALID\_DIMENSION | La dimensione non può essere aggiornata per una dimensione già limitata. |
## 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'`StartChangeSet`API con il tipo di `RestrictDimensions` modifica.
**Nota**
Le restrizioni relative alle dimensioni dei prezzi sono disponibili solo quando il prodotto è in stato di bozza. Le modifiche non sono consentite una volta che il prodotto è passato allo stato limitato o pubblico.
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:
+ `DetailsDocument`(matrice di oggetti) (obbligatorio) — Dettagli della richiesta.
+ `Key`(stringa) (obbligatorio): fornisce la chiave della dimensione esistente del prodotto su cui modificare la descrizione e il nome. Infatti`RestrictDimensions`, questo campo serve solo a identificare la dimensione da modificare.
+ `Types`(matrice di stringhe) (obbligatorio) (noto anche come **tag**): indicano se la dimensione copre la misurazione, l'autorizzazione o il supporto per la misurazione esterna. Questo non è modificabile dopo la creazione della dimensione.
+ `["ExternallyMetered", "Entitled"]`— È possibile combinare questi tipi solo per il contratto SaaS con i prezzi di consumo, dove le dimensioni possono essere prepagate o misurate.
+ `["Metered"]`— Per le dimensioni orarie dei prezzi dei prodotti AMI. Indica che è necessario creare tipi di utilizzo della piattaforma Commerce per consentire la misurazione di questa dimensione.
+ `["ExternallyMetered"]`— Per dimensioni flessibili dei prezzi di consumo (note anche come misurazione personalizzata) di prodotti AMI, container e SaaS. Indica che le dimensioni del AWS Marketplace Metering Service (MMS) devono essere create durante la pubblicazione per consentire ai venditori di misurare tramite l'SDK. AWS
+ `["Entitled"]`— Per le dimensioni dei prezzi contrattuali dei contratti SaaS e dei prodotti di servizi professionali. Questo tag concede i diritti di utilizzo di un software o un servizio, imposta le date di inizio e fine per l'utilizzo e concede diritti di sconto sull'utilizzo per i prodotti annuali AMI. Ogni autorizzazione è identificata da una chiave Dimension per la creazione e l'aggiornamento delle autorizzazioni. AWS Marketplace Entitlement Service La chiave indica che è possibile concedere i diritti per la dimensione durante la pubblicazione di prodotti e offerte.
+ `Entity`(oggetto) (obbligatorio): il tipo denominato di entità che viene creata.
+ `Identifier`(string) (obbligatorio) — L'ID del prodotto. Per ulteriori informazioni, consulta [Identificatore](catalog-apis.md#identifier).
+ `Type`(stringa) (obbligatorio): si `Type` basa sul metodo di consegna del prodotto (tipo di prodotto): `AmiProduct@1.0` o`SaaSProduct@1.0`.
**Sintassi della risposta**
Viene creato un set di modifiche per la richiesta. La risposta a questa richiesta fornisce l'`ChangeSetId`e `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'`[DescribeChangeSet](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_DescribeChangeSet.html)`API. 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.
| Campo di input | Regola di convalida | Codice HTTP |
| --- | --- | --- |
| Description | Lunghezza massima: 1000
Richiesto | 400 |
| Chiave | Lunghezza massima: 100
Modello: [A-Za-z0-9\_.-] \+$
Richiesto | 400 |
| Nome | Lunghezza massima: 5
Richiesto | 400 |
| Tipi (tag) | Richiesto: Min 1 - Max 3
Ingressi:`Entitled`,, `Metered` `ExternallyMetered`
Richiesto | 400 |
**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, vedere[Utilizzo dei set di modifiche](catalog-apis.md#working-with-change-sets).
| Codice di errore | Messaggio di errore |
| --- | --- |
| INVALID\_INPUT | Campo '%s' non valido. Rimuovi gli spazi prima del simbolo del marchio. |
| INVALID\_INPUT | Campo '%s' non valido. Rimuovi i caratteri non supportati %s. |
| INVALID\_DIMENSION | La chiave di dimensione «%s» con i tipi «%s» era già limitata |
| INVALID\_DIMENSION | Impossibile limitare la dimensione. La chiave di dimensione «%s» con i tipi «%s» non esiste |
| INVALID\_DIMENSION | Impossibile limitare le dimensioni duplicate. |
| INVALID\_DIMENSION | Tutte le dimensioni autorizzate non possono essere limitate. Deve esserci almeno una dimensione Intitled attiva. |
| INVALID\_DIMENSION | La chiave di dimensione «%s» con i tipi «%s» è associata a un'altra dimensione di tipi diversi «%s». Entrambe le dimensioni della stessa chiave devono essere limitate contemporaneamente per essere valide. |
## 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`
**Nota**
*Per maggiori informazioni sull'aggiunta di Account AWS ID utilizzando il Portale di gestione Marketplace AWS, consulta i seguenti argomenti nella Guida del Marketplace AWS venditore:*
AMI-based prodotto: [Aggiorna la lista consentita (anteprima degli account](https://docs.aws.amazon.com/marketplace/latest/userguide/ami-single-ami-products.html#single-ami-updating-allowlist))
Container-based prodotto: [Aggiornamento della lista consentita degli ID degli account AWS](https://docs.aws.amazon.com/marketplace/latest/userguide/container-product-getting-started.html#container-update-allowlist)
SaaS-based prodotto: [Aggiornamento della lista consentita degli ID degli account AWS](https://docs.aws.amazon.com/marketplace/latest/userguide/saas-product-settings.html#update-allowlist)
Prodotto di apprendimento automatico: [aggiornamento della lista consentita](https://docs.aws.amazon.com/marketplace/latest/userguide/ml-update-allowlist.html)
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.
+ `Entity`(oggetto) (obbligatorio) — Il tipo denominato di entità che viene creata.
+ `Identifier`(string) (obbligatorio) — L'ID del prodotto. Per ulteriori informazioni, consulta [Identificatore](catalog-apis.md#identifier).
+ `Type`(stringa) (obbligatorio): si `Type` basa sul metodo di spedizione (tipo di prodotto) che verrà utilizzato dal prodotto:`AmiProduct@1.0`,`MachineLearningProduct@1.0`, oppure`SaaSProduct@1.0`.
+ `DetailsDocument`(oggetto) (obbligatorio): i dettagli necessari per eseguire il ChangeSet.
+ `PositiveTargeting`(oggetto) (opzionale): il targeting positivo definisce i criteri che il profilo di ogni acquirente deve soddisfare per poter accedere all'offerta. Questo campo è facoltativo, ma è necessario fornire almeno un'opzione di targeting quando questo campo è presente.
+ `BuyerAccounts`(array di stringhe) (opzionale): elenca come opzione per consentire il targeting basato sugli account AWS (noto anche come offerta privata). Se l'intenzione è di non indirizzare l'offerta a un account AWS, questo campo deve essere omesso.
**Sintassi della risposta**
Viene creato un set di modifiche per la richiesta. La risposta a questa richiesta fornisce l'`ChangeSetId`e `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'`[DescribeChangeSet](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_DescribeChangeSet.html)`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 `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.
| Tipo di targeting | Stati di visibilità correnti validi | BuyerAccounts (input) | Verifica |
| --- | --- | --- | --- |
| Positiva | PubblicoLimited, o Draft | Matrice di stringhe Account AWS ID a 12 cifre.
Dimensione minima: 0.
Dimensione massima: 5000. | L'input deve essere diverso dagli account di destinazione del documento corrente.L'input deve essere valido Account AWS. |
**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, vedere[Utilizzo dei set di modifiche](catalog-apis.md#working-with-change-sets).
| Codice di errore | Messaggio di errore |
| --- | --- |
| INVALID\_PRODUCT\_VISIBILITY | Usa un pubblico o un prodotto esistente. Limited Draft |
| NON VALIDO\_ AWS\_ACCOUNT\_ID S | Fornisci ID validi Account AWS . Account AWS non trovato: [x, y, z]. |
| ValidationException | I prodotti di servizi professionali non dispongono di liste consentite. A differenza di altri tipi di prodotti, i prodotti per i servizi professionali disponibili nello stato limitato possono essere estesi a qualsiasi acquirente senza bisogno di una lista consentita. |
## 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
**Nota**
*Per ulteriori informazioni sull'aggiornamento della visibilità del prodotto utilizzando il Portale di gestione Marketplace AWS, consulta i seguenti argomenti nella Guida al Marketplace AWS venditore:*
AMI-based prodotto: [aggiorna la visibilità del prodotto](https://docs.aws.amazon.com/marketplace/latest/userguide/ami-single-ami-products.html#ami-update-self-service-visibility)
Container-based prodotto: [aggiornamento della visibilità del prodotto](https://docs.aws.amazon.com/marketplace/latest/userguide/container-product-getting-started.html#container-product-visibility)
SaaS-based prodotto: [aggiorna la visibilità del prodotto](https://docs.aws.amazon.com/marketplace/latest/userguide/saas-product-settings.html#saas-update-visibility)
Prodotto di machine learning: [aggiornamento della visibilità del prodotto](https://docs.aws.amazon.com/marketplace/latest/userguide/ml-update-visibility.html)
Gli stati del ciclo di vita di destinazione consentiti sono `Limited``Public`, o. `Restricted`
`Limited`
Il prodotto è completo e ha completato con successo il. `ReleaseProduct` `ChangeType` I venditori possono visualizzare i dettagli del prodotto in questo stato. Il prodotto non è pubblico. Tuttavia, i venditori possono rivolgersi ad acquirenti specifici per consentire l'anteprima del prodotto.
`Public`
Il prodotto è visibile in Marketplace AWS. Gli acquirenti possono visualizzare il prodotto e abbonarsi.
`Restricted`
Il prodotto non è più visibile al pubblico e non accetta nuovi abbonati. Gli abbonati esistenti possono continuare a utilizzare questo prodotto fino alla scadenza dell'abbonamento.
**Nota**
Il tipo di `UpdateVisibility` modifica richiede una revisione manuale da parte del team Operativo del Marketplace AWS venditore, che si traduce in un tempo di esecuzione più lungo. `UpdateVisibility`Utilizzalo separatamente nel proprio set di modifiche.
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` o`Limited`.
```
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.
+ `Entity`(oggetto) (obbligatorio): il tipo denominato di entità che viene creata.
+ `Identifier`(string) (obbligatorio) — L'ID del prodotto. Per ulteriori informazioni, consulta [Identificatore](catalog-apis.md#identifier).
+ `Type`(stringa) (obbligatorio): si `Type` basa sul metodo di spedizione (tipo di prodotto) che verrà utilizzato dal prodotto:`AmiProduct@1.0`,`SaaSProduct@1.0`,`ContainerProduct@1.0`,`MachineLearningProduct@1.0`. Per ulteriori informazioni, consulta [Identificatore](catalog-apis.md#identifier).
+ `DetailsDocument`(oggetto) (obbligatorio): i dettagli necessari per eseguire il`ChangeSet`.
+
+ `TargetVisibility`— La nuova visibilità prevista del prodotto.
Valori possibili: `Public`, `Limited` e `Restricted`
+ `ReplacementProductId`(stringa) (opzionale) — ID del prodotto sostitutivo per il prodotto da acquistare`Restricted`. Utilizzato per notificare agli attuali abbonati la restrizione relativa al prodotto.
Accetta `Restricted` solo per. `TargetVisibility`
**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.
| Tipo di targeting | Stati correnti validi | ReplacementProductId (input) | Controlli di convalida |
| --- | --- | --- | --- |
| Pubblica | Limited e Restricted | Non consentito | Stato attuale valido |
| Limited | Pubblico e Restricted | Non consentito | Stato attuale valido |
| Restricted | Pubblico e Limited | Stringa (opzionale) | ReplacementProductId deve appartenere a un prodotto esistente Limited o pubblico. |
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, chiamando`CancelChangeSet`, prima che il team operativo del Marketplace AWS venditore inizi l'audit. Per ulteriori informazioni, consulta [https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_CancelChangeSet.html](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_CancelChangeSet.html).
**Sintassi della risposta**
Viene creato un set di modifiche per la richiesta. La risposta a questa richiesta fornisce l'`ChangeSetId`e `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](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_DescribeChangeSet.html)` 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, vedere[Utilizzo dei set di modifiche](catalog-apis.md#working-with-change-sets).
| Codice di errore | Messaggio di errore |
| --- | --- |
| INVALID\_PRODUCT\_STATE | Usa un prodotto esistente Public o. Limited Restricted |
| INVALID\_TARGET\_VISIBILITY | Fornisci uno stato di visibilità del bersaglio valido:, o. Public Limited Restricted |
| EMPTY\_TARGET\_VISIBILITY | Fornisci uno stato di visibilità del bersaglio valido:, o. Public Limited Restricted |
| INVALID\_REPLACEMENT\_PRODUCT\_ID | Usa un prodotto esistente o sostitutivo. Public Limited |
| INVALID\_REPLACEMENT\_PRODUCT\_ID | L'ID del prodotto sostitutivo è valido solo quando si applica una restrizione a un prodotto. |
| AUDIT\_ERROR | Varia in base alla revisione manuale MCO. |
| INFORMAZIONI MANCANTI SUL PROFILO DEL VENDITORE | Prima di poter aggiornare il prodotto a Pubblico, devi aggiungere un profilo pubblico al tuo Account venditore. |
## Pubblica un prodotto
Puoi utilizzare l'API Catalog per pubblicare un prodotto `Draft` AMI, container, ML o SaaS in `Limited` state in. Marketplace AWS
**Nota**
Per `AmiProduct@1.0` e`SaaSProduct@1.0`, il tipo di `ReleaseProduct` modifica deve essere accompagnato dal tipo di `ReleaseOffer` modifica sulla bozza dell'`Offer@1.0`entità pubblica corrispondente creata per questo prodotto.
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.
+ `Entity`(oggetto) (obbligatorio) — Il tipo denominato di entità che viene creata.
+ `Identifier`(string) (obbligatorio) — L'ID del prodotto. Per ulteriori informazioni, consulta [Identificatore](catalog-apis.md#identifier).
+ `Type`(stringa) (obbligatorio): si `Type` basa sul metodo di spedizione (tipo di prodotto) che verrà utilizzato dal prodotto:`AmiProduct@1.0`,`SaaSProduct@1.0`,`ContainerProduct@1.0`,`MachineLearningProduct@1.0`. Per ulteriori informazioni, consulta [Identificatore](catalog-apis.md#identifier).
+ `DetailsDocument`(oggetto) (obbligatorio): deve essere un oggetto vuoto. Il tipo di modifica `ReleaseProduct` non accetta alcun dettaglio.
**Sintassi della risposta**
Viene creato un set di modifiche per la richiesta. La risposta a questa richiesta fornisce l'`ChangeSetId`e `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](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_DescribeChangeSet.html)` 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, vedere[Utilizzo dei set di modifiche](catalog-apis.md#working-with-change-sets).
| Codice di errore | Messaggio di errore |
| --- | --- |
| VALIDAZIONE\_FALLITA | Fornisci informazioni sulla descrizione. |
| VALIDATION\_FAILED | Fornisci informazioni sulle versioni. |
| VALIDATION\_FAILED | Fornisci informazioni sulle dimensioni. |
| VALIDAZIONE\_FALLITA | Fornire informazioni sulla descrizione\| \|PromotionalResources. SupportInformation |
## 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:
+ Apri Portale di gestione Marketplace AWS e accedi con il tuo Account venditore. Dal menu **Prodotti**, seleziona **Prodotti server**, quindi scegli il prodotto che ti interessa. L'ID del prodotto è riportato nella sezione **Riepilogo del prodotto**.
+ Utilizza l'[https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_ListEntities.html](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_ListEntities.html)azione con `EntityType` **AmiProduct** o**ContainerProduct**, **SaaSProduct****MachineLearningProduct**, o **DataProduct** per ottenere un elenco di prodotti, inclusi gli ID di prodotto, tramite l'API del catalogo. `ListEntities`richiede che tu non includa la versione del tipo di entità (ad esempio,`AmiProduct@1.0`).
**Nota**
L'ID del prodotto è disponibile solo dopo la pubblicazione del prodotto ed è visibile almeno all'utente stesso in Marketplace AWS. Quando crei il prodotto per la prima volta, possono essere necessari diversi giorni prima che venga esaminato e creato completamente. Durante questo periodo, non sarà disponibile un identificativo del prodotto.
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à.
**Topics**
+ [Trova un prodotto in base al titolo del prodotto](#find-product-using-title)
+ [Trova un prodotto in base alla data dell'ultima modifica](#find-product-using-last-mod-date)
+ [Trova un prodotto in base alla visibilità del prodotto](#find-product-using-visibility)
+ [Trova un prodotto in base al titolo del prodotto, alla data dell'ultima modifica e alla visibilità del prodotto](#find-product-using-all)
+ [Ottieni ulteriori dettagli su un prodotto](#get-additional-details)
### 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'`DescribeEntity`azione.
**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'`StartChangeSet`azione 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'`DescribeChangeSet`azione. Portale di gestione Marketplace AWS Per ulteriori informazioni sui set di modifiche, consulta [Utilizzo dei set di modifiche](catalog-apis.md#working-with-change-sets).
Per verificare lo stato della richiesta, utilizza l'`DescribeChangeSet`azione.
```
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).
**Nota**
Il link restituito in `ErrorMessage` è valido per 60 giorni.