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 offerte private utilizzando il Marketplace AWS API

Puoi utilizzarlo AWS Marketplace Catalog API per automatizzare le attività relative all'utilizzo delle offerte.

Mentre il prodotto descrive ciò che viene venduto Marketplace AWS, l'offerta descrive i termini e le regole di acquisto e consumo del prodotto. Marketplace AWS i prodotti possono avere più offerte vendute da venditori diversi. Tuttavia, ogni Marketplace AWS offerta può essere creata per un solo prodotto. Un'offerta contiene una raccolta di termini contrattuali tra due parti. I termini dell'offerta accettati vengono tradotti in un accordo come prova di una transazione.

Esistono due tipi di offerte:

Consulta le seguenti risorse:

I seguenti argomenti descrivono come utilizzare l'API Catalog per creare e aggiornare le offerte:

Crea un'offerta

Puoi utilizzare l'API Catalog per creare una nuova offerta in Marketplace AWS. Se la richiesta viene elaborata correttamenteDraft, AWS Marketplace Catalog API crea un'offerta incompleta e invisibile agli acquirenti. Per completare un'offerta, utilizza il tipo di Update modifica. Quando l'offerta è completa, utilizza il tipo di ReleaseOffermodifica per crearla e rilasciarla. Il rilascio di un'offerta la convalida e la rende visibile agli acquirenti. Marketplace AWS

Per creare una nuova offerta, richiama l'operazione StartChangeSet API con il tipo di CreateOffer modifica, come illustrato nell'esempio seguente.

Sintassi della richiesta

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "CreateOffer",
      "Entity": {
        "Type": "Offer@1.0"
      },
      "DetailsDocument": {
        "ProductId": "prod-ad8EXAMPLE51",
        "Name": "Test Offer",
        "OfferSetId": "offerset-b3f9EXAMPLE27"
      }
    }
  ]
}

Fornisci informazioni sui campi per aggiungere il tipo di CreateOffer modifica:

Sintassi della risposta

Viene creato un set di modifiche per la richiesta. La risposta a questa richiesta fornisce l'ChangeSetIde ChangeSetArn per il set di modifiche ed è simile alla seguente.

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}

La richiesta di modifica viene aggiunta a una coda ed elaborata.

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

Se lo Status èSUCCEEDED, ne OfferId viene generato uno nuovo.

La risposta avrà il seguente aspetto.

{
  "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": "CreateOffer",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "ProductId": "prod-ad8EXAMPLE51",
        "Name": "Test Offer"
      },
      "ErrorDetailList": []
    }
  ]
}

Convalide sincrone

Le convalide dello schema seguenti sono specifiche per CreateOffer 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.

Errori asincroni

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

Crea un'offerta sostitutiva

Puoi utilizzare l'API Catalog per creare un'offerta sostitutiva (nota anche come offerta basata su contratto) in. Marketplace AWS

Se la tua richiesta è stata elaborata con successo, ti AWS Marketplace Catalog API verrà generata Draft un'offerta in corso, che è un'offerta incompleta e non visibile agli acquirenti su. Marketplace AWS Utilizzerai i tipi di Update modifica per completare l'offerta. Una volta completata l'offerta, utilizzerai la ReleaseOffermodifica del tipo per completare il processo di creazione dell'offerta e rilasciare l'offerta, che convaliderà l'intera offerta e la renderà visibile agli acquirenti su Marketplace AWS. Da quel momento, l'acquirente ha la possibilità di accettare l'offerta sostitutiva o di continuare a operare in base al contratto originale.

Per creare un'offerta sostitutiva, chiama l'operatore StartChangeSet API con il tipo di CreateReplacementOffer modifica e fornisci un ID di accordo preesistente, come mostrato nell'esempio seguente.

Sintassi della richiesta

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "CreateReplacementOffer",
      "Entity": {
        "Type": "Offer@1.0"
      },
      "DetailsDocument": {
        "AgreementId": "agmt-12345",
        "Name": "Offer name"
      }
    }
  ]
}

Fornisci informazioni per i campi in cui aggiungere il tipo di CreateReplacementOffer modifica:

Sintassi della risposta

Viene creato un set di modifiche per la richiesta. La risposta a questa richiesta fornisce l'ChangeSetIde ChangeSetArn per il set di modifiche ed è simile alla seguente.

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}

