L'AWS Marketplace API Reference è stato ristrutturato. Per ulteriori informazioni sulle operazioni API supportate, consulta l'AWS Marketplace API Reference.
Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.
Lavora con le autorizzazioni di rivendita utilizzando il Marketplace AWS API
Puoi utilizzarli AWS Marketplace Catalog API per automatizzare le attività relative all'utilizzo delle autorizzazioni di rivendita.
Mentre il prodotto descrive ciò che viene venduto Marketplace AWS, l'autorizzazione alla rivendita (nota anche come opportunità) descrive i termini e le regole relativi alle modalità di autorizzazione alla rivendita del prodotto. Marketplace AWS Il CPPO è l'obiettivo dell'autorizzazione alla rivendita.
Un'autorizzazione alla rivendita contiene una raccolta di termini e regole da accettare per un accordo di rivendita tra produttori e partner di canale. L'accettazione dei termini dell'autorizzazione alla rivendita consente al rivenditore di creare offerte per il prodotto secondo le condizioni espresse nei termini.
Esistono due tipi di regole in un'autorizzazione alla rivendita:
-
AvailabilityRule— Controlla il ciclo di vita dell'autorizzazione alla rivendita in. Marketplace AWS
-
PartnerTargetingRule — Speciifica se l'autorizzazione alla rivendita deve essere accessibile a un insieme specifico di partner di canale.
Consulta le seguenti risorse:
-
Per i laboratori completi con esempi di codice funzionanti, consulta Lab: Authorize
a reseller in the seller workshop.Marketplace AWS -
Per esempi di codice di richieste API, consulta Esempi in Python
e Java in AWS Samples on. GitHub -
Per un video sulla creazione di autorizzazioni di rivendita, consulta Creare autorizzazioni di rivendita utilizzando l'API Catalog
su. Marketplace AWS YouTube
I seguenti argomenti descrivono come utilizzare l'API Catalog per creare e aggiornare le autorizzazioni di rivendita:
Prerequisiti per l'autorizzazione alla rivendita
Per utilizzare Resale Authorization, sia i fornitori di software indipendenti (ISV) che i Marketplace AWS Channel Partner devono creare un ruolo collegato al servizio che fornisca le autorizzazioni di condivisione delle risorse a. AWS Se entrambi i gruppi non soddisfano questo prerequisito, non AWS possono condividere la risorsa di autorizzazione dell'ISV con il Channel Partner. Marketplace AWS Per maggiori informazioni, consulta la sezione Utilizzo dei ruoli per l'autorizzazione alla rivendita Marketplace AWS nella Guida al Marketplace AWS venditore.
Crea una nuova autorizzazione alla rivendita
Puoi utilizzare l'API Catalog per creare una nuova autorizzazione di rivendita in. Marketplace AWS
Se la tua richiesta viene elaborata correttamente, AWS Marketplace Catalog API genera un'autorizzazione alla rivendita attiva per Draft te. È un'autorizzazione alla rivendita incompleta e non è visibile ai partner di canale in. Marketplace AWS
Utilizza i tipi di Update modifica per completare l'autorizzazione alla rivendita. Una volta completata l'autorizzazione alla rivendita, utilizza il tipo di ReleaseResaleAuthorization modifica per completare il processo di creazione dell'autorizzazione alla rivendita e rilascia l'autorizzazione alla rivendita, che convaliderà l'intera autorizzazione alla rivendita e la renderà visibile ai partner di canale in. Marketplace AWS
Per creare un'autorizzazione alla rivendita in Draft uno stato, chiamate l'operazione StartChangeSet API con il tipo di CreateResaleAuthorization modifica, come illustrato nell'esempio seguente.
Sintassi della richiesta
POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "CreateResaleAuthorization", "ChangeName": "xyz", "Entity": { "Type": "ResaleAuthorization@1.0" }, "DetailsDocument": { "ProductId": "prod-ad8EXAMPLE51", "Name": "Test ResaleAuthorization", "Description": "Worldwide ResaleAuthorization for Test Product", "ResellerAccountId": "777788889999" } } ] }
Fornisci informazioni per i campi di input per aggiungere il tipo di CreateResaleAuthorization modifica:
-
Entità (oggetto) (obbligatorio): la tua autorizzazione alla rivendita.
-
Tipo (stringa) (obbligatorio):
Typeè sempreResaleAuthorization@1.0.
-
-
DetailsDocument(oggetto) (obbligatorio) — Specifiche della richiesta.
-
ProductId(string) (obbligatorio) — ID del prodotto per il quale creare l'autorizzazione alla rivendita.
-
Nome (stringa) (obbligatorio): nome associato al ResaleAuthorization per una migliore leggibilità per te e i tuoi partner di canale.
-
Descrizione (stringa) (opzionale): un campo di testo in formato libero disponibile per aggiungere dettagli su. ResaleAuthorization
-
ResellerAccountId(stringa) (obbligatorio): aggiungi partner di canale mirati Account AWS che possano descriverlo e
ResaleAuthorizationutilizzarlo per creare un'offerta privata.
-
Sintassi della risposta
Viene creato un set di modifiche per la richiesta. La risposta a questa richiesta fornisce l'ChangeSetIde ChangeSetArn per il set di modifiche ed è simile alla seguente.
{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }
La richiesta di modifica viene aggiunta a una coda ed elaborata.
Puoi controllare lo stato della richiesta tramite o direttamente tramite Portale di gestione Marketplace AWS l'API Catalog utilizzando l'operazione DescribeChangeSet API.
Quando la richiesta è completa (se lo Status èSUCCEEDED), ne ResaleAuthorization viene generata una nuova. Sebbene lo SUCCEEDED stato indichi che la chiamata di CreateResaleAuthorization modifica del tipo è stata completata, lo ResaleAuthorization stato è ancora Draft valido.
Di seguito viene mostrata la risposta dell'operazione DescribeChangeSetAPI.
{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef", "ChangeSetName": "Submitted by 123456789012", "StartTime": "2021-05-27T22:21:26Z", "EndTime": "2021-05-27T22:32:19Z", "Status": "SUCCEEDED", "ChangeSet": [ { "ChangeType": "CreateResaleAuthorization", "Entity": { "Type": "ResaleAuthorization@1.0", "Identifier": "resaleauthz-123456789" }, "DetailsDocument": { "ProductId": "prod-ad8EXAMPLE51", "Name": "Test ResaleAuthorization", "Description": "Worldwide ResaleAuthorization for Test Product", "ResellerAccountId": "777788889999", "BulkRequestId": "84977023-5093-4a66-8b24-ef2c5a2f8b1f" }, "ErrorDetailList": [] } ] }
Convalide sincrone
Le convalide dello schema sono specifiche per CreateResaleAuthorization le azioni in. AWS Marketplace Catalog API Le 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 |
|---|---|---|
| ProductId |
Richiesto Non deve essere nullo o vuoto La lunghezza deve essere compresa tra 1 e 50 caratteri |
422 |
| ProductId | L'utente deve essere autorizzato a creare ResaleAuthorization per il prodotto specificato | 403 |
| ProductId | Deve essere un prodotto esistente nel catalogo e non nello Draft stato Il prodotto deve essere supportato per la rivendita |
404 |
| Nome |
Richiesto Non deve essere nullo o vuoto La lunghezza deve essere compresa tra 1 e 100 caratteri Non sono consentiti caratteri speciali |
422 |
| Description |
Facoltativo La lunghezza deve essere compresa tra 1 e 255 caratteri Non sono consentiti caratteri speciali |
422 |
| ResellerAccountId |
Richiesto Non deve essere vuoto Account AWS Gli ID devono essere in formato valido (numero a 12 cifre) |
422 |
| BulkRequestId |
Facoltativo La lunghezza deve essere compresa tra 1 e 50 caratteri Deve essere in formato UUID |
422 |
| Una proprietà sconosciuta | Non sono consentite proprietà aggiuntive | 422 |
Errori asincroni
I seguenti errori sono specifici CreateResaleAuthorization delle azioni in. AWS Marketplace Catalog API Questi errori vengono restituiti quando si chiama DescribeChangeSet dopo l'elaborazione di un set di modifiche. Per ulteriori informazioni sull'utilizzo DescribeChangeSet per ottenere lo stato di una richiesta di modifica, vedereUtilizzo dei set di modifiche.
| Codice di errore | Messaggio di errore |
|---|---|
| INVALID_RESELLER_ACCOUNT | Fornisci un account rivenditore valido. |
Aggiorna il targeting per gli acquirenti
Puoi utilizzare l'API del catalogo per aggiornare gli acquirenti che hanno come target la tua autorizzazione di rivendita. Marketplace AWS
Tutte le opzioni di targeting esistenti che non sono incluse nell'ultima richiesta vengono rimosse dall'autorizzazione alla rivendita. Questo tipo di modifica è facoltativo per il rilascio dell'autorizzazione alla rivendita.
Per aggiornare gli acquirenti che hanno scelto come target la tua autorizzazione alla rivendita, richiama l'StartChangeSetoperatore API indicando il tipo di UpdateBuyerTargetingTerms modifica, come illustrato nell'esempio seguente.
Sintassi della richiesta
POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType":"UpdateBuyerTargetingTerms", "Entity":{ "Type": "ResaleAuthorization@1.0", "Identifier": "resaleauthz-123456789" }, "DetailsDocument": { "Terms": [ { "Type": "BuyerTargetingTerm", "PositiveTargeting": { "BuyerAccounts": [ "123456789012" ] } } ] } } ] }
Fornisci informazioni per i campi in cui aggiungere il tipo di UpdateBuyerTargetingTerms modifica:
-
Entità (oggetto) (obbligatorio): la tua autorizzazione alla rivendita.
-
Tipo (stringa) (obbligatorio):
Typeè sempreResaleAuthorization@1.0. -
Identificatore (stringa) (obbligatorio): il tuo ID di autorizzazione alla rivendita. Per ulteriori informazioni, consulta Identificatore.
-
-
DetailsDocument(oggetto) (obbligatorio) — Specifiche della richiesta.
-
Termini (serie di strutture) (opzionale): elenco di termini scelti come target degli acquirenti che desideri aggiornare. Se l'intenzione non è quella di indirizzarli a un acquirente specifico, il
ResaleAuthorizationcampo dei termini può essere ignorato. Per impostazione predefinita,ResaleAuthorizationè indirizzato a tutti gli acquirenti. I termini supportati sono:-
BuyerTargetingTerms(oggetto) (opzionale): definisci il targeting specifico per l'acquirente in base al tuo. ResaleAuthorization
-
Tipo (stringa) (obbligatorio): categoria del termine da aggiornare.
-
PositiveTargeting(oggetto) (obbligatorio): definisce i criteri che il profilo di qualsiasi acquirente deve soddisfare per poter accedere a
ResaleAuthorization.-
BuyerAccounts(array di stringhe) (opzionale): elenca come facoltativo. Puoi aggiungere quello dell'acquirente target. Account AWS Se non intendi rivolgerti
ResaleAuthorizationa acquirenti specifici, questo campo deve essere omesso. Per impostazione predefinita, tutti gli acquirenti sono scelti come target. I partner di canale mirati possono scegliere di creare un'offerta privata e rivolgersi a un sottoinsieme di acquirenti, se specificato.
-
-
-
-
Sintassi della risposta
Viene creato un set di modifiche per la richiesta. La risposta a questa richiesta fornisce l'ChangeSetIde ChangeSetArn per il set di modifiche ed è simile alla seguente.
{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }
La richiesta di modifica viene aggiunta a una coda ed elaborata. Ciò include la convalida delle informazioni con il team Operativo del Marketplace AWS venditore per garantire che soddisfino le Marketplace AWS linee guida. Il processo di convalida può richiedere da pochi minuti a qualche ora.
Puoi controllare lo stato della richiesta tramite o direttamente tramite Portale di gestione Marketplace AWS l'API Catalog utilizzando l'operazione DescribeChangeSet API.
Convalide sincrone
Le convalide dello schema sono specifiche per UpdateBuyerTargetingTerms le 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 |
|---|---|
| Termini |
Facoltativo Non deve essere nullo o vuoto Nell'elenco è consentito solo BuyerTargetingTerm "" La dimensione dell'elenco deve essere 1 (attualmente non esiste un caso d'uso che richieda più condizioni di acquisto) |
| BuyerTargetingTerm.PositiveTargeting |
Richiesto Non deve essere vuoto |
| BuyerTargetingTerm.PositiveTargeting.BuyerAccounts |
Facoltativo Account AWS Gli ID devono essere in formato valido (numero a 12 cifre) Non deve contenere più di 25 account |
| Una proprietà sconosciuta | Non sono consentite proprietà aggiuntive |
Errori asincroni
I seguenti errori sono specifici UpdateBuyerTargetingTerms delle azioni in. AWS Marketplace Catalog API Questi errori vengono restituiti quando si chiama DescribeChangeSet dopo l'elaborazione di un set di modifiche. Per ulteriori informazioni sull'utilizzo DescribeChangeSet per ottenere lo stato di una richiesta di modifica, vedereUtilizzo dei set di modifiche.
| Codice di errore | Messaggio di errore |
|---|---|
| INCOMPATIBLE_BUYER_TARGETING | È necessario che sia presente almeno un account Acquirente con. ResaleAuthorization PreExistingBuyerAgreement |
Aggiorna la disponibilità
Puoi utilizzare l'API Catalog per limitare la disponibilità di quante offerte private vengono create o fino a che ora specifica può essere creata un'offerta privata.
Per impostazione predefinita, il valore è l'utilizzo illimitato di questa autorizzazione alla rivendita, sebbene sia possibile verificarne la disponibilità nell'elenco delle regole.
Per controllare la disponibilità e l'usabilità dell'autorizzazione alla rivendita, richiama l'operazione StartChangeSet API con il tipo di UpdateAvailability modifica, come illustrato nell'esempio seguente.
Sintassi della richiesta
POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "UpdateAvailability", "Entity": { "Type": "ResaleAuthorization@1.0", "Identifier": "resaleauthz-123456789" }, "DetailsDocument": { "AvailabilityEndDate": "2022-05-31", "OffersMaxQuantity": 1 } } ] }
Fornisci informazioni sui campi in cui aggiungere il tipo di UpdateAvailability modifica:
-
Entità (oggetto) (obbligatorio): la tua autorizzazione alla rivendita.
-
Tipo (stringa) (obbligatorio):
Typeè sempreResaleAuthorization@1.0. -
Identificatore (stringa) (obbligatorio): il tuo ID di autorizzazione alla rivendita. Per ulteriori informazioni, consulta Identificatore.
-
-
DetailsDocument(oggetto) (obbligatorio) — Specifiche della richiesta.
-
AvailabilityEndDate(stringa) (opzionale): definisci la data di fine entro la quale i Channel Partner potranno sfruttare la
ResaleAuthorizationper creare un'offerta. I Channel Partner possonoResaleAuthorizationutilizzarla più volte fino alla data di fine specificata. Le date sono rappresentate nel formato ISO_8601. -
OffersMaxQuantity(intero) (opzionale): definisce il numero massimo di offerte private che possono essere create utilizzando. ResaleAuthorization Questo non definisce il numero di abbonamenti.
-
Sintassi della risposta
Viene creato un set di modifiche per la richiesta. La risposta a questa richiesta fornisce l'ChangeSetIde ChangeSetArn per il set di modifiche ed è simile alla seguente.
{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }
La richiesta di modifica viene aggiunta a una coda ed elaborata. Ciò include la convalida delle informazioni con il team Operativo del Marketplace AWS venditore per garantire che soddisfino le Marketplace AWS linee guida. Il processo di convalida può richiedere da pochi minuti a qualche ora.
Puoi controllare lo stato della richiesta tramite o direttamente tramite Portale di gestione Marketplace AWS l'API Catalog utilizzando l'operazione DescribeChangeSet API.
Convalide sincrone
Le convalide dello schema sono specifiche per UpdateAvailability le azioni in. AWS Marketplace Catalog API Le 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 |
|---|---|
| OffersMaxQuantity |
Facoltativo Deve essere un numero intero non negativo Valore consentito solo «1" (attualmente nessun caso d'uso per supportare quantità multiple) |
| AvailabilityEndDate |
Facoltativo Deve essere in formato ISO_8601 Deve essere una data futura |
| Disponibilità | Fornisci uno OffersMaxQuantity o AvailabilityEndDate. |
| Una proprietà sconosciuta | Non sono consentite proprietà aggiuntive |
Errori asincroni
I seguenti errori sono specifici UpdateAvailability delle azioni nell'API AWS Marketplace Catalog. Questi errori vengono restituiti quando si chiama DescribeChangeSet dopo l'elaborazione di un set di modifiche. Per ulteriori informazioni sull'utilizzo DescribeChangeSet per ottenere lo stato di una richiesta di modifica, vedereUtilizzo dei set di modifiche.
| Codice di errore | Messaggio di errore |
|---|---|
| INVALID_AVAILABILITY_END_DATE | Fornisci un valore che preceda tutte le vincite. AvailabilityEndDate ChargeDate ResalePaymentScheduleTerms |
| DATA_FINE_DISPONIBILITÀ_NON VALIDA | Offri un futuro AvailabilityEndDate. |
Aggiornare la validità di un accordo con data futura
Puoi utilizzare l'API Catalog per modificare e controllare una data di inizio del servizio con data futura in Marketplace AWS.
Questo set di modifiche non è obbligatorio per rilasciare un'autorizzazione alla rivendita.
Per modificare e controllare la durata dell'autorizzazione alla rivendita del contratto di prodotto, richiama l'operazione StartChangeSet API con il tipo di UpdateBuyerValidityTerms modifica, come illustrato nell'esempio seguente.
Nota
Future-dated gli accordi sono supportati solo per i tipi di prodotti SaaS.
Sintassi della richiesta
POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "UpdateBuyerValidityTerms", "Entity": { "Type": "ResaleAuthorization@1.0", "Identifier": "resaleauthz-123456789" }, "DetailsDocument": { "Terms": [ { "Type": "BuyerValidityTerm", "MaximumAgreementStartDate": "2024-05-31" } ] } } ] }
Fornisci informazioni per i campi di input per aggiungere il tipo di UpdateBuyerValidityTerms modifica:
-
Entità (oggetto) (obbligatorio): la tua autorizzazione alla rivendita.
-
Tipo (stringa) (obbligatorio):
Typeè sempreResaleAuthorization@1.0. -
Identificatore (stringa) (obbligatorio): il tuo ID di autorizzazione alla rivendita. Per ulteriori informazioni, consulta Identificatore.
-
-
DetailsDocument(oggetto) (obbligatorio) — Specifiche della richiesta.
-
Termini (serie di strutture): elenco dei termini di validità dell'accordo che si desidera aggiornare. I termini supportati sono:
-
BuyerValidityTerm(oggetto): definisce la disponibilità di un servizio per un prodotto del tuo ResaleAuthorization.
-
Tipo (stringa): categoria del termine in fase di aggiornamento.
-
MaximumAgreementStartDate(stringa) (obbligatorio): definisce la data di inizio del contratto per il prodotto offerto. Le offerte con data futura non possono superare questa data di inizio del servizio. Le date sono rappresentate nel formato ISO_8601.
-
-
-
Sintassi della risposta
Viene creato un set di modifiche per la richiesta. La risposta a questa richiesta fornisce l'ChangeSetIde ChangeSetArn per il set di modifiche ed è simile alla seguente.
{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }
La richiesta di modifica viene aggiunta a una coda ed elaborata. Ciò include la convalida delle informazioni con il team Operativo del Marketplace AWS venditore per garantire che soddisfino le Marketplace AWS linee guida. Il processo di convalida può richiedere da pochi minuti a qualche ora.
Puoi controllare lo stato della richiesta tramite o direttamente tramite Portale di gestione Marketplace AWS l'API Catalog utilizzando l'operazione DescribeChangeSet API.
Convalide sincrone
Le convalide dello schema sono specifiche per UpdateBuyerValidityTerms le azioni in. AWS Marketplace Catalog API Le 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 |
|---|---|
| Termini |
Richiesto Non deve essere nullo o vuoto Nell'elenco è consentito solo BuyerValidityTerm "" La dimensione dell'elenco deve essere 1 (attualmente non esiste un caso d'uso che richieda più termini di disponibilità del servizio) |
| MaximumAgreementStartDate |
Richiesto Non deve essere nullo o vuoto Deve essere una data futura e non deve superare i 3 anni da oggi Deve essere in formato ISO_8601 |
| Una proprietà sconosciuta | Non sono consentite proprietà aggiuntive |
Errori asincroni
I seguenti errori sono specifici UpdateBuyerValidityTerms delle azioni in. AWS Marketplace Catalog API Questi errori vengono restituiti quando si chiama DescribeChangeSet dopo l'elaborazione di un set di modifiche. Per ulteriori informazioni sull'utilizzo DescribeChangeSet per ottenere lo stato di una richiesta di modifica, vedereUtilizzo dei set di modifiche.
| Codice di errore | Messaggio di errore |
|---|---|
| PRODOTTO_INCOMPATIBILE | BuyerValidityTerm non è supportato per il prodotto. |
| INVALID_MAXIMUM_AGREEMENT_START_DATE | Fornisci un futuro MaximumAgreementStartDate entro il limite consentito. |
Aggiorna le risorse legali
Puoi utilizzare l'API Catalog per sostituire completamente i termini legali esistenti in Marketplace AWS.
I termini legali che non sono inclusi nell'ultima richiesta verranno rimossi dall'autorizzazione alla rivendita. BuyerLegalTermcontiene l'EULA che sarà incluso nel contratto di acquisto finale e LegalTerm include il contratto di rivendita che sarà incluso nel contratto di rivendita tra il partner di canale e l'ISV.
Per aggiornare i termini legali dell'utenteResaleAuthorization, chiama l'operatore StartChangeSet API con il tipo di UpdateLegalTerms modifica, come illustrato nell'esempio seguente.
Sintassi della richiesta
POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "UpdateLegalTerms", "Entity": { "Type": "ResaleAuthorization@1.0", "Identifier": "resaleauthz-123456789" }, "DetailsDocument": { "Terms": [ { "Type": "BuyerLegalTerm", "Documents": [ { "Type": "CustomEula", "Url": "https://my-public-bucket.s3.amazonaws.com/eula-example12345.txt" } ] }, { "Type": "ResaleLegalTerm", "Documents": [ { "Type": "CustomResellerContract", "Url": "https://my-public-bucket.s3.amazonaws.com/reseller-example12345.txt" } ] } ] } } ] }
Fornisci informazioni sui campi in cui aggiungere il tipo di UpdateLegalTerms modifica:
-
Entità (oggetto) (obbligatorio): la tua autorizzazione alla rivendita.
-
Tipo (stringa) (obbligatorio):
Typeè sempreResaleAuthorization@1.0. -
Identificatore (stringa) (obbligatorio): il tuo ID di autorizzazione alla rivendita. Per ulteriori informazioni, consulta Identificatore.
-
-
DetailsDocument(oggetto) (obbligatorio) — Specifiche della richiesta.
-
Termini (serie di strutture) (obbligatorio): elenco di termini legali. I termini legali supportati sono:
-
BuyerLegalTerm(oggetto) (obbligatorio): definisce l'elenco degli accordi testuali da proporre agli accettatori. Ad esempio, il contratto di licenza con l'utente finale (EULA).
-
Tipo (stringa) (obbligatorio): categoria del termine da aggiornare.
-
Documenti (serie di strutture) (obbligatorio): elenco di riferimenti alle risorse legali da proporre agli acquirenti. Ad esempio, l'EULA. Ogni riferimento è composto da una
Typee unaURL:-
Tipo (stringa) (obbligatorio): tipo di documento. I tipi di documento disponibili sono:
-
StandardEula— Contratto standard per Marketplace AWS. Per maggiori informazioni, consulta SCMP nella Guida al Marketplace AWS venditore. Non è necessario fornire un URL per questo tipo perché è gestito da Marketplace AWS.
-
EnterpriseEula— Contratto aziendale per Marketplace AWS. Per maggiori informazioni, consulta la sezione DSA nella Marketplace AWS Seller Guide. Non è necessario fornire un URL per questo tipo, poiché è gestito da Marketplace AWS.
-
CustomEula— EULA personalizzato fornito dall'utente in qualità di produttore. Per questo tipo di documento è necessario un URL per l'EULA memorizzato in un bucket S3 accessibile.
-
-
Url (stringa) (obbligatorio in base alla condizione): un URL del documento legale che gli acquirenti possono leggere. È obbligatorio quando Tipo di categoria è
CustomEula.
-
-
ResaleLegalTerm(oggetto) (opzionale): definisce l'elenco degli accordi testuali da proporre solo ai partner di canale. Questo termine non sarà disponibile per gli acquirenti.
-
Tipo (stringa) (obbligatorio): categoria del termine in fase di aggiornamento.
-
Documenti (serie di strutture) (obbligatorio): elenco di riferimenti alle risorse legali dei rivenditori da proporre ai partner di canale.
-
Tipo (stringa) (obbligatorio) — Categoria del documento. I tipi di documento disponibili sono:
-
StandardResellerContract— Contratto di rivenditore standard per Marketplace AWS.
-
CustomResellerContract— Un contratto di rivendita personalizzato da parte tua in qualità di produttore. Un URL per il contratto di rivendita è memorizzato in un bucket S3 accessibile ed è necessario per questo tipo di documento.
-
-
Url (stringa) (obbligatorio in base a determinate condizioni): URL del documento del contratto di rivendita che i partner di canale possono leggere. È obbligatorio quando il Tipo è. CustomResellerContract
-
-
-
-
Sintassi della risposta
Viene creato un set di modifiche per la richiesta. La risposta a questa richiesta fornisce l'ChangeSetIde ChangeSetArn per il set di modifiche ed è simile alla seguente.
{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }
La richiesta di modifica viene aggiunta a una coda ed elaborata. Ciò include la convalida delle informazioni per garantire che soddisfino le linee guida. Marketplace AWS Il processo di convalida può richiedere da pochi minuti a qualche ora.
Puoi controllare lo stato della richiesta tramite o direttamente tramite Portale di gestione Marketplace AWS l'API Catalog utilizzando l'operazione DescribeChangeSet API.
Convalide sincrone
Le convalide dello schema sono specifiche per UpdateLegalTerms le azioni in. AWS Marketplace Catalog API Le 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 |
|---|---|---|
| Termini |
Richiesto Non deve essere nullo o vuoto |
422 |
| Termini []. BuyerLegalTerm |
Richiesto Non deve essere nullo o vuoto |
422 |
| Termini []. ResaleLegalTerm |
Facoltativo Non deve essere nullo o vuoto se presente |
422 |
| Termini []. BuyerLegalTerm.Documents |
Richiesto Non deve essere nullo o vuoto |
422 |
| Termini []. BuyerLegalTerm.Documents[] .Tipo |
Richiesto Non deve essere nullo o vuoto Valori consentiti:
|
422 |
| Termini []. BuyerLegalTerm.Documents[] .Url | Obbligatorio e deve essere un URL valido quando «Tipo» è «» CustomEula Non deve essere fornito quando «Type» è uno dei [» StandardEula «," EnterpriseEula «] |
422 |
| Termini []. ResaleLegalTerm.Documents |
Richiesto Non deve essere nullo o vuoto |
422 |
| Termini []. ResaleLegalTerm.Documents[] .Tipo |
Richiesto Non deve essere nullo o vuoto. Valori consentiti:
|
422 |
| Termini []. ResaleLegalTerm.Documents[] .Url |
Obbligatorio e deve essere un URL valido quando «Tipo» è «» CustomResellerContract Non deve essere fornito quando «Tipo» è uno dei [» StandardContract «] |
422 |
| Una proprietà sconosciuta | Non sono consentite proprietà aggiuntive | 422 |
Errori asincroni
I seguenti errori sono specifici UpdateLegalTerms delle azioni in. AWS Marketplace Catalog API Questi errori vengono restituiti quando si chiamaDescribeChangeSet, dopo l'elaborazione di un set di modifiche. Per ulteriori informazioni sull'utilizzo DescribeChangeSet per ottenere lo stato di una richiesta di modifica, vedereUtilizzo dei set di modifiche.
| Codice di errore | Messaggio di errore |
|---|---|
| INVALID_BUYER_LEGAL_DOCUMENTS | Fornisci gli URL per i documenti legali degli acquirenti archiviati in bucket S3 accessibili. |
| INVALID_RESALE_LEGAL_DOCUMENTS | Fornisci gli URL per la rivendita di documenti legali archiviati in bucket S3 accessibili. |
| TERMINI_OBBLIGATORI MANCANTI | Fornire un. BuyerLegalTerm |
Aggiorna i prezzi
Puoi utilizzare l'API Catalog per sostituire completamente le condizioni tariffarie esistenti Marketplace AWS.
I termini di prezzo che non sono inclusi nell'ultima richiesta verranno rimossi dall'autorizzazione alla rivendita. Puoi aggiornare i prezzi scontati per il tuo prodotto tramite questa API.
Per aggiornare i dettagli sui prezzi per le tue autorizzazioni di rivendita, chiama l'operatore dell'StartChangeSetAPI con il tipo di UpdatePricingTerms modifica, come mostrato nell'esempio seguente.
Sintassi della richiesta
POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "UpdatePricingTerms", "Entity": { "Type": "ResaleAuthorization@1.0", "Identifier": "resaleauthz-123456789" }, "DetailsDocument": { "PricingModel": "Contract", "Terms": [ { "Type": "ResaleUsageBasedPricingTerm", "CurrencyCode": "USD", "RateCards": [ { "RateCard": [ { "DimensionKey": "m3.large", "Price": "0.10" }, { "DimensionKey": "m4.xlarge", "Price": "0.20" } ] } ] }, { "Type": "ResaleConfigurableUpfrontPricingTerm", "CurrencyCode": "USD", "RateCards": [ { "Selector": { "Type": "Duration", "Value": "P12M" }, "RateCard": [ { "DimensionKey": "m3.large", "Price": "300" }, { "DimensionKey": "m4.xlarge", "Price": "400" } ], "Constraints": { "MultipleDimensionSelection": "Allowed", "QuantityConfiguration": "Allowed" } } ] }, { "Type": "ResaleFixedUpfrontPricingTerm", "CurrencyCode": "USD", "Duration": "P2M", "Price": "200.0", "Grants": [ { "DimensionKey": "Users", "MaxQuantity": 10 } ] } ] } } ] }
Fornisci informazioni sui campi in cui aggiungere il tipo di UpdatePricingTerms modifica:
-
Entità (oggetto) (obbligatorio): la tua autorizzazione alla rivendita.
-
Tipo (stringa) (obbligatorio):
Typeè sempreResaleAuthorization@1.0. -
Identificatore (stringa) (obbligatorio): il tuo ID di autorizzazione alla rivendita. Per ulteriori informazioni, consulta Identificatore.
-
-
DetailsDocument(oggetto) (obbligatorio) — Specifiche della richiesta.
-
PricingModel(stringa) (richiesto) — Modello di prezzo per l'offerta. I valori possibili per il modello di prezzo sono:
-
Utilizzo: modello di Usage-based prezzo in base al quale agli acquirenti verrà fatturato l'utilizzo del prodotto.
-
Contratto: nel modello di prezzo basato su contratto, agli acquirenti viene fatturato in anticipo l'utilizzo del prodotto o viene offerto un piano di pagamento flessibile. Gli acquirenti possono anche pagare per un utilizzo aggiuntivo rispetto al contratto. I partner di canale possono aggiungere il proprio markup a questo piano di pagamento e ai prezzi per ogni dimensione.
-
-
Termini (serie di strutture) (obbligatorio): elenco dei termini di prezzo che desideri aggiornare. Le condizioni di prezzo supportate sono:
-
ResaleUsageBasedPricingTerm(oggetto): definisce un modello di prezzo pay-as-you-go (PAYG) in cui i clienti vengono addebitati in base all'utilizzo del prodotto.
-
Tipo (stringa) (obbligatorio) — Categoria del termine.
-
CurrencyCode(stringa) — Definisce la valuta per i prezzi indicati in questo termine. Attualmente, è supportato solo il dollaro statunitense.
-
RateCards(serie di strutture) — Elenco delle schede tariffarie.
-
RateCard(matrice di strutture): una scheda tariffaria definisce le tariffe unitarie per le dimensioni del prodotto.
-
DimensionKey(stringa) — Dimensione per la quale si applica l'autorizzazione specificata. Le dimensioni rappresentano le categorie di capacità di un prodotto e vengono specificate al momento dell'offerta del prodotto. Marketplace AWS
-
Prezzo (stringa): prezzo unitario per la dimensione del prodotto utilizzata per calcolare l'importo da addebitare.
-
-
Vincoli (oggetto) (opzionale): definisce i limiti su come il termine può essere configurato dagli accettatori.
-
MultipleDimensionSelection(string) (opzionale): determina se gli acquirenti possono selezionare più dimensioni nella tabella tariffaria. I valori possibili sono
AllowedeDisallowed. Il valore predefinito èAllowed. -
QuantityConfiguration(stringa) (opzionale): determina se gli accettatori sono autorizzati a configurare la quantità per ciascuna dimensione nel tariffario. I valori possibili sono
AllowedeDisallowed. Il valore predefinito èAllowed.
-
-
-
-
ResaleFixedUpfrontPricingTerm(oggetto): definisce un modello di prezzo prepagato in cui ai clienti viene addebitato un importo anticipato fisso.
-
Tipo (stringa) (obbligatorio) — Categoria del termine da aggiornare.
-
CurrencyCode(stringa) — Definisce la valuta per i prezzi indicati in questo termine. Definisce la valuta per i prezzi indicati in questo termine. Sono supportati USD, AUD, EUR, GBP e JPY.
-
Prezzo (stringa) (obbligatorio): importo fisso da addebitare al cliente quando questo termine viene accettato.
-
Durata (stringa) (obbligatorio) - Durata del contratto di ResaleAuthorization. Questo campo supporta il formato ISO 8601.
-
Sovvenzioni (serie di strutture) (obbligatorio): diritti che verranno concessi all'accettante della tariffazione fissa anticipata come parte dell'esecuzione del contratto.
-
DimensionKey(stringa) (obbligatorio) — Chiave di dimensione univoca definita nel documento del prodotto. Le dimensioni rappresentano le categorie di capacità di un prodotto e vengono specificate quando il prodotto è elencato in Marketplace AWS.
-
MaxQuantity(numero intero) (obbligatorio): quantità massima di capacità che l'acquirente può avere per una determinata dimensione del prodotto. Se non MaxQuantity viene fornita, l'acquirente potrà utilizzare una quantità illimitata della dimensione specificata.
-
-
-
-
Sintassi della risposta
Viene creato un set di modifiche per la richiesta. La risposta a questa richiesta fornisce l'ChangeSetIde ChangeSetArn per il set di modifiche ed è simile alla seguente.
{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }
La richiesta di modifica viene aggiunta a una coda ed elaborata. Ciò include la convalida delle informazioni per garantire che soddisfino le linee guida. Marketplace AWS Il processo di convalida può richiedere da pochi minuti a qualche ora.
Puoi controllare lo stato della richiesta tramite o direttamente tramite Portale di gestione Marketplace AWS l'API Catalog utilizzando l'operazione DescribeChangeSet API.
Convalide sincrone
Le seguenti convalide dello schema sono specifiche per UpdatePricingTerms le azioni nell'API AWS Marketplace Catalog. Le 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 |
|---|---|
| Termini |
Richiesto Non deve essere nullo o vuoto Ogni termine deve presentare solo termini consentiti una sola volta:
|
| Termini []. ResaleUsageBasedPricingTerm.CurrencyCode |
Richiesto Valori consentiti: USD |
| Termini []. ResaleUsageBasedPricingTerm.Validity |
Richiesto Non deve essere nullo o vuoto Formato previsto: durata ISO 8601 |
| Termini []. ResaleUsageBasedPricingTerm.RateCards |
Richiesto Non deve essere nullo o vuoto |
| Termini []. ResaleUsageBasedPricingTerm.RateCards[]. DimensionKey |
Richiesto Non deve essere nullo o vuoto La lunghezza deve essere compresa tra 1 e 60 |
| Termini []. ResaleUsageBasedPricingTerm.RateCards[] .Prezzo |
Richiesto Non deve essere nullo o vuoto Il tipo di dati è «String» Deve essere non negativo Supporta fino a 8 decimali Non sono supportati caratteri speciali |
| Termini []. ResaleConfigurableUpfrontPricingTerm.CurrencyCode |
Richiesto Valori consentiti: ["USD», «AUD», «EUR», «GBP», «JPN"] |
|
Termini []. ResaleConfigurableUpfrontPricingTerm.RateCards[]. Selector.Type |
Richiesto Non deve essere nullo o vuoto Valori consentiti: Durata |
|
Termini []. ResaleConfigurableUpfrontPricingTerm.RateCards[]. Selector.Value |
Richiesto Non deve essere nullo o vuoto Formato previsto: durata ISO 8601 |
|
Termini []. ResaleConfigurableUpfrontPricingTerm.RateCards[]. RateCard.DimensionKey |
Richiesto Non deve essere nullo o vuoto La lunghezza deve essere compresa tra 1 e 60 |
|
Termini []. ResaleConfigurableUpfrontPricingTerm.RateCards[]. RateCard.Price |
Richiesto Non deve essere nullo o vuoto Il tipo di dati è «String» Deve essere non negativo Supporta fino a 6 decimali Non sono supportati caratteri speciali |
|
Termini []. ResaleConfigurableUpfrontPricingTerm.RateCards[] .Vincoli |
Facoltativo |
| Termini []. ResaleFixedUpfrontPricingTerm.CurrencyCode | Richiesto Valori consentiti: ["USD», «AUD», «EUR», «GBP», «JPN"] |
| Termini []. ResaleFixedUpfrontPricingTerm.Price |
Richiesto Non deve essere nullo o vuoto Il tipo di dati è «String» Deve essere non negativo Supporta fino a 6 decimali Non sono supportati caratteri speciali Valori consentiti: 0.0 |
| Termini []. ResaleFixedUpfrontPricingTerm.Duration |
Richiesto Non deve essere nullo o vuoto Formato previsto: durata ISO 8601 |
| Termini []. ResaleFixedUpfrontPricingTerm.Grants[]. DimensionKey |
Richiesto Non deve essere nullo o vuoto La lunghezza deve essere compresa tra 1 e 60 |
| Termini []. ResaleFixedUpfrontPricingTerm.Grants[]. MaxQuantty |
Richiesto Non deve essere nullo o vuoto |
| Una proprietà sconosciuta | Non sono consentite proprietà aggiuntive |
Errori asincroni
I seguenti errori sono specifici UpdatePricingTerms delle azioni in. AWS Marketplace Catalog API Questi errori vengono restituiti quando si chiama DescribeChangeSet dopo l'elaborazione di un set di modifiche. Per ulteriori informazioni sull'utilizzo DescribeChangeSet per ottenere lo stato di una richiesta di modifica, vedereUtilizzo dei set di modifiche.
| Codice di errore | Messaggio di errore |
|---|---|
| INVALID_CURRENCY_CODE | Fornisci lo stesso per tutti i prezzi e i termini di pagamento CurrencyCode . |
| PRODOTTO_INCOMPATIBILE | Usa le dimensioni esistenti e disponibili nel prodotto in [x]. |
| CHIAVI_DIMENSIONALI_DUPLICATE | Fornisci alla scheda tariffaria un elenco univoco di chiavi dimensionali in [x] |
| INVALID_RATE_CARD | Fornisci dimensioni che abbiano la stessa unità in [x] |
| INVALID_RATE_CARD | Fornisci un tariffario solo per le dimensioni misurate in. ResaleUsageBasedPricingTerm |
| INVALID_RATE_CARD | Fornisci tariffe basate sull'utilizzo per tutte le dimensioni misurate disponibili in. ResaleUsageBasedPricingTerm |
| TOO_MANY_RATES | Fornire RateCards entro i limiti consentiti in. ResaleUsageBasedPricingTerm |
| SELETTORI DUPLICATI | Fornisci un elenco univoco di selettori in. ResaleConfigurableUpfrontPricingTerm |
| INVALID_RATE_CARD | ConfigurableUpfrontPricingTerm manca una o più chiavi dimensionali per la durata [x]. Fornisci i prezzi per lo stesso set di chiavi di dimensione per tutte le durate. |
| INVALID_RATE_CARD | Fornisci tutte le dimensioni misurate o tutte le dimensioni autorizzate in [x]. |
| INCOMPATIBLE_RATE_CARD_CONSTRAINTS | Imposta e su Non consentito per. MultipleDimensionSelection QuantityConfiguration ResaleConfigurableUpfrontPricingTerm PricingModel |
| TOO_MANY_RATE_CARDS | È consentita una sola carta tariffaria per il prodotto. ConfigurableUpfrontPricingTerm |
| TERMINI_INCOMPATIBILI | I seguenti termini non sono compatibili con PricingModel: [x, y, z]. |
| TOO_MANY_RATES | Fornire RateCards entro i limiti consentiti in [x term]. |
| TOO_MANY_GRANTS | Fornisci fino a [N] sovvenzioni in [x term]. |
| VALORE_DI_SELETTORE DI DURATA NON VALIDO | Fornisci una durata compresa tra [x] e [y] mesi in ResaleConfigurableUpfront |
| TOO_MANY_GRANTS | Fornisci una durata compresa tra [x] e [y] mesi. |
| VALORE_SELETTORE_DURATA_NON VALIDO | Assicurati che la granularità della durata sia pari a quella giornaliera per le dimensioni misurate in ResaleConfigurableUpfront |
| DURATURA_INVALIDA | Assicurati che la granularità della durata sia pari a quella giornaliera per le dimensioni misurate in. FixedUpfront |
| INVALID_RATE_CARD | Fornisci solo le dimensioni autorizzate in [x]. |
| MISSING_DURATION | Fornisci una durata in [x]. |
| DUPLICATE_DIMENSION_KEYS | Fornisci a Grants un elenco univoco di chiavi di dimensione in [x]. |
| INCOMPATIBLE_PAYMENT_SETTINGS | Aggiorna le impostazioni di pagamento per renderle compatibili con. CurrencyCode |
| INCOMPATIBLE_SELLER_VERIFICATION | Completa tutti i processi di verifica del venditore richiesti. |
| INVALID_CURRENCY_CODE | Fornisci un file supportato. CurrencyCode |
| INVALID_CURRENCY_CODE | Fornisci lo stesso per tutti i prezzi e i termini di pagamento CurrencyCode . |
| CODICE_VALUTA INCOMPATIBILE | CurrencyCode non può essere modificato dopo il rilascio dell'offerta. |
Aggiorna il calendario dei pagamenti
Puoi utilizzare l'API Catalog per modificare i dettagli associati ai pagamenti, ad esempio un piano di pagamento flessibile, in. Marketplace AWS
Per aggiornare i dettagli associati al pagamento per l'autorizzazione alla rivendita, richiama l'operazione StartChangeSet API con il tipo di UpdatePaymentScheduleTerms modifica, come mostrato nell'esempio seguente.
Sintassi della richiesta
POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "UpdatePaymentScheduleTerms", "Entity": { "Type": "ResaleAuthorization@1.0", "Identifier": "resaleauthz-123456789" }, "DetailsDocument": { "Terms": [ { "Type": "ResalePaymentScheduleTerm", "CurrencyCode": "USD", "Schedule": [ { "ChargeDate": "2021-12-01", "ChargeAmount": "200.00" }, { "ChargeDate": "2022-03-01", "ChargeAmount": "250.00" } ] } ] } } ] }
Fornisci informazioni per i campi in cui aggiungere il tipo di modifica: UpdatePaymentScheduleTerms
-
Entità (oggetto) (obbligatorio): la tua autorizzazione alla rivendita.
-
Tipo (stringa) (obbligatorio):
Typeè sempreResaleAuthorization@1.0. -
Identificatore (stringa) (obbligatorio): il tuo ID di autorizzazione alla rivendita. Per ulteriori informazioni, consulta Identificatore.
-
-
DetailsDocument(oggetto) (obbligatorio) — Specifiche della richiesta.
-
Termini (serie di strutture): elenco dei termini di pagamento che desideri aggiornare. I termini di pagamento supportati sono:
-
ResalePaymentScheduleTerm(oggetto): definisce un modello tariffario rateale in cui ai clienti viene addebitato un prezzo fisso in date diverse durante il periodo di validità del contratto.
-
Tipo (stringa): categoria del termine da aggiornare.
-
CurrencyCode(stringa) (obbligatorio) — Definisce la valuta per il pagamento indicato nella pianificazione. Sono supportati USD, AUD, EUR, GBP e JPY.
-
Pianificazione (serie di strutture): elenco dello scadenzario di pagamento in cui ogni elemento definisce una rata di pagamento. Contiene le informazioni necessarie per calcolare il prezzo da pagare e la data in cui verrebbe addebitato al cliente.
-
ChargeDate(stringa) (obbligatorio): la data in cui il cliente pagherà il prezzo definito nel presente termine del piano di pagamento. Questo campo supporta il formato ISO 8601.
-
ChargeAmount(stringa) (obbligatorio) — Il prezzo che il cliente pagherebbe in una data programmata (ChargeDate).
-
-
-
-
Sintassi della risposta
Viene creato un set di modifiche per la richiesta. La risposta a questa richiesta fornisce l'ChangeSetIde ChangeSetArn per il set di modifiche ed è simile alla seguente.
{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }
La richiesta di modifica viene aggiunta a una coda ed elaborata. Ciò include la convalida delle informazioni per garantire che soddisfino le linee guida. Marketplace AWS Il processo di convalida può richiedere da pochi minuti a qualche ora.
Puoi controllare lo stato della richiesta tramite o direttamente tramite Portale di gestione Marketplace AWS l'API Catalog utilizzando l'operazione DescribeChangeSet API.
Convalide sincrone
Le convalide dello schema sono specifiche per UpdatePaymentScheduleTerms le azioni in. AWS Marketplace Catalog API Le 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 | HTTP |
|---|---|---|
| Terms.Type |
Richiesto Non supportato per il prodotto [x] Termini consentiti: ResalePaymentScheduleTerm |
422 |
| Termini []. CurrencyCode |
Richiesto Valori consentiti: USD |
422 |
| Termini []. ResalePaymentScheduleTerm.Schedule |
Richiesto La lunghezza deve essere compresa tra 1 e 60 |
422 |
| Termini []. ResalePaymentScheduleTerm.Shedule.ChargeDate |
Richiesto Deve essere in formato ISO 8601 La data deve essere futura |
422 |
| Termini []. ResalePaymentScheduleTerm.Shedule.ChargeAmount |
Richiesto Deve essere non negativo |
422 |
| Una proprietà sconosciuta | Non sono consentite proprietà aggiuntive | 422 |
Errori asincroni
I seguenti errori sono specifici UpdatePaymentScheduleTerms 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
| Codice di errore | Messaggio di errore |
|---|---|
| TERMINI_INCOMPATIBILI | OffersMaxQuantity e AvailabilityEndDate deve essere presente con. ResalePaymentScheduleTerm |
| TOO_MANY_SCHEDULED_PAYMENTS | Fornisci fino a 60 pagamenti programmati in. ResalePaymentScheduleTerm |
| DUPLICATE_CHARGE_DATES | Fornisci date di addebito uniche in. ResalePaymentScheduleTerm |
| INVALID_CHARGE_DATES | Offri un futuro ChargeDate. |
| INVALID_CHARGE_DATES | Fornisci una data dell'ultimo addebito precedente a [x]. |
| TERMINI_OBBLIGATORI MANCANTI | Fornite una mano insieme. ResaleFixedUpfrontPricingTerm ResalePaymentScheduleTerm |
| INVALID_CURRENCY_CODE | Fornisci lo stesso per tutti i prezzi e i termini di pagamento CurrencyCode . |
| INCOMPATIBLE_PAYMENT_SETTINGS | Aggiorna le impostazioni di pagamento per renderle compatibili con. CurrencyCode |
| INCOMPATIBLE_SELLER_VERIFICATION | Completa tutti i processi di verifica del venditore richiesti. |
| INVALID_CURRENCY_CODE | Fornisci un file supportato. CurrencyCode |
| INVALID_CURRENCY_CODE | Fornisci lo stesso per tutti i prezzi e i termini di pagamento CurrencyCode . |
| CODICE_VALUTA INCOMPATIBILE | CurrencyCode non può essere modificato dopo il rilascio dell'offerta. |
Aggiorna i dettagli dell'autorizzazione alla rivendita
Puoi utilizzare l'API Catalog per aggiornare i dettagli dell'autorizzazione alla rivendita in. Marketplace AWS
Per aggiornare i dettagli dell'autorizzazione alla rivendita, richiama l'operazione StartChangeSet API con il tipo di UpdateInformation modifica, come illustrato nell'esempio seguente.
Nota
Il tipo di UpdateInformation modifica aggiorna solo le sezioni fornite nella richiesta; tutte le altre informazioni rimangono invariate.
Sintassi della richiesta
POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "UpdateInformation", "Entity": { "Type": "ResaleAuthorization@1.0", "Identifier": "resaleauthz-123456789" }, "DetailsDocument": { "Name": "TestResaleAuthorization", "Description": "Worldwide ResaleAuthorization for Test Product", "PreExistingBuyerAgreement": { "AcquisitionChannel": "AwsMarketplace", "PricingModel": "Contract" } } } ] }
Fornisci informazioni per i campi in cui aggiungere il tipo di UpdateInformation modifica:
-
Entità (oggetto) (obbligatorio): la tua autorizzazione alla rivendita.
-
Tipo (stringa) (obbligatorio):
Typeè sempreResaleAuthorization@1.0. -
Identificatore (stringa) (obbligatorio): il tuo ID di autorizzazione alla rivendita. Per ulteriori informazioni, consulta Identificatore.
-
-
DetailsDocument(oggetto) (obbligatorio): dettagli della richiesta, incluse le informazioni per le quali si desidera aggiornare le informazioni per l'autorizzazione alla rivendita.
-
Nome (stringa) (opzionale): il nome associato a ResaleAuthorization per una migliore leggibilità per te e i tuoi partner di canale.
-
Descrizione (stringa) (opzionale): la descrizione è un testo in formato libero in cui puoi aggiungere dettagli su. ResaleAuthorization
-
PreExistingBuyerAgreement(oggetto) (opzionale): determina se questa offerta è un rinnovo di un contratto esistente con un cliente esistente per lo stesso prodotto sottostante. L'accordo esistente può essere interno o esterno Marketplace AWS. AWS può controllare e verificare che la tua offerta sia un rinnovo. Se non AWS è in grado di verificare l'offerta, AWS può revocare l'offerta e concedere al cliente i relativi diritti.
-
AcquisitionChannel(stringa) (obbligatorio): indica se il contratto di acquisto esistente è stato firmato esternamente o internamente. Marketplace AWS Marketplace AWS
Valori possibili:
External,AwsMarketplace -
PricingModel(stringa) (obbligatorio) — Indica il modello di prezzo utilizzato dal contratto in uscita.
Valori possibili:
Contract,Usage,BYOL,Free
-
-
Sintassi della risposta
Viene creato un set di modifiche per la richiesta. La risposta a questa richiesta fornisce l'ChangeSetIde ChangeSetArn per il set di modifiche ed è simile alla seguente.
{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }
La richiesta di modifica viene aggiunta a una coda ed elaborata. Ciò include la convalida delle informazioni per garantire che soddisfino le linee guida. Marketplace AWS Il processo di convalida può richiedere da pochi minuti a qualche ora.
Puoi controllare lo stato della richiesta tramite o direttamente tramite Portale di gestione Marketplace AWS l'API Catalog utilizzando l'operazione DescribeChangeSet API.
Convalide sincrone
Le convalide dello schema seguenti sono specifiche per UpdateInformation le azioni in. AWS Marketplace Catalog API Queste convalide vengono eseguite quando si chiama StartChangeSet e la richiesta avrà esito negativo con un errore HTTP se l'input non soddisfa i seguenti requisiti.
| Campo di input | Regola di convalida | Codice HTTP |
|---|---|---|
| Nome |
Facoltativo Non deve essere nullo o vuoto La lunghezza deve essere compresa tra 1 e 100 caratteri Modello ^ [A-Za-z0-9] *$ Non sono consentiti caratteri speciali o spazi bianchi |
422 |
| Description |
Facoltativo La lunghezza deve essere compresa tra 1 e 255 caratteri Modello ^ [A-Za-z0-9\\ s] *$ Non sono consentiti caratteri speciali |
422 |
| Una proprietà sconosciuta | Non sono consentite proprietà aggiuntive | 422 |
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
| Codice di errore | Messaggio di errore |
|---|---|
| INCOMPATIBLE_BUYER_TARGETING | È necessario che sia presente almeno un account Acquirente con. ResaleAuthorization PreExistingBuyerAgreement |
Limita l'autorizzazione alla rivendita
Puoi utilizzare l'API Catalog per impostare regole di restrizione per un'autorizzazione alla rivendita in. Marketplace AWS
Un'autorizzazione di rivendita limitata non può più essere utilizzata da un partner di canale per creare un'offerta privata. Un'offerta privata esistente non subirà alcuna modifica.
Per limitare l'autorizzazione alla rivendita, richiama l'operazione StartChangeSet API con il tipo di RestrictResaleAuthorization modifica, come illustrato nell'esempio seguente.
Importante
Si tratta di un'operazione non reversibile. Dopo che l'autorizzazione alla rivendita è stata contrassegnata comeRestricted, non può essere nuovamente in uno Active stato.
Sintassi della richiesta
POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "RestrictResaleAuthorization", "Entity": { "Type": "ResaleAuthorization@1.0", "Identifier": "resaleauthz-123456789" }, "DetailsDocument": {} } ] }
Fornisci informazioni sui campi in cui aggiungere il tipo di RestrictResaleAuthorization modifica:
-
Entità (oggetto) (obbligatorio): la tua autorizzazione alla rivendita.
-
Tipo (stringa) (obbligatorio):
Typeè sempreResaleAuthorization@1.0. -
Identificatore (stringa) (obbligatorio): il tuo ID di autorizzazione alla rivendita. Per ulteriori informazioni, consulta Identificatore.
-
-
DetailsDocument(oggetto) (obbligatorio) — Specifiche della richiesta. Deve essere un oggetto vuoto per
RestrictResaleAuthorization.
Sintassi della risposta
Viene creato un set di modifiche per la richiesta. La risposta a questa richiesta fornisce l'ChangeSetIde ChangeSetArn per il set di modifiche ed è simile alla seguente.
{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }
La richiesta di modifica viene aggiunta a una coda ed elaborata. Ciò include la convalida delle informazioni per garantire che soddisfino le linee guida. Marketplace AWS Il processo di convalida può richiedere da pochi minuti a qualche ora.
Puoi controllare lo stato della richiesta tramite o direttamente tramite Portale di gestione Marketplace AWS l'API Catalog utilizzando l'operazione DescribeChangeSet API.
Convalide sincrone
Le convalide dello schema sono specifiche per RestrictResaleAuthorization le azioni nell'API AWS Marketplace Catalog. 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 |
|---|---|---|
| DetailsDocument | Deve essere vuoto | 422 |
RestrictResaleAuthorization |
Scaduto non ResaleAuthorization può essere contrassegnato come |
422 |
| Una proprietà sconosciuta | Non sono consentite proprietà aggiuntive | 422 |
Errori asincroni
I seguenti errori sono specifici RestrictResaleAuthorization 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
| Codice di errore | Messaggio di errore |
|---|---|
| STATO_INCOMPATIBILE | La scadenza non ResaleAuthorization può essere contrassegnata come soggetta a restrizioni. |
Rilascia un'autorizzazione alla rivendita e rendila visibile a un Channel Partner
Puoi utilizzare l'API Catalog per avviare il tuo ResaleAuthorization stato. Active
ReleaseResaleAuthorizationrende attiva l'autorizzazione alla rivendita in modo che un partner di canale possa utilizzare l'autorizzazione alla rivendita per creare offerte private.
Per rilasciare l'autorizzazione alla rivendita, richiama l'operazione StartChangeSet API con il tipo di ReleaseResaleAuthorization modifica, come mostrato nell'esempio seguente.
Sintassi della richiesta
POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "ReleaseResaleAuthorization", "Entity": { "Type": "ResaleAuthorization@1.0", "Identifier": "resaleauthz-123456789" }, "DetailsDocument": {} } ] }
Fornisci informazioni sui campi in cui aggiungere il tipo di ReleaseResaleAuthorization modifica:
-
Entità (oggetto) (obbligatorio): la tua autorizzazione alla rivendita.
-
Tipo (stringa) (obbligatorio):
Typeè sempreResaleAuthorization@1.0. -
Identificatore (stringa) (obbligatorio): il tuo ID di autorizzazione alla rivendita. Per ulteriori informazioni, consulta Identificatore.
-
-
DetailsDocument(oggetto) (obbligatorio) — Specifiche della richiesta. Deve essere vuoto per
ReleaseResaleAuthorization.
Sintassi della risposta
Viene creato un set di modifiche per la richiesta. La risposta a questa richiesta fornisce l'ChangeSetIde ChangeSetArn per il set di modifiche ed è simile alla seguente.
{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }
La richiesta di modifica viene aggiunta a una coda ed elaborata. Ciò include la convalida delle informazioni per garantire che soddisfino le linee guida. Marketplace AWS Il processo di convalida può richiedere da pochi minuti a qualche ora.
Puoi controllare lo stato della richiesta tramite o direttamente tramite Portale di gestione Marketplace AWS l'API Catalog utilizzando l'operazione DescribeChangeSet API.
Convalide sincrone
Le convalide dello schema sono specifiche per ReleaseResaleAuthorization le azioni in. AWS Marketplace Catalog API Le 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 |
|---|---|---|
| Una proprietà sconosciuta | Non sono consentite proprietà aggiuntive | 422 |
Errori asincroni
I seguenti errori sono specifici ReleaseResaleAuthorization delle azioni in. AWS Marketplace Catalog API Questi errori vengono restituiti quando si chiama DescribeChangeSet dopo l'elaborazione di un set di modifiche. Per ulteriori dettagli sull'utilizzo DescribeChangeSet per ottenere lo stato di una richiesta di modifica, consultaUtilizzo dei set di modifiche.
| Codice di errore | Messaggio di errore |
|---|---|
| TERMINI_OBBLIGATORI MANCANTI | Fornire un. BuyerLegalTerm |
| TERMINI_OBBLIGATORI MANCANTI | Fornire un. PricingTerm |
| PRODOTTO_INCOMPATIBILE | Utilizza un prodotto attivo in uno stato limitato o pubblico. |
| TERMINE_TARIFFARIO INCOMPATIBILE | PaymentScheduleTerm e devono essere presenti insieme. FixedUpfrontPricingTerm |
| INCOMPATIBLE_BUYER_TARGETING | È necessario che sia presente almeno un account Acquirente con. ResaleAuthorization PreExistingBuyerAgreement |
| TERMINI_OBBLIGATORI MANCANTI | Fornisci almeno uno dei [x, y, z]. |
| STATO_INCOMPATIBILE | La richiesta [x] non può essere eseguita dopo il rilascio dell'autorizzazione alla rivendita. |
Descrivi un'autorizzazione alla rivendita esistente
Per descrivere i dettagli dell'autorizzazione alla rivendita, richiama l'operazione DescribeEntity API con il tipo di ResaleAuthorization@1.0 entità, come mostrato nell'esempio seguente.
Sintassi della richiesta
GET /DescribeEntity?catalog=<Catalog>&entityId=<EntityId> HTTP/1.1
Fornisci informazioni sui campi in cui aggiungere il tipo di DescribeEntity modifica:
-
catalog (string) — Il catalogo relativo alla richiesta. Valore fisso:
AWSMarketplace. -
entityId (string) — L'ID univoco di
ResaleAuthorizationda descrivere.
Sintassi della risposta
La risposta a questa richiesta fornisce i dettagli dell'offerta ed è simile alla seguente.
{ "EntityType": "ResaleAuthorization@1.0", "EntityIdentifier": "resaleauthz-123456789", "EntityArn": "arn:aws:aws-marketplace:us-east-1:111122223333:AWSMarketplace/ResaleAuthorization/resaleauthz-123456789", "LastModifiedDate": "2021-03-10T21:57:16Z", "DetailsDocument": { "Name": "TestResaleAuthorization", "Description": "ResaleAuthorization for Test Product", "ProductId": "prod-ad8EXAMPLE51", "ProductName": "TestProduct", "Status": "Active", /*Draft, Active, Restricted*/ "PreExistingBuyerAgreement": { "AcquisitionChannel": "Unknown", "PricingModel": "Unknown" }, "CreatedDate": "2023-07-18T16:39:31.335Z", "ManufacturerLegalName": "ChannelCAPI.Inc", "ManufacturerAccountId": "123456789012", "Dimensions": [ { "Name": "Protected Resources", "Description": "Additional 100 protected resources", "Key": "hundredresources", "Unit": "Units", "Types": [ "Entitled" ] } ], "OfferDetails": { "OfferExtendedStatus": "Not Started", /* Not Started, Completed-Used, Completed-Usable*/ "OfferCreatedCount": 0 }, "Terms": [ { "Type": "ResaleUsageBasedPricingTerm", "Id": "term_id_placeholder", "CurrencyCode": "USD", "RateCards": [ { "RateCard": [ { "DimensionKey": "resource_number", "Price": "0.05" }, { "DimensionKey": "scanned_data", "Price": "0.05" } ] } ] }, { "Type": "ResaleConfigurableUpfrontPricingTerm", "Id": "term_id_placeholder", "CurrencyCode": "USD", "RateCards": [ { "Selector": { "Type": "Duration", "Value": "P24M" }, "RateCard": [ { "DimensionKey": "hundredresources", "Price": "0.04" }, { "DimensionKey": "tenTBData", "Price": "0.03" }, { "DimensionKey": "channel_custom", "Price": "0.02" } ], "Constraints": { "MultipleDimensionSelection": "Allowed", "QuantityConfiguration": "Allowed" } } ] }, { "Type": "ResaleFixedUpfrontPricingTerm", "Id": "term-sdh27fb2", "CurrencyCode": "USD", "Duration": "P180D", "Price": "0.0", "Grants": [ { "DimensionKey": "sdf73rbns93nl120d10xm1", "MaxQuantity": 1 } ] }, { "Type": "ResalePaymentScheduleTerm", "Id": "term-sdh27fb2", "CurrencyCode": "USD", "Schedule": [ { "ChargeDate": "2018-07-01T00:00:00.000Z", "ChargeAmount": "200.00" }, { "ChargeDate": "2019-05-01T00:00:00.000Z", "ChargeAmount": "200.00" } ] }, { "Type": "BuyerLegalTerm", "Id": "term_id_placeholder", "Documents": [ { "Type": "StandardEula", "Url": "https://resale-auth-legal-terms-iad-beta.s3.us-east-1.amazonaws.com/09ae57d6-c75a-3a4c-aadf-9b866bae64ab/a85cace8-6d9d-40ca-a053-78fc265479bf?isSigned=yes" } ] }, { "Type": "ResaleLegalTerm", "Id": "term_id_placeholder", "Documents": [ { "Type": "StandardResellerContract", "Url": "https://resale-auth-legal-terms-iad-beta.s3.us-east-1.amazonaws.com/09ae57d6-c75a-3a4c-aadf-9b866bae64ab/bed55b56-7ab4-4c4c-b633-3bf4f6efcb98?isSigned=yes" } ] }, { "Type": "BuyerValidityTerm", "Id": "term_id_placeholder", "MaximumAgreementStartDate": "2023-09-25T23:59:59.000Z" }, { "Type": "BuyerTargetingTerm", "Id": "term_id_placeholder", "PositiveTargeting": { "BuyerAccounts": [ { "AwsAccountId": "444455556666" } ] } } ], "Rules": [ { "Type": "AvailabilityRule", "Id": "availability_rule_id_placeholder", /* If the AvailabilityEndDate and OffersMaxQuantity not present Usage will be Unlimited*/ "Usage": "Limited", "AvailabilityEndDate": "2022-05-31T23:59:59Z", "OffersMaxQuantity": 1 }, { "Type": "PartnerTargetingRule", "Id": "partner_targeting_rule_id_placeholder", "ResellerAccountId": "777777777777", "ResellerLegalName": "ChannelCAPICP.Inc" } ] } }
Di seguito sono riportate informazioni sui campi visualizzati nella DescribeEntity risposta.
-
EntityType(stringa) — Il tipo denominato dell'entità, che è ResaleAuthorization @1 .0.
-
EntityIdentifier(stringa) — L'identificatore dell'entità, nel formato @. EntityId RevisionId
-
EntityArn(stringa) — L'ARN associato all'identificatore univoco per il set di modifiche a cui si fa riferimento in questa richiesta.
-
LastModifiedDate(stringa) — La data dell'ultima modifica dell'entità, in formato ISO 8601 (2018-02-27). T13:45:22Z
-
DetailsDocument(oggetto) (obbligatorio) — Questa stringa JSON include i dettagli dell'entità.
-
Nome (stringa): nome associato a per una migliore leggibilità ResaleAuthorization per te e i tuoi partner di canale. Viene visualizzato come parte delle informazioni sull'Accordo.
-
Descrizione (stringa): la descrizione è un testo in formato libero che deve essere utilizzato solo da te e non sarà mai esposto agli acquirenti.
-
ProductId(stringa) — La descrizione è un testo in formato libero che deve essere utilizzato solo da te e non sarà mai esposto agli acquirenti.
-
AgreementToken(stringa) — Generato dal contenuto in. ResaleAuthorization Contiene informazioni su termini, regole e proponente durante la creazione di un accordo. Viene utilizzato per i controlli e le convalide delle autorizzazioni durante l'approvvigionamento.
-
Termini (serie di strutture): elenco dei termini presentati per l'accettazione.
-
Regole (serie di strutture): elenco di regole o set di istruzioni.
-