L'API Reference di AWS Marketplace è 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 SaaS utilizzando Marketplace AWS API
Puoi utilizzarlo 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). Gli argomenti seguenti 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 o due. UsageBasedPricingTerm ConfigurableUpfrontPricingTerm
**Nota**
Il requisito del modello di prezzo gratuito per i prodotti SaaS è unico. Per i prodotti SaaS con prezzi gratuiti, è necessario creare almeno una dimensione con 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 le dimensioni dei prezzi per il tuo prodotto utilizzando il tipo di `AddDimensions` modifica. Per ulteriori informazioni, consulta [Aggiungi dimensioni di prezzo](work-with-seller-products.md#add-dimensions) la documentazione sui prodotti del venditore.
1. Crea un'offerta `PricingModel` impostata su `Free` e includi uno `UsageBasedPricingTerm` o tutti i prezzi `ConfigurableUpfrontPricingTerm` di dimensione 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)
Quando configuri l'offerta, assicurati che:
+ Tutti i prezzi delle carte tariffarie `UsageBasedPricingTerm` sono impostati su «0,00" (formato stringa)
+ Tutti gli importi degli `ConfigurableUpfrontPricingTerm` addebiti in 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, vedi [ Configurazione e avvio dei prodotti Saas tramite Quick Launch ](https://docs.aws.amazon.com/marketplace/latest/buyerguide/saas-quick-launch.html) nella Guida all'acquisto. *Marketplace AWS *
+ (Venditori) Per le opzioni Quick Launch per i prodotti SaaS, consulta [ Configurare Quick Launch ](https://docs.aws.amazon.com/marketplace/latest/userguide/saas-product-settings.html#saas-quick-launch) nella Guida per i venditori. *Marketplace AWS *
+ Per un seminario Quick Launch per i prodotti SaaS, vedi [ Lab: Enable SaaS Quick Launch ](https://catalog.workshops.aws/mpseller/en-US/saas/quick-launch-integration) nel workshop del *Marketplace AWS venditore. *
## Aggiungi opzioni di consegna
Puoi utilizzare l'API del catalogo 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 per i flussi di lavoro degli agenti AI.
Per aggiungere opzioni di consegna API, richiama 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 l'uso delle `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/{tenantId}/generate}}",
"EndpointType": "DYNAMIC",
"EndpointUrlParameters": [
{
"Name": "tenantId",
"Description": "{{The unique identifier for the buyer's tenant}}",
"DefaultValue": "{{default}}"
}
],
"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 per i campi per aggiungere il tipo di `AddDeliveryOptions` modifica:
+ `Entity`(oggetto) (obbligatorio): il tuo SaaS-based prodotto.
+ `Identifier`(string) (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 delle opzioni di consegna delle API che vengono aggiunte.
+ `Details`(oggetto) — Contiene l'opzione `ApiDeliveryOptionDetails` di consegna da aggiungere.
+ `ApiDeliveryOptionDetails`(oggetto) — Contiene i dettagli dell'opzione di consegna dell'API per un prodotto SaaS.
+ `ApiType`(string) (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 della pagina di destinazione per la registrazione del software del venditore.
+ `UsageInstructions`(string) (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 API. Deve corrispondere al modello. `^[A-Za-z][a-zA-Z0-9-]+$` Massimo 100 caratteri.
+ `EndpointUrl`(string) (obbligatorio) — L'URL dell'endpoint API. Deve essere un URL HTTPS valido. Può contenere parametri segnaposto utilizzando la `{paramName}` sintassi when is. `EndpointType` `DYNAMIC`
+ `EndpointType`(string) (opzionale) — Il tipo di endpoint. Valori validi: `STATIC`, `DYNAMIC`. Da utilizzare `DYNAMIC` per gli endpoint con parametri segnaposto che si risolvono in valori specifici dell'acquirente. Richiede e imposta su. `EndpointUrlParameters` `QuickLaunchEnabled` `true`
+ `EndpointUrlParameters`(array) (opzionale) — I parametri segnaposto in un URL di endpoint dinamico. Obbligatorio quando è. `EndpointType` `DYNAMIC` Limitato a 1-5 parametri.
+ `Name`(string) (obbligatorio) — Il nome del parametro. Deve corrispondere a un `{paramName}` segnaposto in. `EndpointUrl` Deve corrispondere al modello. `^[a-zA-Z][a-zA-Z0-9_]*$` Massimo 100 caratteri.
+ `Description`(string) (opzionale) — Una descrizione del parametro. Massimo 1.000 caratteri.
+ `DefaultValue`(string) (opzionale): il valore predefinito per il parametro fino a quando il venditore non fornisce un valore. Deve corrispondere al modello`^[a-zA-Z0-9._~-]+$`. Massimo 256 caratteri.
+ `Description`(string) (opzionale) — Una descrizione dell'endpoint API e della sua funzionalità. Massimo 4.000 caratteri.
+ `AuthorizationTypes`(array) (obbligatorio) — I tipi di autorizzazione richiesti per accedere all'endpoint API. Valori validi: `API_KEY`, `OAUTH2`. Deve contenere 1-2 valori univoci.
+ `Schemas`(array) (opzionale) — Le specifiche dello schema per l'endpoint 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 del protocollo. Valori validi: `MCP`, `A2A`.
+ `UsageInstructions`(string) (obbligatorio) — Istruzioni aggiuntive per l'utilizzo del protocollo con l'endpoint. Massimo 30.000 caratteri.
****Sintassi della risposta ** **
Viene creato un set di modifiche per la tua richiesta. La risposta a questa richiesta fornisce l'ID del set di modifiche ed è simile al 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 | Manca un parametro obbligatorio. È necessario fornire ApiType, QuickLaunchEnabled FulfillmentUrl UsageInstructions, ed Endpoints. | 422 |
| URL dell'endpoint non valido | Fornisci un URL dell'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 |
| Tipo di endpoint non valido | EndpointType deve essere STATICO o DINAMICO. | 422 |
| Parametri URL dell'endpoint obbligatori | EndpointUrlParameters è obbligatorio quando EndpointType è DYNAMIC. | 422 |
| Parametri URL dell'endpoint vietati | EndpointUrlParameters non è consentito quando EndpointType è STATICO o assente. | 422 |
| Conteggio dei parametri URL dell'endpoint non validi | EndpointUrlParameters deve contenere da 1 a 5 parametri. | 422 |
| Parametro URL dell'endpoint non valido | EndpointUrlParameters contiene una voce non valida. Verifica che il nome inizi con una lettera (solo lettere, cifre, trattini bassi) e DefaultValue utilizzi solo caratteri non riservati. | 422 |
| Nomi dei parametri URL degli endpoint duplicati | EndpointUrlParameters non deve contenere nomi di parametri duplicati. | 422 |
| L'endpoint dinamico richiede un avvio rapido | QuickLaunchEnabled deve essere vero quando EndpointType è DINAMICO. | 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 di 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 |
| --- | --- |
| DUPLICATE\_DELIVERY\_OPTIONS | Hai fornito uno o più tipi di opzioni di spedizione già esistenti per questo prodotto. Fornisci un tipo di opzione di spedizione univoco o utilizzala `UpdateDeliveryOptions` se intendi modificare un'opzione di spedizione esistente. |
| INVALID\_FULFILLMENT\_URL | L'URL fornito ha restituito il codice di stato HTTP [x]. Fornisci un URL di evasione che venga visualizzato con 200. |
| INVALID\_ENDPOINT\_URL | L'URL 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 fornito non è valido o non è accessibile. 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 del catalogo per aggiornare le opzioni di consegna di 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 spedizione 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/{tenantId}/generate}}",
"EndpointType": "DYNAMIC",
"EndpointUrlParameters": [
{
"Name": "tenantId",
"Description": "{{The unique identifier for the buyer's tenant}}",
"DefaultValue": "{{default}}"
}
],
"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 per i campi per aggiornare il tipo di `UpdateDeliveryOptions` modifica con le opzioni di consegna delle API:
+ `Entity`(oggetto) (obbligatorio) — Il tuo SaaS-based prodotto.
+ `Identifier`(string) (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 consegna delle API in fase di aggiornamento.
+ `Id`(string) (obbligatorio) — Identificatore univoco per. DeliveryOption (Ottieni l'identificatore univoco DeliveryOption richiamando 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`(string) (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) (obbligatorio) — Istruzioni per l'utilizzo di questa opzione di distribuzione 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 API.
+ `EndpointUrl`(string) (obbligatorio) — L'URL dell'endpoint API da aggiornare. Può contenere parametri segnaposto utilizzando la `{paramName}` sintassi when is. `EndpointType` `DYNAMIC`
+ `EndpointType`(string) (opzionale) — Il tipo di endpoint. Valori validi: `STATIC`, `DYNAMIC`. Da utilizzare `DYNAMIC` per gli endpoint con parametri segnaposto che si risolvono in valori specifici dell'acquirente. Richiede `EndpointUrlParameters`.
+ `EndpointUrlParameters`(array) (opzionale) — I parametri segnaposto in un URL di endpoint dinamico. Obbligatorio quando è. `EndpointType` `DYNAMIC` Limitato a 1-5 parametri.
+ `Name`(string) (obbligatorio) — Il nome del parametro. Deve corrispondere a un `{paramName}` segnaposto in. `EndpointUrl` Deve corrispondere al modello. `^[a-zA-Z][a-zA-Z0-9_]*$` Massimo 100 caratteri.
+ `Description`(string) (opzionale) — Una descrizione del parametro. Massimo 1.000 caratteri.
+ `DefaultValue`(string) (opzionale): il valore predefinito per il parametro fino a quando il venditore non fornisce un valore. Deve corrispondere al modello`^[a-zA-Z0-9._~-]+$`. Massimo 256 caratteri. Obbligatorio per qualsiasi parametro nuovo o che in precedenza aveva un valore `DefaultValue` e non lo è più, se il prodotto è già pubblico. Ciò protegge gli acquirenti esistenti da un parametro obbligatorio senza valore predefinito.
+ `Description`(string) (opzionale) — Una descrizione dell'endpoint API e della sua funzionalità.
+ `AuthorizationTypes`(array) (obbligatorio) — I tipi di autorizzazione richiesti per accedere all'endpoint 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`(string) (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 del catalogo 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 "at/DeliveryOptions/0/Idnon corrisponde all'espressione regolare dello schema richiesta, '^do- [a-z] \+$' A-Z0-9 | 422 |
| ID delle opzioni di consegna mancanti | I dettagli forniti non sono validi. JSON in/DeliveryOptions/0 non contiene le proprietà obbligatorie: ['Id']. | 422 |
| ID delle opzioni di consegna duplicati | Fornisci ID univoci per le opzioni di spedizione. | 422 |
| URL di evasione non valido | Fornisci un URL di evasione valido che inizi con «https://». | 422 |
| ID delle opzioni di spedizione non validi | Fornisci gli ID delle opzioni di spedizione che si trovano nel prodotto. ID non trovati: [x] | 422 |
| Diverse opzioni di distribuzione degli URL | Hai fornito più di un'opzione di consegna degli URL. Fornisci un'opzione di consegna degli URL. | 422 |
| L'opzione di consegna mancante è | Manca l'ID dell'opzione di spedizione. Fornisci uno o più ID delle opzioni di spedizione validi che desideri aggiornare o utilizzare AddDeliveryOptions se intendi aggiungere una nuova opzione di spedizione. | 422 |
| URL di avvio non valido | Fornisci un URL di avvio valido che inizi con «https://». | 422 |
| URL di avvio mancante | Manca LaunchUrl un parametro obbligatorio. È necessario fornire unLaunchUrl. | 422 |
| Modelli di distribuzione mancanti | Manca il modello di distribuzione. Fornire 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 ad 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ò contenere più di 128 caratteri. | 422 |
| Titolo del modello di distribuzione duplicato | Hai fornito titoli duplicati per i modelli di distribuzione. Fornisci titoli univoci per i modelli di distribuzione. | 422 |
| URL del modello di distribuzione duplicato | Hai fornito URL duplicati per i modelli di distribuzione. Fornisci URL univoci per i modelli di distribuzione. | 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 (policy IAM) non valida | La policy IAM del modello di distribuzione non è valida. Fornisci una policy IAM valida. | 422 |
| Istruzioni d'uso non valide | + Le immagini non sono supportate dalle istruzioni per l'uso. Rimuovi l'immagine [x].
+ Hai fornito un link a un URL non valido nelle istruzioni per l'uso: [x]. Immetti un URI valido.
+ Hai fornito un link con uno schema URI non supportato nelle istruzioni per l'uso. Usa uno schema supportato: ["http», «https», «tel», «mailto"]. | 422 |
**Errori asincroni **
| Codice di errore | Messaggio di errore |
| --- | --- |
| INVALID\_DELIVERY\_OPTION\_IDS | Fornisci gli ID delle opzioni di spedizione che possono essere trovati nel prodotto. ID non trovati: [x] |
| AUDIT\_ERROR | AWS Elenco degli audit del catalogo MP - team CQ |
| INVALID\_FULFILLMENT\_URL | L'URL fornito ha restituito il codice di stato HTTP [x]. Fornisci un URL di evasione che venga visualizzato con 200. |
| URL\_LAUNCH\_NON VALIDO | L'URL fornito ha restituito il codice di stato HTTP [x]. Fornisci un URL di avvio che venga visualizzato con un 200. |
| URL DEL MODELLO NON VALIDO | L'URL di avvio rapido non è valido. Fornisci l'URL del modello di distribuzione pubblicato tramite AWS QuickStarts Amazon S3. URL dei modelli di distribuzione non valido: [x] |
| DEFAULT\_VALUE\_REQUIRED\_FOR\_NEW\_PARAMETER | L'endpoint '[x]' ha il parametro '[x]' senza. DefaultValue A DefaultValue è necessario quando il prodotto è già pubblico e questo aggiornamento introduce il parametro o rimuove un DefaultValue parametro precedentemente posseduto. Fornire un valore DefaultValue per il parametro. |
### Aggiorna la visibilità delle opzioni di consegna
Puoi utilizzare l'API del catalogo per configurare le autorizzazioni in modo che solo alcuni utenti possano modificare la visibilità di un prodotto SaaS in. Marketplace AWS
Per configurare le autorizzazioni in modo che solo alcuni utenti possano modificare la visibilità di un prodotto SaaS, chiama l'operazione `StartChangeSet` API con il tipo di `UpdateDeliveryOptionsVisibility` modifica, come mostrato 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 per i campi per aggiungere il tipo di `UpdateDeliveryOptionsVisibility` modifica:
+ `Entity`(oggetto) (obbligatorio): il tuo SaaS-based prodotto.
+ `Identifier`(string) (obbligatorio) — L'ID del prodotto. Per ulteriori informazioni, consulta [Identificatore](catalog-apis.md#identifier).
+ `Type`(string) (obbligatorio) — `Type` 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) — Elenco di `DeliveryOptions` quelli da aggiornare.
+ `TargetVisibility`(string) — L'ID dell'opzione di consegna da aggiornare.
+ `TargetVisibility`(string) — La nuova visibilità prevista per l'opzione di consegna.
Valori possibili: `Limited`, `Public` e `Unavailable`.
**Nota**
Esiste sempre esattamente un'opzione `Public` di consegna e un massimo di un'opzione di `Limited` consegna.
+ `Targeting`(object) * opzionale*: destinazione dell'opzione di consegna, utilizzata insieme allo stato di `Limited` visibilità per poter testare la nuova opzione di consegna prima di modificare la visibilità. `Public`
+ `PositiveTargeting`(oggetto) — Specifica un targeting inclusivo.
+ `BuyerAccounts`(matrice di stringhe) — L'elenco degli Account AWS ID dell'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 del catalogo con l'`DescribeChangeSet`azione. Portale di gestione Marketplace AWS
**Convalide sincrone **
| Condizione di errore | Messaggio | Codice HTTP |
| --- | --- | --- |
| L'opzione di consegna mancante è | Manca l'ID dell'opzione di spedizione. Fornisci uno o più ID delle opzioni di spedizione validi che desideri aggiornare o utilizzare AddDeliveryOptions se intendi aggiungere una nuova opzione di spedizione. | 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 spedizione non validi. Devi fornire un parametro valido per almeno uno di 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 si trovano 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 al pubblico. |
| VISIBILITÀ\_NON VALIDA | Non hai fornito un'opzione di consegna pubblica. Fornisci un'opzione di consegna pubblica. |
| ERRORE DI CONTROLLO | Varia in base alla revisione manuale dell'MCO. |
## SaaSUrlDeliveryOption
L'esempio seguente mostra come utilizzare il `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 per i campi per aggiungere il tipo di `AddDeliveryOptions` modifica:
+ `Entity`(oggetto) (obbligatorio): il tuo SaaS-based prodotto.
+ `Identifier`(string) (obbligatorio) — L'ID del prodotto. Per ulteriori informazioni, consulta [Identificatore](catalog-apis.md#identifier).
+ `Type`(string) (obbligatorio) — `Type` 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 consegna in fase di aggiornamento.
+ `TargetVisibility`(string) — Identificatore univoco per. `DeliveryOption` (Ottieni l'identificatore univoco `DeliveryOption` richiamando l'`DescribeEntity`azione sul prodotto che stai aggiornando.)
+ `Details`(oggetto) — Contiene l'opzione `SaaSUrlDeliveryOptionDetails` di consegna da aggiornare.
+ `SaaSUrlDeliveryOptionDetails`(oggetto) — Contiene l'opzione `FulfillmentUrl` di consegna per il prodotto SaaS.
+ `FulfillmentUrl`(stringa) — L'URL da aggiornare per il prodotto SaaS.
+ `LaunchUrl`(string) — L'URL della pagina di destinazione del prodotto SaaS. Questo è necessario se `QuickLaunchEnabled` è impostato su `True`.
+ `UsageInstructions`(string) — Istruzioni per l'utilizzo di questa opzione di consegna. Includi la documentazione per le procedure manuali per i clienti che non intendono utilizzarle`DeploymentTemplates`.
+ `DeploymentTemplates`(array): modelli di distribuzione 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`(string) — Una descrizione del contenuto del modello di distribuzione.
+ `IamPolicy`(string) — Una policy IAM che descrive le autorizzazioni necessarie per distribuire il modello. Gli acquirenti possono utilizzare questa policy IAM per distribuire rapidamente il modello.
+ `CloudFormationDetails`(oggetto): i dettagli di un CloudFormation modello.
+ `TemplateUrl`(string) — L'URL del modello di distribuzione.
+ `DefaultStackName`(string) — 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 del catalogo 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 "at/DeliveryOptions/0/Idnon corrisponde all'espressione regolare dello schema richiesta, '^do- [a-z] \+$' A-Z0-9 | 422 |
| ID delle opzioni di consegna mancanti | I dettagli forniti non sono validi. JSON in/DeliveryOptions/0 non contiene le proprietà obbligatorie: ['Id']. | 422 |
| ID delle opzioni di consegna duplicati | Fornisci ID univoci per le opzioni di spedizione. | 422 |
| URL di evasione non valido | Fornisci un URL di evasione valido che inizi con «https://». | 422 |
| ID delle opzioni di spedizione non validi | Fornisci gli ID delle opzioni di spedizione che si trovano nel prodotto. ID non trovati: [x] | 422 |
| Diverse opzioni di distribuzione degli URL | Hai fornito più di un'opzione di consegna degli URL. Fornisci un'opzione di consegna degli URL. | 422 |
| L'opzione di consegna mancante è | Manca l'ID dell'opzione di spedizione. Fornisci uno o più ID delle opzioni di spedizione validi che desideri aggiornare o utilizzare AddDeliveryOptions se intendi aggiungere una nuova opzione di spedizione. | 422 |
| URL di avvio non valido | Fornisci un URL di avvio valido che inizi con «https://». | 422 |
| URL di avvio mancante | Manca LaunchUrl un parametro obbligatorio. È necessario fornire unLaunchUrl. | 422 |
| Modelli di distribuzione mancanti | Manca il modello di distribuzione. Fornire 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 ad 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ò contenere più di 128 caratteri. | 422 |
| Titolo del modello di distribuzione duplicato | Hai fornito titoli duplicati per i modelli di distribuzione. Fornisci titoli univoci per i modelli di distribuzione. | 422 |
| URL del modello di distribuzione duplicato | Hai fornito URL duplicati per i modelli di distribuzione. Fornisci URL univoci per i modelli di distribuzione. | 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 (policy IAM) non valida | La policy IAM del modello di distribuzione non è valida. Fornisci una policy IAM valida. | 422 |
| Istruzioni d'uso non valide | + Le immagini non sono supportate dalle istruzioni per l'uso. Rimuovi l'immagine [x].
+ Hai fornito un link a un URL non valido nelle istruzioni per l'uso: [x]. Immetti un URI valido.
+ Hai fornito un link con uno schema URI non supportato nelle istruzioni per l'uso. Usa uno schema supportato: ["http», «https», «tel», «mailto"]. | 422 |
**Errori asincroni **
| Codice di errore | Messaggio di errore |
| --- | --- |
| INVALID\_DELIVERY\_OPTION\_IDS | Fornisci gli ID delle opzioni di spedizione che possono essere trovati nel prodotto. ID non trovati: [x] |
| AUDIT\_ERROR | AWS Elenco degli audit del catalogo MP - team CQ |
| INVALID\_FULFILLMENT\_URL | L'URL fornito ha restituito il codice di stato HTTP [x]. Fornisci un URL di evasione che venga visualizzato con 200. |
| URL\_LAUNCH\_NON VALIDO | L'URL fornito ha restituito il codice di stato HTTP [x]. Fornisci un URL di avvio che venga visualizzato con un 200. |
| URL DEL MODELLO NON VALIDO | L'URL di avvio rapido non è valido. Fornisci l'URL del modello di distribuzione pubblicato tramite AWS QuickStarts Amazon S3. URL dei modelli di distribuzione non valido: [x] |
### Aggiorna la visibilità delle opzioni di consegna
Puoi utilizzare l'API del catalogo per configurare le autorizzazioni in modo che solo alcuni utenti possano modificare la visibilità di un prodotto SaaS in. Marketplace AWS
A tale scopo, richiama l'operazione `StartChangeSet` API con il tipo di `UpdateDeliveryOptionsVisibility` modifica, come mostrato 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 per i campi per aggiungere il tipo di `UpdateDeliveryOptionsVisibility` modifica:
+ `Entity`(oggetto) (obbligatorio): il tuo SaaS-based prodotto.
+ `Identifier`(string) (obbligatorio) — L'ID del prodotto. Per ulteriori informazioni, consulta [Identificatore](catalog-apis.md#identifier).
+ `Type`(string) (obbligatorio) — `Type` 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) — Elenco di `DeliveryOptions` quelli da aggiornare.
+ `TargetVisibility`(string) — L'ID dell'opzione di consegna da aggiornare.
+ `TargetVisibility`(string) — La nuova visibilità prevista per l'opzione di consegna.
Valori possibili: `Limited`, `Public` e `Unavailable`.
**Nota**
Esiste sempre esattamente un'opzione `Public` di consegna e un massimo di un'opzione di `Limited` consegna.
+ `Targeting`(oggetto) * opzionale*: destinazione dell'opzione di consegna, utilizzata insieme allo stato di `Limited` visibilità per poter testare la nuova opzione di consegna prima di modificare la visibilità. `Public`
+ `PositiveTargeting`(oggetto) — Specifica un targeting inclusivo.
+ `BuyerAccounts`(matrice di stringhe) — L'elenco degli Account AWS ID dell'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 del catalogo con l'`DescribeChangeSet`azione. Portale di gestione Marketplace AWS
**Convalide sincrone **
| Condizione di errore | Messaggio | Codice HTTP |
| --- | --- | --- |
| L'opzione di consegna mancante è | Manca l'ID dell'opzione di spedizione. Fornisci uno o più ID delle opzioni di spedizione validi che desideri aggiornare o utilizzare AddDeliveryOptions se intendi aggiungere una nuova opzione di spedizione. | 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 spedizione non validi. Devi fornire un parametro valido per almeno uno di 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 si trovano 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 al pubblico. |
| VISIBILITÀ\_NON VALIDA | Non hai fornito un'opzione di consegna pubblica. Fornisci un'opzione di consegna pubblica. |
| ERRORE DI CONTROLLO | Varia in base alla revisione manuale dell'MCO. |