La richiesta di modifica viene aggiunta a una coda ed elaborata.

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

Convalide sincrone

Le convalide dello schema seguenti sono specifiche per CreateReplacementOffer 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.

Errori asincroni

I seguenti errori sono specifici CreateReplacementOffer delle azioni in. AWS Marketplace Catalog API Questi errori vengono restituiti quando si chiama DescribeChangeSet dopo l'elaborazione di un set di modifiche. Per ulteriori informazioni sull'utilizzo DescribeChangeSet per ottenere lo stato di una richiesta di modifica, vedereUtilizzo dei set di modifiche.

Aggiorna le informazioni sull'offerta

Puoi utilizzare l'API Catalog per aggiornare le informazioni sull'offerta in Marketplace AWS.

Per aggiornare le informazioni sull'offerta, richiama l'operazione StartChangeSet API con il tipo di UpdateInformation modifica, come mostrato nell'esempio seguente. Tutte le altre informazioni rimarranno invariate.

Sintassi della richiesta

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "UpdateInformation",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "Name": "New offer name",
        "Description": "New offer description",
        "PreExistingAgreement": {
          "AcquisitionChannel": "External",
          "PricingModel": "Contract"
        }
      }
    }
  ]
}

Fornisci informazioni per i campi in cui aggiungere il tipo di UpdateInformation modifica:

Sintassi della risposta

Viene creato un set di modifiche per la richiesta. La risposta a questa richiesta fornisce l'ChangeSetIde ChangeSetArn per il set di modifiche ed è simile alla seguente.

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}

La richiesta di modifica viene aggiunta a una coda ed elaborata. Ciò include la convalida delle informazioni per garantire che soddisfino le linee guida. Marketplace AWS Il processo di convalida può richiedere alcuni minuti.

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 Se la richiesta non soddisfa i seguenti requisiti, avrà esito negativo con una risposta HTTP.

Errori asincroni

I seguenti errori sono specifici UpdateInformation delle azioni in. AWS Marketplace Catalog API Questi errori vengono restituiti quando si chiama DescribeChangeSet dopo l'elaborazione di un set di modifiche. Per ulteriori informazioni sull'utilizzo DescribeChangeSet per ottenere lo stato di una richiesta di modifica, vedereUtilizzo dei set di modifiche.

Aggiorna la configurazione del targeting

Puoi utilizzare l'API Catalog per aggiornare la configurazione del targeting della tua offerta in. Marketplace AWS

Tutte le opzioni di targeting esistenti che non sono incluse nell'ultima richiesta e verranno rimosse dall'offerta.

Per aggiornare la configurazione di targeting della tua offerta, richiama l'operazione StartChangeSet API con il tipo di UpdateTargeting modifica, come mostrato nell'esempio seguente.

Sintassi della richiesta

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "UpdateTargeting",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "PositiveTargeting": {
          "CountryCodes": [
            "US",
            "CA"
          ],
          "BuyerAccounts": [
            "111122223333"
          ]
        },
        "NegativeTargeting": {
          "CountryCodes": [
            "XX"
          ]
        }
      }
    }
  ]
}

Fornisci informazioni per i campi in cui aggiungere il tipo di UpdateTargeting modifica:

Sintassi della risposta

Viene creato un set di modifiche per la richiesta. La risposta a questa richiesta fornisce l'ChangeSetIde ChangeSetArn per il set di modifiche ed è simile alla seguente.

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}

La richiesta di modifica viene aggiunta a una coda ed elaborata. Ciò include la convalida delle informazioni per garantire che soddisfino le linee guida. Marketplace AWS Il processo di convalida può richiedere alcuni minuti.

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 UpdateTargeting 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.

Errori asincroni

I seguenti errori sono specifici UpdateTargeting delle azioni in. AWS Marketplace Catalog API Questi errori vengono restituiti quando si chiama DescribeChangeSet dopo l'elaborazione di un set di modifiche. Per ulteriori informazioni sull'utilizzo DescribeChangeSet per ottenere lo stato di una richiesta di modifica, vedereUtilizzo dei set di modifiche.

Aggiorna la politica di rimborso

