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 prodotti SaaS utilizzando Marketplace AWS API
Puoi utilizzarli AWS Marketplace Catalog API per automatizzare le attività relative all'utilizzo dei prodotti. SaaS-based Per informazioni sulla creazione di SaaS-based prodotti, consulta[Crea un prodotto](work-with-seller-products.md#create-product). I seguenti argomenti descrivono come eseguire le azioni dell'API del catalogo:
**Topics**
+ [Configura il modello di prezzo gratuito per i prodotti SaaS](#saas-free-pricing-model)
+ [Opzioni SaaS Quick Launch](#saas-quick-launch-resources)
+ [Aggiungi opzioni di consegna](#add-delivery-options)
+ [SaaSUrlDeliveryOption](#saas-url-delivery-option)
## Configura il modello di prezzo gratuito per i prodotti SaaS
I prodotti SaaS possono essere offerti con un modello di prezzo gratuito, che consente agli acquirenti di utilizzare il prodotto senza alcun costo. Quando si utilizza il modello di prezzo gratuito per i prodotti SaaS, è necessario configurare le dimensioni dei prezzi con prezzi a zero dollari in uno dei due. UsageBasedPricingTerm ConfigurableUpfrontPricingTerm
**Nota**
Il requisito del modello di prezzo gratuito per i prodotti SaaS è unico. Per i prodotti SaaS con prezzo gratuito, è necessario creare almeno una dimensione con uno dei due UsageBasedPricingTerm o ConfigurableUpfrontPricingTerm, e tutte le dimensioni devono avere un prezzo di 0,00 USD. Questo requisito non si applica ai prodotti AMI, container o machine learning.
Per configurare i prezzi gratuiti per un prodotto SaaS:
1. Crea dimensioni di prezzo per il tuo prodotto utilizzando il tipo di `AddDimensions` modifica. Per maggiori informazioni, consulta [Aggiungi dimensioni di prezzo](work-with-seller-products.md#add-dimensions) la documentazione relativa ai prodotti del venditore.
1. Crea un'offerta con il valore `PricingModel` impostato su `Free` e includi una `UsageBasedPricingTerm` o `ConfigurableUpfrontPricingTerm` tutte le dimensioni i prezzi impostati su 0,00 USD. Per ulteriori informazioni sulla creazione di offerte, consulta. [Lavora con le offerte utilizzando il Marketplace AWS API](work-with-offers.md)
Durante la configurazione dell'offerta, assicurati che:
+ Tutti i prezzi delle schede tariffarie `UsageBasedPricingTerm` sono impostati su «0.00" (formato stringa)
+ Tutti gli importi degli `ConfigurableUpfrontPricingTerm` addebiti sono impostati su «0.00" (formato stringa)
+ È inclusa almeno una dimensione con un prezzo di 0,00 USD
## Opzioni SaaS Quick Launch
Per informazioni sulle opzioni di avvio rapido, consulta le seguenti risorse:
+ *(Acquirenti) Per le opzioni Quick Launch per i prodotti SaaS, consulta [Configurazione e lancio di prodotti SaaS utilizzando Quick Launch](https://docs.aws.amazon.com/marketplace/latest/buyerguide/saas-quick-launch.html) nella Guida all'acquisto.Marketplace AWS *
+ (Venditori) Per le opzioni di avvio rapido per i prodotti SaaS, [consulta Configurare Quick](https://docs.aws.amazon.com/marketplace/latest/userguide/saas-product-settings.html#saas-quick-launch) Launch nella Guida *Marketplace AWS del* venditore.
+ *Per un workshop Quick Launch per i prodotti SaaS, consulta [Lab: Enable SaaS Quick Launch](https://catalog.workshops.aws/mpseller/en-US/saas/quick-launch-integration) nel workshop del venditore.Marketplace AWS *
## Aggiungi opzioni di consegna
Puoi utilizzare l'API Catalog per aggiungere opzioni di consegna per un prodotto SaaS in. Marketplace AWS Le opzioni di distribuzione delle API consentono ai venditori di offrire API-based servizi che si integrano con AWS servizi come Amazon Bedrock for AI agent flows.
Per aggiungere opzioni di consegna dell'API, chiama l'operazione `StartChangeSet` API con il tipo di `AddDeliveryOptions` modifica per aggiungere i dettagli di consegna, come mostrato nell'esempio seguente.
I seguenti argomenti spiegano come aggiungere e utilizzare le `SaaSUrlDeliveryOptionDetails` opzioni `ApiDeliveryOptionDetails` and.
**Topics**
+ [ApiDeliveryOptionDetails](#api-delivery-option-details)
+ [Aggiorna le opzioni di consegna](#update-delivery-options)
+ [Aggiorna la visibilità delle opzioni di consegna](#update-delivery-options-visibility)
### ApiDeliveryOptionDetails
L'esempio in questa sezione supporta il tipo di opzione di `ApiDeliveryOptionDetails` consegna, che consente di specificare endpoint API, metodi di autenticazione e protocolli di integrazione per il prodotto SaaS.
**Sintassi della richiesta**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"ChangeType": "AddDeliveryOptions",
"Entity": {
"Identifier": "prod-{{1234567890123}}",
"Type": "SaaSProduct@1.0"
},
"Details": {
"DeliveryOptions": [
{
"Details": {
"ApiDeliveryOptionDetails": {
"ApiType": "AGENT",
"QuickLaunchEnabled": true,
"FulfillmentUrl": "{{https://example.com/fulfillment}}",
"UsageInstructions": "# {{Getting Started}}\\n\\n{{To use this API:}}\\n{{1. Register for an API key}}\\n{{2. Configure your endpoint}}\\n{{3. Start making requests}}",
"CompatibleServices": ["Bedrock-AgentCore"],
"Endpoints": [
{
"Name": "GenerateContent",
"EndpointUrl": "{{https://api.example.com/v1/generate}}",
"Description": "Generate content using AI models",
"AuthorizationTypes": ["API_KEY"],
"Schemas": [{
"Type": "OPEN_API",
"SchemaUrl": "{{https://example.com/schemas/example-schema.json}}"
}],
"IntegrationProtocols": [
{
"Type": "MCP",
"UsageInstructions": "{{Connect using Model Context Protocol for seamless integration}}"
}
]
}
]
}
}
}
]
}
}
```
Fornisci informazioni sui campi per aggiungere il tipo di `AddDeliveryOptions` modifica:
+ `Entity`(oggetto) (obbligatorio): il tuo SaaS-based prodotto.
+ `Identifier`(stringa) (obbligatorio) — L'ID del prodotto. Per ulteriori informazioni, consulta Identifier.
+ `Type`(stringa) (obbligatorio): il tipo si basa sul metodo di spedizione (tipo di prodotto) che verrà utilizzato dal prodotto:`SaaSProduct@1.0`.
+ `DetailsDocument`(oggetto) (obbligatorio) — Dettagli della richiesta.
+ `DeliveryOptions`(array) — Dettagli sulle opzioni di distribuzione dell'API che vengono aggiunte.
+ `Details`(oggetto) — Contiene un'opzione `ApiDeliveryOptionDetails` di consegna da aggiungere.
+ `ApiDeliveryOptionDetails`(oggetto) — Contiene i dettagli dell'opzione di consegna dell'API per un prodotto SaaS.
+ `ApiType`(stringa) (obbligatorio): tipo di offerta API. Valori validi: `MCP_SERVER`, `KNOWLEDGE_BASE`, `AGENT`, `GUARDRAIL`, `OTHER`.
+ `QuickLaunchEnabled`(boolean) (obbligatorio): determina se gli acquirenti possono utilizzare Quick Launch per configurare e avviare il software.
+ `FulfillmentUrl`(stringa) (obbligatorio) — L'URL della pagina di destinazione per la registrazione del software del venditore.
+ `UsageInstructions`(stringa) (obbligatorio): istruzioni per l'utilizzo di questa opzione di distribuzione dell'API. Supporta la formattazione markdown. Massimo 30.000 caratteri.
+ `CompatibleServices`(array) (opzionale): servizi AWS supportati per questa opzione di distribuzione. Attualmente supporta`Bedrock-AgentCore`.
+ `Endpoints`(array) (obbligatorio): gli endpoint API disponibili per questa offerta. Deve contenere esattamente un endpoint.
+ `Name`(string) (opzionale) — Il nome dell'endpoint dell'API. Deve corrispondere al modello. `^[A-Za-z][a-zA-Z0-9-]+$` Massimo 100 caratteri.
+ `EndpointUrl`(string) (obbligatorio) — L'URL dell'endpoint dell'API. Deve essere un URL HTTPS valido.
+ `Description`(string) (opzionale): una descrizione dell'endpoint dell'API e della sua funzionalità. Massimo 4.000 caratteri.
+ `AuthorizationTypes`(array) (richiesto): i tipi di autorizzazione richiesti per accedere all'endpoint dell'API. Valori validi: `API_KEY`, `OAUTH2`. Deve contenere 1-2 valori univoci.
+ `Schemas`(array) (opzionale): le specifiche dello schema per l'endpoint dell'API. Massimo 1 schema.
+ `Type`(stringa) (obbligatorio) — Tipo di schema. Valore valido: `OPEN_API`.
+ `SchemaUrl`(string) (obbligatorio) — L'URL S3 dello schema che è stato inserito in un bucket S3 di proprietà di Marketplace.
+ `IntegrationProtocols`(array) (opzionale) — Tipi di protocollo supportati dall'endpoint. Massimo 2 protocolli.
+ `Type`(stringa) (obbligatorio) — Identificatore di protocollo. Valori validi: `MCP`, `A2A`.
+ `UsageInstructions`(string) (obbligatorio) — Istruzioni aggiuntive per l'utilizzo del protocollo con l'endpoint. Massimo 30.000 caratteri.
****Sintassi di risposta****
Viene creato un set di modifiche per la richiesta. La risposta a questa richiesta fornisce l'ID per il set di modifiche ed è simile alla seguente.
```
{
"ChangeSetId": "{{example123456789012abcdef}}",
"ChangeSetArn": "arn:aws:aws-marketplace:us-east-
1:{{123456789012}}:AWSMarketplace/ChangeSet/{{example123456789012abcdef}}"
}
```
**Convalide sincrone**
| Condizione di errore | Messaggio | Codice HTTP |
| --- | --- | --- |
| Tipo di API non valido | Hai fornito un tipo di API non valido. I valori validi sono: MCP\_SERVER, KNOWLEDGE\_BASE, AGENT, GUARDRAIL, OTHER. | 422 |
| Url di evasione non valido | Fornisci un URL di evasione valido che inizi con «https://». | 422 |
| Campi obbligatori mancanti | Parametro obbligatorio mancante. È necessario fornire ApiType, QuickLaunchEnabled, FulfillmentUrl UsageInstructions, ed Endpoints. | 422 |
| URL dell'endpoint non valido | Fornisci un URL di endpoint valido che inizia con «https://». | 422 |
| Tipi di autorizzazione mancanti | È necessario fornire almeno un tipo di autorizzazione. I valori validi sono: API\_KEY, OAUTH2. | 422 |
| Tipi di autorizzazione non validi | Hai fornito tipi di autorizzazione non validi. I valori validi sono: API\_KEY, OAUTH2. | 422 |
| Troppi endpoint | Non puoi fornire più di un endpoint per le opzioni di distribuzione delle API. | 422 |
| Servizi compatibili non validi | Hai fornito servizi compatibili non validi. I valori validi sono: Bedrock-AgentCore. | 422 |
| Tipo di schema non valido | Hai fornito un tipo di schema non valido. Il valore valido è: OPEN\_API. | 422 |
| URL dello schema non valido | Fornisci un URL dello schema valido che punti a un bucket S3 di proprietà di Marketplace. | 422 |
| Protocollo di integrazione non valido | Hai fornito un tipo di protocollo di integrazione non valido. I valori validi sono: MCP, A2A. | 422 |
| Troppi protocolli di integrazione | Non è possibile fornire più di 2 protocolli di integrazione. | 422 |
| Istruzioni d'uso non valide | Le istruzioni per l'uso superano la lunghezza massima di 30.000 caratteri. | 422 |
**Errori asincroni**
| Codice di errore | Messaggio di errore |
| --- | --- |
| OPZIONI\_DI\_CONSEGNA DUPLICATE | Hai fornito uno o più tipi di opzioni di consegna già esistenti per questo prodotto. Fornisci un tipo o un utilizzo di un'opzione di consegna univoca `UpdateDeliveryOptions` se intendi modificare un'opzione di consegna esistente. |
| INVALID\_FULFILLMENT\_URL | L'URL che hai fornito ha restituito il codice di stato HTTP [x]. Fornisci un URL di evasione visualizzato con 200. |
| INVALID\_ENDPOINT\_URL | L'URL che hai fornito ha restituito il codice di stato HTTP [x]. Fornisci un URL dell'endpoint che venga visualizzato con 200. |
| INVALID\_SCHEMA\_URL | L'URL dello schema che hai fornito non è valido o è inaccessibile. Fornisci un URL di schema valido che punti a un bucket Amazon S3 di proprietà di. Marketplace AWS |
### Aggiorna le opzioni di consegna
Puoi utilizzare l'API Catalog per aggiornare le opzioni di consegna per un prodotto SaaS in. Marketplace AWS
Per aggiornare le opzioni di consegna, richiama l'operazione `StartChangeSet` API con il tipo di `UpdateDeliveryOptions` modifica, come mostrato nell'esempio seguente.
**Nota**
Questo supporta il tipo `ApiDeliveryOptionDetails` di opzione di consegna. È necessario fornire l'ID dell'opzione di consegna per identificare l'opzione da aggiornare.
**Sintassi della richiesta**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet": [
{
"ChangeType": "UpdateDeliveryOptions",
"Entity": {
"Identifier": "{{example1-abcd-1234-5ef6-7890abcdef12@1}}",
"Type": "SaaSProduct@1.0"
},
"DetailsDocument": {
"DeliveryOptions": [
{
"Id": "{{do-1234567891234567891234}}",
"Details": {
"ApiDeliveryOptionDetails": {
"ApiType": "AGENT",
"QuickLaunchEnabled": true,
"FulfillmentUrl": "{{https://example.com/fulfillment-updated}}",
"UsageInstructions": "# {{Updated Getting Started}}\\n\\n{{To use this updated API:}}\\n{{1. Register for an API key}}\\n{{2. Configure your endpoint}}\\n{{3. Start making requests}}",
"CompatibleServices": ["Bedrock-AgentCore"],
"Endpoints": [
{
"Name": "GenerateContent",
"EndpointUrl": "{{https://api.example.com/v2/generate}}",
"Description": "{{Generate content using updated AI models}}",
"AuthorizationTypes": ["API_KEY", "OAUTH2"],
"Schemas": [{
"Type": "OPEN_API",
"SchemaUrl": "{{https://example.com/schemas/updated-schema.json}}"
}],
"IntegrationProtocols": [
{
"Type": "MCP",
"UsageInstructions": "{{Connect using Model Context Protocol for seamless integration}}"
}
]
}
]
}
}
}
]
}
}
]
}
```
Fornisci informazioni sui campi per aggiornare il tipo di `UpdateDeliveryOptions` modifica con le opzioni di consegna dell'API:
+ `Entity`(oggetto) (richiesto) — Il tuo SaaS-based prodotto.
+ `Identifier`(stringa) (obbligatorio) — L'ID del prodotto. Per ulteriori informazioni, consulta Identifier.
+ `Type`(stringa) (obbligatorio): il tipo si basa sul metodo di spedizione (tipo di prodotto) che verrà utilizzato dal prodotto:`SaaSProduct@1.0`.
+ `DetailsDocument`(oggetto) (obbligatorio) — Dettagli della richiesta.
+ `DeliveryOptions`(array) — Contiene i dettagli delle opzioni di distribuzione dell'API in fase di aggiornamento.
+ `Id`(string) (obbligatorio) — Identificatore univoco per. DeliveryOption (Ottieni l'identificatore univoco di DeliveryOption chiamando l'`DescribeEntity`azione sul prodotto che stai aggiornando.)
+ `Details`(oggetto): contiene l'opzione `ApiDeliveryOptionDetails` di consegna da aggiornare.
+ `ApiDeliveryOptionDetails`(oggetto): contiene i dettagli dell'opzione di consegna dell'API per il prodotto SaaS.
+ `ApiType`(stringa) (obbligatorio): tipo di offerta API. Valori validi: `MCP_SERVER`, `KNOWLEDGE_BASE`, `AGENT`, `GUARDRAIL`, `OTHER`.
+ `QuickLaunchEnabled`(boolean) (obbligatorio): determina se gli acquirenti possono utilizzare Quick Launch per configurare e avviare il software.
+ `FulfillmentUrl`(string) (obbligatorio) — L'URL da aggiornare per il prodotto SaaS.
+ `UsageInstructions`(string) (richiesto) — Istruzioni per l'utilizzo di questa opzione di distribuzione dell'API. Supporta la formattazione markdown. Massimo 30.000 caratteri.
+ `CompatibleServices`(array) (opzionale): servizi AWS supportati per questa opzione di distribuzione. Attualmente supporta`Bedrock-AgentCore`.
+ `Endpoints`(array) (obbligatorio): gli endpoint API disponibili per questa offerta. Deve contenere esattamente un endpoint.
+ `Name`(string) (opzionale) — Il nome dell'endpoint dell'API.
+ `EndpointUrl`(string) (obbligatorio) — L'URL dell'endpoint API da aggiornare.
+ `Description`(string) (opzionale) — Una descrizione dell'endpoint API e della sua funzionalità.
+ `AuthorizationTypes`(array) (obbligatorio) — I tipi di autorizzazione richiesti per accedere all'endpoint dell'API. Valori validi: `API_KEY`, `OAUTH2`.
+ `Schemas`(array) (opzionale) — Le specifiche dello schema per l'endpoint API.
+ `Type`(string) (obbligatorio) — Tipo di schema. Valore valido: `OPEN_API`.
+ `SchemaUrl`(string) (obbligatorio) — L'URL S3 dello schema aggiornato.
+ `IntegrationProtocols`(array) (opzionale) — Tipi di protocollo supportati dall'endpoint.
+ `Type`(stringa) (obbligatorio) — Identificatore del protocollo. Valori validi: `MCP`, `A2A`.
+ `UsageInstructions`(string) (obbligatorio) — Istruzioni aggiuntive per l'utilizzo del protocollo con l'endpoint.
**Sintassi della risposta**
```
{
"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 nell'API Catalog con l'`DescribeChangeSet`azione. Portale di gestione Marketplace AWS
**Convalide sincrone**
| Condizione di errore | Messaggio | Codice HTTP |
| --- | --- | --- |
| ID delle opzioni di consegna vuoti | I dettagli forniti non sono validi. La stringa "in/non DeliveryOptions/0/Id corrisponde all'espressione regolare richiesta dello schema, '^do- [a-z] \+$' A-Z0-9 | 422 |
| ID delle opzioni di consegna mancanti | I dettagli forniti non sono validi. JSON in/DeliveryOptions/0 non ha le proprietà obbligatorie: ['Id']. | 422 |
| ID delle opzioni di consegna duplicati | Fornisci ID univoci delle opzioni di consegna. | 422 |
| Url di evasione non valido | Fornisci un URL di evasione valido che inizi con «https://». | 422 |
| ID delle opzioni di consegna non validi | Fornisci gli ID delle opzioni di consegna che puoi trovare nel prodotto. ID non trovati: [x] | 422 |
| Molteplici opzioni di consegna degli URL | Hai fornito più di un'opzione di consegna degli URL. Fornisci un'opzione di consegna degli URL. | 422 |
| ID delle opzioni di consegna mancanti | Manca l'ID dell'opzione di consegna. Fornisci uno o più ID delle opzioni di consegna validi che desideri aggiornare o utilizza AddDeliveryOptions se intendi aggiungere una nuova opzione di consegna. | 422 |
| URL di avvio non valido | Fornisci un URL di lancio valido che inizia con «https://». | 422 |
| Url di lancio mancante | Manca LaunchUrl il parametro richiesto. È necessario fornire unLaunchUrl. | 422 |
| Modelli di distribuzione mancanti | Il modello di distribuzione è mancante. Fornisci almeno un modello di distribuzione. | 422 |
| Troppi modelli di distribuzione | Non è possibile fornire più di 20 modelli di distribuzione. | 422 |
| URL del modello non valido | L'URL di avvio rapido non è valido. Fornisci l'URL del modello di distribuzione pubblicato tramite AWS QuickStarts su Amazon S3. URL dei modelli di distribuzione non valido: [x] | 422 |
| Nome dello stack del modello di distribuzione non valido | Il nome dello stack del modello di distribuzione non è valido. Fornisci un nome di stack valido utilizzando solo caratteri alfanumerici e trattini. Deve iniziare con un carattere alfabetico e non può superare i 128 caratteri. | 422 |
| Titolo del modello di distribuzione duplicato | Hai fornito titoli di modelli di distribuzione duplicati. Fornisci titoli di modelli di distribuzione unici. | 422 |
| URL del modello di distribuzione duplicato | Hai fornito URL dei modelli di distribuzione duplicati. Fornisci URL dei modelli di distribuzione univoci. | 422 |
| Tipo di modello di distribuzione non valido | Il tipo di modello di distribuzione non è valido. Fornisci un tipo di modello di distribuzione valido. I valori supportati sono [» CloudFormation @1 .0"]. | 422 |
| Modello di distribuzione non valido (politica IAM) | La policy IAM del modello di distribuzione non è valida. Fornisci una policy IAM valida. | 422 |
| Istruzioni d'uso non valide | [See the AWS documentation website for more details](http://docs.aws.amazon.com/it_it/marketplace/latest/developerguide/work-with-saas-products.html) | 422 |
**Errori asincroni**
| Codice di errore | Messaggio di errore |
| --- | --- |
| INVALID\_DELIVERY\_OPTION\_IDS | Fornisci gli ID delle opzioni di consegna che possono essere trovati nel prodotto. ID non trovati: [x] |
| ERRORE\_DI AUDIT | AWS Elenco degli audit di MP Catalog - team CQ |
| INVALID\_FULFILLMENT\_URL | L'URL che hai fornito ha restituito il codice di stato HTTP [x]. Fornisci un URL di evasione visualizzato con 200. |
| INVALID\_LAUNCH\_URL | L'URL che hai fornito ha restituito il codice di stato HTTP [x]. Fornisci un URL di avvio che venga visualizzato con 200. |
| INVALID\_TEMPLATE\_URL | L'URL di avvio rapido non è valido. Fornisci l'URL del modello di distribuzione pubblicato su Amazon S3. AWS QuickStarts URL dei modelli di distribuzione non valido: [x] |
### Aggiorna la visibilità delle opzioni di consegna
Puoi utilizzare l'API Catalog per configurare le autorizzazioni in modo che solo alcuni utenti possano modificare la visibilità di un prodotto SaaS. Marketplace AWS
Per configurare le autorizzazioni in modo che solo alcuni utenti possano modificare la visibilità di un prodotto SaaS, chiama `StartChangeSet` l'operazione API con `UpdateDeliveryOptionsVisibility` il tipo di modifica, come illustrato nell'esempio seguente.
**Nota**
Questo è supportato solo per un'opzione di consegna:. `SaaSUrlDeliveryOptionDetails`
**Sintassi della richiesta**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet":
[
{
"ChangeType": "UpdateDeliveryOptionsVisibility",
"Entity":
{
"Identifier": "{{prod-example12345}}",
"Type": "SaaSProduct@1.0"
},
"DetailsDocument":
{
"DeliveryOptions":
[
{
"Id": "do-{{1234567891234567891234}}",
"TargetVisibility": "Public"
},
{
"Id": "do-{{43210987654321}}",
"TargetVisibility": "Limited",
"Targeting":
{
"PositiveTargeting":
{
"BuyerAccounts":
[
"{{123456789012}}"
]
}
}
}
]
}
}
]
}
```
Fornisci informazioni sui campi per aggiungere il tipo di `UpdateDeliveryOptionsVisibility` modifica:
+ `Entity`(oggetto) (obbligatorio): il tuo SaaS-based prodotto.
+ `Identifier`(stringa) (obbligatorio) — L'ID del prodotto. Per ulteriori informazioni, consulta [Identificatore](catalog-apis.md#identifier).
+ `Type`(stringa) (obbligatorio) - `Type` Si basa sul metodo di consegna (tipo di prodotto) che verrà utilizzato dal prodotto:`SaaSProduct@1.0`.
+ `DetailsDocument`(oggetto) (obbligatorio) — Dettagli della richiesta.
+ `DeliveryOptions`(array) — Elenco di `DeliveryOptions` da aggiornare.
+ `TargetVisibility`(stringa) — L'ID dell'opzione di consegna da aggiornare.
+ `TargetVisibility`(string) — La nuova visibilità prevista dell'opzione di consegna.
Valori possibili: `Limited`, `Public` e `Unavailable`.
**Nota**
Esiste sempre esattamente un'opzione `Public` di consegna e al massimo un'opzione di `Limited` consegna.
+ `Targeting`(oggetto) *opzionale*: impostazione mirata dell'opzione di consegna, utilizzata insieme allo stato di `Limited` visibilità per testare la nuova opzione di consegna prima di modificarla in. `Public`
+ `PositiveTargeting`(oggetto) — Specificazione del targeting inclusivo.
+ `BuyerAccounts`(matrice di stringhe): l'elenco degli Account AWS ID acquirente che potranno utilizzare la nuova opzione di consegna.
Dimensione minima: 0. Dimensione massima: 100.
**Sintassi della risposta**
```
{
"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 nell'API Catalog con l'`DescribeChangeSet`azione. Portale di gestione Marketplace AWS
**Convalide sincrone**
| Condizione di errore | Messaggio | Codice HTTP |
| --- | --- | --- |
| ID delle opzioni di consegna mancanti | Manca l'ID dell'opzione di consegna. Fornisci uno o più ID delle opzioni di consegna validi che desideri aggiornare o utilizza AddDeliveryOptions se intendi aggiungere una nuova opzione di consegna. | 422 |
| Visibilità non valida | Hai fornito un'opzione non valida per. TargetVisibility Le opzioni consentite sono:Limited,Public,Unavailable. | 422 |
| Targeting non valido | Hai fornito un'opzione non valida per. PositiveTargeting È necessario fornire un parametro valido perBuyerAccounts. | 422 |
| Visibilità e targeting mancanti | Hai fornito dettagli sulla visibilità dell'opzione di consegna non validi. È necessario fornire un parametro valido per almeno uno dei TargetVisibility oTargeting. | 422 |
| Troppi Account AWS ID | Non puoi fornire più di 100 account acquirente mirati. | 422 |
**Errori asincroni**
| Codice di errore | Messaggio di errore |
| --- | --- |
| INVALID\_DELIVERY\_OPTION\_IDS | Hai fornito dettagli sull'opzione di consegna non validi. Fornisci gli ID delle opzioni di spedizione che puoi trovare nel prodotto. ID non trovati: [x] |
| INVALID\_VISIBILITY | Hai fornito più di un'opzione di consegna per lo stato pubblico. Fornisci una sola opzione di consegna pubblica. |
| INVALID\_VISIBILITY | Non hai fornito un'opzione di consegna pubblica. Fornisci un'opzione di consegna pubblica. |
| AUDIT\_ERROR | Varia in base alla revisione manuale MCO. |
## SaaSUrlDeliveryOption
L'esempio seguente mostra come utilizzare `SaaSUrlDeliveryOptionDetails` per aggiornare il`FulfillmentUrl`.
**Sintassi della richiesta**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet": [
{
"ChangeType": "UpdateDeliveryOptions",
"Entity": {
"Identifier": "{{example1-abcd-1234-5ef6-7890abcdef12@1}}",
"Type": "SaaSProduct@1.0"
},
"DetailsDocument": {
"DeliveryOptions": [
{
"Id": "do-{{1234567891234567891234}}",
"Details": {
"SaaSUrlDeliveryOptionDetails": {
"FulfillmentUrl": "https://www.aws.amazon.com/marketplace/management",
"LaunchUrl": "{{URL}}",
"UsageInstructions": "{{Instructions}}",
"DeploymentTemplates": [
{
"Title": "{{CloudFormation Template 123}}",
"Description": "{{CloudFormation description}}",
"IamPolicy": "{\"Version\":\"2012-10-17\", \"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"s3:Get*\",\"s3:List*\"],\"Resource\":\n[\"arn:aws:s3:::amzn-s3-demo-bucket\",\"arn:aws:s3:::amzn-s3-demo-bucket/*\"]}]}"
}
]
}
}
}
]
}
}
]
}
```
Fornisci informazioni sui campi in cui aggiungere il tipo di `AddDeliveryOptions` modifica:
+ `Entity`(oggetto) (obbligatorio): il tuo SaaS-based prodotto.
+ `Identifier`(stringa) (obbligatorio) — L'ID del prodotto. Per ulteriori informazioni, consulta [Identificatore](catalog-apis.md#identifier).
+ `Type`(stringa) (obbligatorio) - `Type` Si basa sul metodo di consegna (tipo di prodotto) che verrà utilizzato dal prodotto:`SaaSProduct@1.0`.
+ **DetailsDocument**(oggetto) (obbligatorio) — Dettagli della richiesta.
+ `DeliveryOptions`(array) — Contiene i dettagli delle opzioni di consegna in fase di aggiornamento.
+ `TargetVisibility`(stringa) — Identificatore univoco per. `DeliveryOption` (Ottieni l'identificatore univoco di `DeliveryOption` richiamando l'`DescribeEntity`azione sul prodotto che stai aggiornando.)
+ `Details`(oggetto): contiene l'opzione `SaaSUrlDeliveryOptionDetails` di consegna da aggiornare.
+ `SaaSUrlDeliveryOptionDetails`(oggetto) — Contiene un'opzione `FulfillmentUrl` di consegna per il prodotto SaaS.
+ `FulfillmentUrl`(stringa) — L'URL da aggiornare per il prodotto SaaS.
+ `LaunchUrl`(stringa) — L'URL della pagina di destinazione del tuo prodotto SaaS. Questo è necessario se `QuickLaunchEnabled` è impostato su `True`.
+ `UsageInstructions`(stringa) — Istruzioni per l'utilizzo di questa opzione di consegna. Includi la documentazione relativa ai passaggi manuali per i clienti che non intendono utilizzarla`DeploymentTemplates`.
+ `DeploymentTemplates`(array): modelli di implementazione che i clienti possono utilizzare per configurare e configurare il prodotto SaaS e tutte le risorse correlate. AWS
+ `Title`(stringa) — Il nome visualizzato del modello di distribuzione.
+ `Description`(stringa) — Una descrizione del contenuto del modello di distribuzione.
+ `IamPolicy`(stringa) — Una policy IAM che descrive le autorizzazioni necessarie per distribuire il modello. Gli acquirenti possono utilizzare questa policy IAM per implementare rapidamente il modello.
+ `CloudFormationDetails`(oggetto): i dettagli di un CloudFormation modello.
+ `TemplateUrl`(stringa) — L'URL per il modello di distribuzione.
+ `DefaultStackName`(stringa) — Il nome predefinito utilizzato CloudFormation quando il cliente crea il modello.
**Sintassi della risposta**
```
{
"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 nell'API Catalog con l'`DescribeChangeSet`azione. Portale di gestione Marketplace AWS
**Convalide sincrone**
| Condizione di errore | Messaggio | Codice HTTP |
| --- | --- | --- |
| ID delle opzioni di consegna vuoti | I dettagli forniti non sono validi. La stringa "in/non DeliveryOptions/0/Id corrisponde all'espressione regolare richiesta dello schema, '^do- [a-z] \+$' A-Z0-9 | 422 |
| ID delle opzioni di consegna mancanti | I dettagli forniti non sono validi. JSON in/DeliveryOptions/0 non ha le proprietà obbligatorie: ['Id']. | 422 |
| ID delle opzioni di consegna duplicati | Fornisci ID univoci delle opzioni di consegna. | 422 |
| Url di evasione non valido | Fornisci un URL di evasione valido che inizi con «https://». | 422 |
| ID delle opzioni di consegna non validi | Fornisci gli ID delle opzioni di consegna che puoi trovare nel prodotto. ID non trovati: [x] | 422 |
| Molteplici opzioni di consegna degli URL | Hai fornito più di un'opzione di consegna degli URL. Fornisci un'opzione di consegna degli URL. | 422 |
| ID delle opzioni di consegna mancanti | Manca l'ID dell'opzione di consegna. Fornisci uno o più ID delle opzioni di consegna validi che desideri aggiornare o utilizza AddDeliveryOptions se intendi aggiungere una nuova opzione di consegna. | 422 |
| URL di avvio non valido | Fornisci un URL di lancio valido che inizia con «https://». | 422 |
| Url di lancio mancante | Manca LaunchUrl il parametro richiesto. È necessario fornire unLaunchUrl. | 422 |
| Modelli di distribuzione mancanti | Il modello di distribuzione è mancante. Fornisci almeno un modello di distribuzione. | 422 |
| Troppi modelli di distribuzione | Non è possibile fornire più di 20 modelli di distribuzione. | 422 |
| URL del modello non valido | L'URL di avvio rapido non è valido. Fornisci l'URL del modello di distribuzione pubblicato tramite AWS QuickStarts su Amazon S3. URL dei modelli di distribuzione non valido: [x] | 422 |
| Nome dello stack del modello di distribuzione non valido | Il nome dello stack del modello di distribuzione non è valido. Fornisci un nome di stack valido utilizzando solo caratteri alfanumerici e trattini. Deve iniziare con un carattere alfabetico e non può superare i 128 caratteri. | 422 |
| Titolo del modello di distribuzione duplicato | Hai fornito titoli di modelli di distribuzione duplicati. Fornisci titoli di modelli di distribuzione unici. | 422 |
| URL del modello di distribuzione duplicato | Hai fornito URL dei modelli di distribuzione duplicati. Fornisci URL dei modelli di distribuzione univoci. | 422 |
| Tipo di modello di distribuzione non valido | Il tipo di modello di distribuzione non è valido. Fornisci un tipo di modello di distribuzione valido. I valori supportati sono [» CloudFormation @1 .0"]. | 422 |
| Modello di distribuzione non valido (politica IAM) | La policy IAM del modello di distribuzione non è valida. Fornisci una policy IAM valida. | 422 |
| Istruzioni d'uso non valide | [See the AWS documentation website for more details](http://docs.aws.amazon.com/it_it/marketplace/latest/developerguide/work-with-saas-products.html) | 422 |
**Errori asincroni**
| Codice di errore | Messaggio di errore |
| --- | --- |
| INVALID\_DELIVERY\_OPTION\_IDS | Fornisci gli ID delle opzioni di consegna che possono essere trovati nel prodotto. ID non trovati: [x] |
| ERRORE\_DI AUDIT | AWS Elenco degli audit di MP Catalog - team CQ |
| INVALID\_FULFILLMENT\_URL | L'URL che hai fornito ha restituito il codice di stato HTTP [x]. Fornisci un URL di evasione visualizzato con 200. |
| INVALID\_LAUNCH\_URL | L'URL che hai fornito ha restituito il codice di stato HTTP [x]. Fornisci un URL di avvio che venga visualizzato con 200. |
| INVALID\_TEMPLATE\_URL | L'URL di avvio rapido non è valido. Fornisci l'URL del modello di distribuzione pubblicato su Amazon S3. AWS QuickStarts URL dei modelli di distribuzione non valido: [x] |
### Aggiorna la visibilità delle opzioni di consegna
Puoi utilizzare l'API Catalog per configurare le autorizzazioni in modo che solo alcuni utenti possano modificare la visibilità di un prodotto SaaS. Marketplace AWS
A tale scopo, richiama l'operazione `StartChangeSet` API con il tipo di `UpdateDeliveryOptionsVisibility` modifica, come illustrato nell'esempio seguente.
**Nota**
Questa opzione è supportata solo per un'opzione di consegna:`SaaSUrlDeliveryOptionDetails`.
**Sintassi della richiesta**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet":
[
{
"ChangeType": "UpdateDeliveryOptionsVisibility",
"Entity":
{
"Identifier": "{{prod-example12345}}",
"Type": "SaaSProduct@1.0"
},
"DetailsDocument":
{
"DeliveryOptions":
[
{
"Id": "do-{{1234567891234567891234}}",
"TargetVisibility": "Public"
},
{
"Id": "do-{{43210987654321}}",
"TargetVisibility": "Limited",
"Targeting":
{
"PositiveTargeting":
{
"BuyerAccounts":
[
"{{123456789012}}"
]
}
}
}
]
}
}
]
}
```
Fornisci informazioni sui campi per aggiungere il tipo di `UpdateDeliveryOptionsVisibility` modifica:
+ `Entity`(oggetto) (obbligatorio): il tuo SaaS-based prodotto.
+ `Identifier`(stringa) (obbligatorio) — L'ID del prodotto. Per ulteriori informazioni, consulta [Identificatore](catalog-apis.md#identifier).
+ `Type`(stringa) (obbligatorio) - `Type` Si basa sul metodo di consegna (tipo di prodotto) che verrà utilizzato dal prodotto:`SaaSProduct@1.0`.
+ `DetailsDocument`(oggetto) (obbligatorio) — Dettagli della richiesta.
+ `DeliveryOptions`(array) — Elenco di `DeliveryOptions` da aggiornare.
+ `TargetVisibility`(stringa) — L'ID dell'opzione di consegna da aggiornare.
+ `TargetVisibility`(string) — La nuova visibilità prevista dell'opzione di consegna.
Valori possibili: `Limited`, `Public` e `Unavailable`.
**Nota**
Esiste sempre esattamente un'opzione `Public` di consegna e al massimo un'opzione di `Limited` consegna.
+ `Targeting`(oggetto) *opzionale*: impostazione mirata dell'opzione di consegna, utilizzata insieme allo stato di `Limited` visibilità per testare la nuova opzione di consegna prima di modificarla in. `Public`
+ `PositiveTargeting`(oggetto) — Specificazione del targeting inclusivo.
+ `BuyerAccounts`(matrice di stringhe): l'elenco degli Account AWS ID acquirente che potranno utilizzare la nuova opzione di consegna.
Dimensione minima: 0. Dimensione massima: 100.
**Sintassi della risposta**
```
{
"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 nell'API Catalog con l'`DescribeChangeSet`azione. Portale di gestione Marketplace AWS
**Convalide sincrone**
| Condizione di errore | Messaggio | Codice HTTP |
| --- | --- | --- |
| ID delle opzioni di consegna mancanti | Manca l'ID dell'opzione di consegna. Fornisci uno o più ID delle opzioni di consegna validi che desideri aggiornare o utilizza AddDeliveryOptions se intendi aggiungere una nuova opzione di consegna. | 422 |
| Visibilità non valida | Hai fornito un'opzione non valida per. TargetVisibility Le opzioni consentite sono:Limited,Public,Unavailable. | 422 |
| Targeting non valido | Hai fornito un'opzione non valida per. PositiveTargeting È necessario fornire un parametro valido perBuyerAccounts. | 422 |
| Visibilità e targeting mancanti | Hai fornito dettagli sulla visibilità dell'opzione di consegna non validi. È necessario fornire un parametro valido per almeno uno dei TargetVisibility oTargeting. | 422 |
| Troppi Account AWS ID | Non puoi fornire più di 100 account acquirente mirati. | 422 |
**Errori asincroni**
| Codice di errore | Messaggio di errore |
| --- | --- |
| INVALID\_DELIVERY\_OPTION\_IDS | Hai fornito dettagli sull'opzione di consegna non validi. Fornisci gli ID delle opzioni di spedizione che puoi trovare nel prodotto. ID non trovati: [x] |
| INVALID\_VISIBILITY | Hai fornito più di un'opzione di consegna per lo stato pubblico. Fornisci una sola opzione di consegna pubblica. |
| INVALID\_VISIBILITY | Non hai fornito un'opzione di consegna pubblica. Fornisci un'opzione di consegna pubblica. |
| AUDIT\_ERROR | Varia in base alla revisione manuale MCO. |