Puoi utilizzare l'API Catalog per aggiornare la politica di rimborso della tua offerta in Marketplace AWS.

Questa modifica non influisce sugli accordi esistenti. I termini di assistenza che non sono inclusi nell'ultima richiesta verranno rimossi dall'offerta.

Per aggiornare la politica di rimborso, chiama l'operatore StartChangeSet API con il tipo di UpdateSupportTerms modifica, come mostrato nell'esempio seguente.

Sintassi della richiesta

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "UpdateSupportTerms",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "Terms": [
          {
            "Type": "SupportTerm",
            "RefundPolicy": "Updated refund policy description"
          }
        ]
      }
    }
  ]
}

Fornisci informazioni per i campi in cui aggiungere il tipo di UpdateSupportTerms modifica:

Sintassi della risposta

Viene creato un set di modifiche per la richiesta. La risposta a questa richiesta fornisce l'ChangeSetIde ChangeSetArn per il set di modifiche ed è simile alla seguente.

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}

La richiesta di modifica viene aggiunta a una coda ed elaborata. Ciò include la convalida delle informazioni per garantire che soddisfino le linee guida. Marketplace AWS Il processo di convalida può richiedere alcuni minuti.

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 UpdateSupportTerms 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.

Errori asincroni

I seguenti errori sono specifici UpdateSupportTerms delle azioni in. AWS Marketplace Catalog API Questi errori vengono restituiti quando si chiama DescribeChangeSet dopo l'elaborazione di un set di modifiche. Per ulteriori informazioni sull'utilizzo DescribeChangeSet per ottenere lo stato di una richiesta di modifica, vedereUtilizzo dei set di modifiche.

Aggiorna le risorse legali

Puoi utilizzare l'API Catalog per sostituire i documenti legali esistenti, come un contratto di licenza con l'utente finale (EULA). I termini legali che non sono inclusi nell'ultima richiesta verranno rimossi dall'offerta.

Per aggiornare le risorse legali della tua offerta, chiama l'operazione StartChangeSet API con il tipo di UpdateLegalTerms modifica, come mostrato nell'esempio seguente.

Sintassi della richiesta

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "UpdateLegalTerms",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "Terms": [
          {
            "Type": "LegalTerm",
            "Documents": [
              {
                "Type": "CustomEula",
                "Url": "https://s3.amazonaws.com/EULA/custom-eula-1234.txt"
              }
            ]
          }
        ]
      }
    }
  ]
}

Fornisci informazioni per i campi in cui aggiungere il tipo di UpdateLegalTerms modifica:

Sintassi di 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 alcuni minuti.

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 UpdateLegalTerms 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.

Errori asincroni

I seguenti errori sono specifici UpdateLegalTerms delle azioni in. AWS Marketplace Catalog API Questi errori vengono restituiti quando si chiama DescribeChangeSet dopo l'elaborazione di un set di modifiche. Per ulteriori informazioni sull'utilizzo DescribeChangeSet per ottenere lo stato di una richiesta di modifica, vedereUtilizzo dei set di modifiche.

Aggiorna i prezzi

Puoi utilizzare l'API Catalog per sostituire completamente le condizioni tariffarie esistenti. I termini di prezzo che non sono inclusi nell'ultima richiesta verranno rimossi dall'offerta.

Per aggiornare i termini di prezzo della tua offerta, chiama l'operatore StartChangeSet API 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": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "PricingModel": "Usage",
        "Terms": [
          {
            "Type": "UsageBasedPricingTerm",
            "CurrencyCode": "USD",
            "RateCards": [
              {
                "RateCard": [
                  {
                    "DimensionKey": "m3.large",
                    "Price": "0.10"
                  },
                  {
                    "DimensionKey": "m4.xlarge",
                    "Price": "0.20"
                  }
                ]
              }
            ]
          },
          {
            "Type": "ConfigurableUpfrontPricingTerm",
            "CurrencyCode": "USD",
            "RateCards": [
              {
                "Selector": {
                  "Type": "Duration",
                  "Value": "P365D"
                },
                "RateCard": [
                  {
                    "DimensionKey": "m3.large",
                    "Price": "300"
                  },
                  {
                    "DimensionKey": "m4.xlarge",
                    "Price": "400"
                  }
                ],
                "Constraints": {
                  "MultipleDimensionSelection": "Allowed",
                  "QuantityConfiguration": "Allowed"
                }
              }
            ]
          },
          {
            "Type": "ByolPricingTerm"
          },
          {
            "Type": "RecurringPaymentTerm",
            "CurrencyCode": "USD",
            "BillingPeriod": "Monthly",
            "Price": "100.0"
          },
          {
            "Type": "FixedUpfrontPricingTerm",
            "CurrencyCode": "USD",
            "Price": "200.00",
            "Grants": [
              {
                "DimensionKey": "Users",
                "MaxQuantity": 10
              }
            ]
          },
          {
            "Type": "FreeTrialPricingTerm",
            "Duration": "P30D",
            "Grants": [
              {
                "DimensionKey": "m3.xlarge",
                "MaxQuantity": 10
              },
              {
                "DimensionKey": "m4.xlarge",
                "MaxQuantity": 10
              }
            ]
          }
        ]
      }
    }
  ]
}

Fornisci informazioni per i campi in cui aggiungere il tipo di UpdatePricingTerms modifica:

Sintassi di 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 alcuni minuti.

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 UpdatePricingTerms 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.

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.

Aggiorna la reperibilità dell'offerta

Puoi utilizzare l'API Catalog per controllare la reperibilità della tua offerta in. Marketplace AWS

Puoi scegliere di impostare una data specifica nel futuro per limitare la visibilità della tua offerta o nel passato per far scadere l'offerta. Il tipo di UpdateAvailability modifica non influisce sugli accordi esistenti.

Per controllare la rilevabilità della tua offerta, richiama l'operazione StartChangeSet API con il tipo di UpdateAvailability modifica, come mostrato nell'esempio seguente.

Sintassi della richiesta

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "UpdateAvailability",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "AvailabilityEndDate": "2024-05-31"
      }
    }
  ]
}

Fornisci informazioni per i campi in cui aggiungere il tipo di UpdateAvailability modifica:

Viene creato un set di modifiche per la richiesta. La risposta a questa richiesta fornisce l'ID e l'ARN per il set di modifiche ed è simile alla seguente.

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. Include la convalida delle informazioni per garantire che soddisfino le linee guida. Marketplace AWS Il processo di convalida può richiedere alcuni minuti. Puoi controllare lo stato della richiesta tramite o nell'API Catalog con l'DescribeChangeSetazione. Portale di gestione Marketplace AWS

Convalide sincrone

Le convalide dello schema seguenti sono specifiche per UpdateAvailability 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.

Errori asincroni

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

Definire la data di scadenza degli accordi creati utilizzando l'offerta

Puoi utilizzare l'API Catalog per definire i dettagli della data di scadenza degli accordi creati utilizzando l'offerta in Marketplace AWS.

Questo tipo di modifica non influisce sugli accordi esistenti.

Per definire i dettagli della data di scadenza degli accordi creati utilizzando l'offerta, chiama l'operazione StartChangeSet API con il tipo di UpdateValidityTerms modifica, come mostrato nell'esempio seguente.

Sintassi della richiesta

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "UpdateValidityTerms",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "Terms": [
          {
            "Type": "ValidityTerm",
            "AgreementDuration": "P12M",
            "AgreementStartDate": "2021-08-01",
            "AgreementEndDate": "2022-08-01"
          }
        ]
      }
    }
  ]
}

Fornisci informazioni sui campi in cui aggiungere il tipo di UpdateValidityTerms modifica:

Sintassi della risposta

Viene creato un set di modifiche per la richiesta. La risposta a questa richiesta fornisce l'ChangeSetIde ChangeSetArn per il set di modifiche ed è simile alla seguente.

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}

La richiesta di modifica viene aggiunta a una coda ed elaborata. Ciò include la convalida delle informazioni per garantire che soddisfino le linee guida. Marketplace AWS Il processo di convalida può richiedere alcuni minuti.

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 UpdateValidityTerms 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.

Errori asincroni

I seguenti errori sono specifici UpdateValidityTerms delle azioni in. AWS Marketplace Catalog API Questi errori vengono restituiti quando si chiama DescribeChangeSet dopo l'elaborazione di un set di modifiche. Per ulteriori informazioni sull'utilizzo DescribeChangeSet per ottenere lo stato di una richiesta di modifica, vedereUtilizzo dei set di modifiche.

Aggiorna i dettagli del piano di pagamento

Puoi utilizzare l'API Catalog per aggiornare i dettagli del piano di pagamento della tua offerta, ad esempio un programma di pagamento flessibile, in Marketplace AWS.

Per aggiornare i dettagli del piano di pagamento per la tua offerta, chiama 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": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "Terms": [
          {
            "Type": "PaymentScheduleTerm",
            "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 UpdatePaymentScheduleTerms modifica:

Sintassi della risposta

Viene creato un set di modifiche per la richiesta. La risposta a questa richiesta fornisce l'ChangeSetIde ChangeSetArn per il set di modifiche ed è simile alla seguente.

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}

La richiesta di modifica viene aggiunta a una coda ed elaborata. Ciò include la convalida delle informazioni per garantire che soddisfino le linee guida. Marketplace AWS Il processo di convalida può richiedere alcuni minuti.

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 UpdatePaymentScheduleTerms 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.

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, vedereUtilizzo dei set di modifiche.

Modifica le opzioni di rinnovo

Puoi utilizzare l'API Catalog per controllare le opzioni di rinnovo degli accordi creati utilizzando questa offerta in Marketplace AWS.

Per le offerte create tramite l'API Catalog, il rinnovo automatico rimane disabilitato per impostazione predefinita finché non richiami il tipo di UpdateRenewalTerms modifica per consentire il rinnovo automatico. Questa modifica non influisce sugli accordi esistenti.

Per controllare le opzioni di rinnovo degli accordi creati utilizzando questa offerta, richiama l'operazione StartChangeSet API con il tipo di UpdateRenewalTerms modifica, come mostrato nell'esempio seguente.

Sintassi della richiesta

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "UpdateRenewalTerms",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "Terms": [
          {
            "Type": "RenewalTerm"
          }
        ]
      }
    }
  ]
}

Fornisci informazioni sui campi in cui aggiungere il tipo di UpdateRenewalTerms modifica:

Sintassi della risposta

Viene creato un set di modifiche per la richiesta. La risposta a questa richiesta fornisce l'ChangeSetIde ChangeSetArn per il set di modifiche ed è simile alla seguente.

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}

La richiesta di modifica viene aggiunta a una coda ed elaborata. Ciò include la convalida delle informazioni per garantire che soddisfino le linee guida. Marketplace AWS Il processo di convalida può richiedere alcuni minuti.

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 UpdateRenewalTerms 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.

Errori asincroni

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

Pubblica un'offerta

Puoi utilizzare l'API Catalog per unire le informazioni raccolte da tutti i tipi di modifiche agli aggiornamenti e quindi pubblicare l'offerta.

Le offerte rimangono invariate fino Draft a quando non ReleaseOffer vengono richiamate. Dopo il rilascio dell'offerta, è possibile scoprirla in Marketplace AWS.

Per pubblicare la tua offerta, chiama l'operazione StartChangeSet API con il tipo di ReleaseOffer modifica, come mostrato nell'esempio seguente.

Sintassi della richiesta

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "ReleaseOffer",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {}
    }
  ]
}

Fornisci informazioni per i campi in cui aggiungere il tipo di ReleaseOffer modifica:

Sintassi della risposta

Viene creato un set di modifiche per la richiesta. La risposta a questa richiesta fornisce l'ChangeSetIde ChangeSetArn per il set di modifiche ed è simile alla seguente.

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}

La richiesta di modifica viene aggiunta a una coda ed elaborata. Ciò include la convalida delle informazioni per garantire che soddisfino le linee guida. Marketplace AWS Il processo di convalida può richiedere alcuni minuti.

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 ReleaseOffer 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.

Errori asincroni

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

Descrivi i dettagli dell'offerta esistente

Puoi utilizzare l'API Catalog per descrivere i dettagli dell'offerta esistente in Marketplace AWS.

Per descrivere i dettagli dell'offerta esistente, richiama l'operazione DescribeEntity API con il tipo di Offer@1.0 entità, come mostrato nell'esempio seguente.

Sintassi della richiesta

GET /DescribeEntity?catalog=<Catalog>&entityId=<EntityId> HTTP/1.1

Fornisci informazioni sui campi per aggiungere il tipo di DescribeEntity modifica:

Sintassi della risposta

La risposta a questa richiesta fornisce i dettagli dell'offerta ed è simile alla seguente.

{
  "EntityType": "Offer@1.0",
  "EntityIdentifier": "offer-ad8EXAMPLE51@1",
  "EntityArn": "arn:aws:aws-marketplace:us-east-1:111122223333:AWSMarketplace/Offer/offer-ad8EXAMPLE51",
  "LastModifiedDate": "2021-03-10T21:57:16Z",
  "DetailsDocument": {
    "Id": "offer-3rEXAMPLErn",
    "State": "Released",
    "Name": "Test Offer",
    "Description": "Worldwide offer for Test Product",
    "PreExistingAgreement": {
      "AcquisitionChannel": "External",
      "PricingModel": "Contract"
    },
    "ProductId": "prod-ad8EXAMPLE51",
    "OfferSetId": "offerset-b3f9EXAMPLE27",
    "Terms": [
      {
        "Type": "SupportTerm",
        "RefundPolicy": "If you need to request a refund for software sold by Amazon Web Services, LLC, please contact AWS Customer Service."
      },
      {
        "Type": "LegalTerm",
        "Documents": [
          {
            "Type": "CustomEula",
            "Url": "https://s3.amazonaws.com/EULA/custom-eula-1234.txt"
          }
        ]
      },
      {
        "Type": "FreeTrialPricingTerm",
        "Duration": "P30D",
        "Grants": [
          {
            "DimensionKey": "m3.xlarge",
            "MaxQuantity": 10
          },
          {
            "DimensionKey": "m4.xlarge",
            "MaxQuantity": 10
          }
        ]
      },
      {
        "Type": "ConfigurableUpfrontPricingTerm",
        "CurrencyCode": "USD",
        "RateCards": [
          {
            "Selector": {
              "Type": "Duration",
              "Value": "P365D"
            },
            "RateCard": [
              {
                "DimensionKey": "m3.large",
                "Price": "300.00"
              },
              {
                "DimensionKey": "m4.xlarge",
                "Price": "400.00"
              }
            ],
            "Constraints": {
              "MultipleDimensionSelection": "Allowed",
              "QuantityConfiguration": "Allowed"
            }
          }
        ]
      },
      {
        "Type": "UsageBasedPricingTerm",
        "CurrencyCode": "USD",
        "RateCards": [
          {
            "RateCard": [
              {
                "DimensionKey": "m3.large",
                "Price": "0.10"
              },
              {
                "DimensionKey": "m4.xlarge",
                "Price": "0.20"
              }
            ]
          }
        ]
      },
      {
        "Type": "FixedUpfrontPricingTerm",
        "CurrencyCode": "USD",
        "Price": "200.00",
        "Grants": [
          {
            "DimensionKey": "Users",
            "MaxQuantity": 10
          }
        ]
      },
      {
        "Type": "RecurringPaymentTerm",
        "CurrencyCode": "USD",
        "BillingPeriod": "Monthly",
        "Price": "100.0"
      },
      {
        "Type": "PaymentScheduleTerm",
        "CurrencyCode": "USD",
        "Schedule": [
          {
            "ChargeDate": "2020-12-01T00:00:00.000Z",
            "ChargeAmount": "1000.00"
          },
          {
            "ChargeDate": "2021-06-15T00:00:00.000Z",
            "ChargeAmount": "1250.00"
          }
        ]
      },
      {
        "Type": "ByolPricingTerm"
      },
      {
        "Type": "RenewalTerm"
      }
    ],
    "Rules": [
      {
        "Type": "TargetingRule",
        "PositiveTargeting": {
          "CountryCodes": [
            "US",
            "CA"
          ],
          "BuyerAccounts": [
            "444455556666"
          ]
        },
        "NegativeTargeting": {
          "CountryCodes": [
            "XX"
          ]
        }
      },
      {
        "Type": "AvailabilityRule",
        "AvailabilityEndDate": "2024-08-30T01:56:03.000Z"
      }
    ]
  }
}

Di seguito sono riportate informazioni sui campi visualizzati nella DescribeEntity risposta.