L'API Reference di AWS Marketplace è 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 AMI-based i prodotti

Puoi utilizzarlo AWS Marketplace Catalog API per automatizzare le attività per lavorare con prodotti basati su Amazon Machine Image (AMI).

Per informazioni sulla creazione di un AMI-based prodotto utilizzando l'API Catalog, consultaCrea un prodotto.

I seguenti argomenti descrivono come utilizzare l'API del catalogo per eseguire azioni sui tuoi AMI-based prodotti:

Aggiungi una nuova versione

Puoi utilizzare l'API del catalogo per aggiungere una nuova versione a un AMI-based prodotto esistente in AWS Marketplace. Per ulteriori informazioni sull'aggiunta di nuove versioni AMI al prodotto utilizzando il Portale di gestione AWS Marketplace, consulta Aggiungere una nuova versione nella Guida per il AWS Marketplace venditore.

Quando si crea una richiesta che include l'aggiunta di una nuova AMI ad AWS Marketplace, l'AMI deve essere copiata nel sistema AWS Marketplace e quindi analizzata per individuare eventuali problemi di sicurezza. Devi concedere ad AWS Marketplace l'accesso all'AMI creando un ruolo AWS Identity and Access Management (IAM) con le autorizzazioni per eseguire azioni sulla tua AMI. Per ulteriori informazioni sulle autorizzazioni richieste, consulta Consentire ad AWS Marktplace l'accesso alla tua AMI nella Seller Guide. AWS Marketplace

Per aggiungere una nuova versione, richiama l'operazione StartChangeSet API con il tipo di AddDeliveryOptions modifica per AMI-based i prodotti, come mostrato nell'esempio seguente. Per testare la chiamata API senza creare effettivamente una nuova versione, imposta il Intent parametro suVALIDATE. Per ulteriori informazioni, consulta Intent.

Sintassi della richiesta

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "AddDeliveryOptions",
      "Entity":
      {
        "Type": "AmiProduct@1.0",
        "Identifier": "prod-example12345"
      },
      "DetailsDocument":
      {
        "Version":
        {
          "VersionTitle": "My new title",
          "ReleaseNotes": "My new Release notes"
        },
        "DeliveryOptions":
        [
          {
            "Details":
            {
              "AmiDeliveryOptionDetails":
              {
                "AmiSource":
                {
                  "AmiId": "ami-1234567890abcdef",
                  "AccessRoleArn": "arn:aws:iam::12345678901:role/AwsMarketplaceAmiIngestion",
                  "UserName": "ec2-user",
                  "OperatingSystemName": "AMAZONLINUX",
                  "OperatingSystemVersion": "Amazon Linux 2 AMI 2.0.20210126.0 x86_64 HVM gp2",
                  "AfiIds": ["afi-1234567890abcdefg", "afi-abcdefg1234567890"] //Optional (Required only for FPGA products)
                },
                "UsageInstructions": "Easy to use AMI",
                "RecommendedInstanceType": "m4.xlarge",
                "SecurityGroups":
                [
                  {
                    "IpProtocol": "tcp",
                    "FromPort": 443,
                    "ToPort": 443,
                    "IpRanges":
                    [
                      "0.0.0.0/0"
                    ]
                  }
                ]
              }
            }
          },
          {
            "DeliveryOptionTitle": "My new AMI with CFTdelivery option",
            "Details":
            {
              "DeploymentTemplateDeliveryOptionDetails":
              {
                "ShortDescription": "My new short description",
                "LongDescription": "My new long description",
                "UsageInstructions": "My new usage instructions",
                "RecommendedInstanceType": "m4.xlarge",
                "ArchitectureDiagram": "https://my-bucket.s3.amazonaws.com/my-folder/diagram.png",
                "Template": "https://my-bucket.s3.amazonaws.com/my-folder/cft.template",
                "TemplateSources":
                [
                  {
                    "ParameterName": "MyAmiParam",
                    "AmiSource":
                    {
                      "AmiId": "ami-1234567890abcdef",
                      "AccessRoleArn": "arn:aws:iam::12345678901:role/AwsMarketplaceAmiIngestion",
                      "UserName": "ec2-user",
                      "OperatingSystemName": "AMAZONLINUX",
                      "OperatingSystemVersion": "Amazon Linux 2 AMI 2.0.20210126.0 x86_64 HVM gp2"
                    }
                  }
                ]
              }
            }
          }
        ]
      }
    }
  ],
  "Intent": "APPLY"
}

L'elenco seguente fornisce informazioni sui campi di input utilizzati per il tipo di AddDeliveryOptions modifica. Tutti i campi sono obbligatori se non diversamente specificato. Per ulteriori informazioni su questi campi, consulta Aggiungere una nuova versione nella Guida per il AWS Marketplace venditore.

Sintassi della risposta

Viene creato un set di modifiche per la tua richiesta. La risposta a questa richiesta fornisce la ChangeSetId e ChangeSetArn per il set di modifiche ed è simile alla seguente.

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

La richiesta di modifica viene aggiunta a una coda ed elaborata. Ciò includeva la convalida delle informazioni per garantire che soddisfino le linee guida. AWS Marketplace 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 AWS Marketplace l'API del catalogo utilizzando l'operazione DescribeChangeSet API.

Per ulteriori informazioni sugli errori nei set di modifiche ai prodotti del venditore, consultaModifica lo stato e gli errori del set.

Una volta completata la richiesta, la versione viene aggiunta e tutti gli abbonati esistenti riceveranno un messaggio e-mail che li informa della nuova versione. Per ulteriori informazioni sul processo di aggiunta di una nuova versione, consulta Aggiungere una nuova versione nella Guida per il AWS Marketplace venditore.

Errori asincroni

Gli errori seguenti sono specifici AddDeliveryOptions 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.

Puoi anche creare un AMI-based prodotto utilizzando il Portale di gestione AWS Marketplace. Per ulteriori informazioni, consulta i prodotti AMI nella Guida per i AWS Marketplace venditori.

Per una guida dettagliata su come automatizzare l'aggiornamento AMI-based del prodotto, puoi anche fare riferimento al video, Automatizzare gli aggiornamenti delle offerte di prodotto AWS Marketplace con Catalog API (5:08).

Aggiorna le informazioni sulla versione

Puoi utilizzare l'API del catalogo per aggiornare i dettagli di una versione esistente del tuo AMI-based prodotto in AWS Marketplace.

Non puoi aggiornare l'AMI per la versione. Se devi aggiornare l'AMI, crea invece una nuova versione.

Per aggiungere una nuova versione, chiama l'operazione StartChangeSet API con il tipo di UpdateDeliveryOptions modifica, come mostrato nell'esempio seguente.

Sintassi della richiesta

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateDeliveryOptions",
      "Entity":
      {
        "Identifier": "example1-abcd-1234-5ef6-7890abcdef12@1",
        "Type": "AmiProduct@1.0"
      },
      "DetailsDocument":
      {
        "Version":
        {
          "ReleaseNotes": "*My new Release notes*"
        },
        "DeliveryOptions":
        [
          {
            "Id": "example1-2222-cccc-2222-cccccccccccc",
            "Details":
            {
              "AmiDeliveryOptionDetails":
              {
                "UsageInstructions": "Easy to use AMI"
              }
            }
          },
          {
            "Id": "example1-2222-dddd-2222-dddddddddddd",
            "Details":
            {
              "DeploymentTemplateDeliveryOptionDetails":
              {work with ami
                "DeliveryOptionTitle": "My updated delivery option title",
                "UsageInstructions": "Updated usage instructions here."
              }
            }
          }
        ]
      }
    }
  ]
}

Di seguito sono riportate informazioni sui campi di input forniti per aggiungere il tipo di UpdateDeliveryOptions modifica. Per ulteriori informazioni su questi campi, consulta Aggiornamento delle informazioni sulla versione nella Guida per il AWS Marketplace venditore.

Sintassi della risposta

Viene creato un set di modifiche per la tua richiesta. La risposta a questa richiesta fornisce la ChangeSetId e ChangeSetArn per il set di modifiche ed è simile alla seguente.

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

La richiesta di modifica viene aggiunta a una coda ed elaborata. Ciò includeva la convalida delle informazioni per garantire che soddisfino le linee guida. AWS Marketplace 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 AWS Marketplace l'API del catalogo utilizzando l'operazione DescribeChangeSet API.

Per ulteriori informazioni sui set di modifiche, consulta Utilizzo dei set di modifiche. Per ulteriori informazioni sugli errori nei set di modifiche ai prodotti del venditore, consultaModifica lo stato e gli errori del set.

Errori asincroni

Gli errori seguenti sono specifici UpdateDeliveryOptions 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.

È possibile recuperare UpdatePricingTerms le azioni utilizzando l'DescribeChangeSetoperazione dopo l'inizio dell'elaborazione del set di modifiche. Per ulteriori informazioni sui dettagli degli errori e sulla risoluzione dei problemi, consulta la Modifica lo stato e gli errori del set sezione precedente di questa guida.

Limita una versione

Puoi utilizzare l'API del catalogo per limitare una versione del tuo AMI-based prodotto. Ciò impedisce ai nuovi acquirenti di utilizzare quella versione, ma la mantiene disponibile per gli acquirenti esistenti. La limitazione di tutte le opzioni di spedizione di una versione limita la versione. La limitazione di una o più opzioni di consegna, ma non tutte, di una versione limita solo le opzioni di consegna di quella versione. Devi avere sempre a disposizione almeno una versione senza restrizioni di un prodotto, quindi non puoi limitare l'ultima versione disponibile al pubblico di un prodotto.

Per limitare una versione, richiama l'operazione StartChangeSet API con il tipo di RestrictDeliveryOptions modifica, come mostrato nell'esempio seguente.

Sintassi della richiesta

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "RestrictDeliveryOptions",
      "Entity":
      {
        "Identifier": "example1-abcd-1234-5ef6-7890abcdef12@1",
        "Type": "AmiProduct@1.0"
      },
      "DetailsDocument":
      {
        "DeliveryOptionIds":
        [
          "example1-2222-cccc-2222-cccccccccccc"
        ]
      }
    }
  ]
}

Di seguito sono riportate informazioni sui campi di input forniti per aggiungere il tipo di modifica: RestrictDeliveryOptions

Sintassi della risposta

Viene creato un set di modifiche per la tua richiesta. La risposta a questa richiesta fornisce la ChangeSetId e ChangeSetArn per il set di modifiche ed è simile alla seguente.

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

La richiesta di modifica viene aggiunta a una coda ed elaborata. Ciò includeva la convalida delle informazioni per garantire che soddisfino le linee guida. AWS Marketplace 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 AWS Marketplace l'API del catalogo utilizzando l'operazione DescribeChangeSet API.

Errori asincroni

Gli errori seguenti sono specifici RestrictDeliveryOptions 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.

Aggiornamento futuro Regione AWS supporto

Puoi utilizzare l'API del catalogo per modificare le preferenze di Regione AWS supporto future per il tuo AMI-based prodotto in AWS Marketplace.

Per modificare le preferenze di Regione AWS supporto future, richiama l'operazione StartChangeSet API con il tipo di UpdateFutureRegionSupport modifica, come mostrato nell'esempio seguente.

Sintassi della richiesta

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateFutureRegionSupport",
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "AmiProduct@1.0"
      },
      "DetailsDocument":
      {
        "FutureRegionSupport":
        {
          "SupportedRegions":
          [
            "All"
          ]
        }
      }
    }
  ]
}

Fornisci informazioni per i campi per aggiungere il tipo di UpdateFutureRegionSupport modifica:

Sintassi della risposta

Viene creato un set di modifiche per la tua richiesta. La risposta a questa richiesta fornisce la ChangeSetId e ChangeSetArn per il set di modifiche ed è simile alla seguente.

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

La richiesta di modifica viene aggiunta a una coda ed elaborata. Ciò includeva la convalida delle informazioni per garantire che soddisfino le linee guida. AWS Marketplace 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 AWS Marketplace l'API del catalogo utilizzando l'operazione DescribeChangeSet API.

Errori asincroni

Gli errori seguenti sono specifici UpdateFutureRegionSupport 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.

Aggiungi un supporto Regione AWS

Puoi utilizzare l'API del catalogo per aggiungere un nuovo supporto Regioni AWS per il tuo AMI-based prodotto in AWS Marketplace.

Per aggiungere nuove regioni supportate, richiamate l'operazione StartChangeSet API con il tipo di AddRegions modifica, come mostrato nell'esempio seguente.

Sintassi della richiesta

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "AddRegions",
      "DetailsDocument": {
        "Regions": [
          "us-east-1",
          "ap-northeast-2"
        ]
      },
      "Entity": {
        "Identifier": "prod-123456@1",
        "Type": "AmiProduct@1.0"
      }
    }
  ]
}

Fornisci informazioni per i campi per aggiungere il tipo di AddRegions modifica.

Sintassi della risposta

Viene creato un set di modifiche per la tua richiesta. La risposta a questa richiesta fornisce la ChangeSetId e ChangeSetArn per il set di modifiche ed è simile alla seguente.

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

La richiesta di modifica viene aggiunta a una coda ed elaborata. Ciò includeva la convalida delle informazioni per garantire che soddisfino le linee guida. AWS Marketplace 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 AWS Marketplace l'API del catalogo utilizzando l'operazione DescribeChangeSet API.

Errori asincroni

Gli errori seguenti sono specifici AddRegions 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.

Limita un Regione AWS

Puoi utilizzare l'API del catalogo per limitare il supporto precedentemente supportato Regioni AWS per il tuo AMI-based prodotto in AWS Marketplace.

Per limitare le regioni precedentemente supportate, richiamate l'operazione StartChangeSet API con il tipo di RestrictRegions modifica, come mostrato nell'esempio seguente.

Sintassi della richiesta

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "RestrictRegions",
      "DetailsDocument": {
        "Regions": [
          "us-east-1",
          "ap-northeast-2"
        ]
      },
      "Entity": {
        "Identifier": "prod-123456@1",
        "Type": "AmiProduct@1.0"
      }
    }
  ]
}

Fornisci informazioni per i campi per aggiungere il tipo di AddRegions modifica.

Sintassi della risposta

Viene creato un set di modifiche per la tua richiesta. La risposta a questa richiesta fornisce la ChangeSetId e ChangeSetArn per il set di modifiche ed è simile alla seguente.

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

La richiesta di modifica viene aggiunta a una coda ed elaborata. Ciò includeva la convalida delle informazioni per garantire che soddisfino le AWS Marketplace 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 AWS Marketplace l'API del catalogo utilizzando l'operazione DescribeChangeSet API.

Errori asincroni

Gli errori seguenti sono specifici AddRegions 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.

Aggiungere un nuovo tipo di istanza

Puoi utilizzare l'API Catalog per aggiungere nuovi tipi di istanza per il tuo AMI-based prodotto in AWS Marketplace.

AddInstanceTypesaggiungerà nuovi tipi di istanza ai prodotti esistenti e ai prodotti appena creati durante la creazione di un prodotto. Il tipo di modifica aggiornerà tutte le versioni nel documento di prodotto con un nuovo tipo di istanza.

Quando si aggiunge un tipo di istanza con restrizioni, il tipo di istanza può essere rimosso dall'elenco con restrizioni e aggiunto all'elenco dei tipi di istanza disponibili. Ciò offre ai venditori un maggiore controllo sulla modifica delle restrizioni relative ai prodotti. L'elenco dei tipi di istanza è intercambiabile e non costituisce uno stato soggetto a restrizioni permanenti per un prodotto.

Per i prodotti a consumo interno, i venditori devono indicare tipi di modifica separati AddDimensions e aggiornare i prezzi per UpdatePricingTerms il tipo di istanza.

Per aggiungere nuovi tipi di istanza, richiama l'operazione StartChangeSet API con il tipo di RestrictRegions modifica, come mostrato nell'esempio seguente.

Sintassi della richiesta

Di seguito viene mostrato solo il tipo di AddInstanceTypes modifica. Sebbene i venditori di AMI con conteggio interno siano tenuti a chiamare AddInstanceTypes e UpdatePricingTerms modificare il tipo di AMI.

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "AddInstanceTypes",
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "AmiProduct@1.0"
      },
      "DetailsDocument":
      {
        "InstanceTypes":
        [
          "m1.medium"
        ]
      }
    }
  ]
}

Fornisci informazioni per i campi per aggiungere il tipo di AddInstanceTypes modifica:

Sintassi della risposta

Viene creato un set di modifiche per la tua richiesta. La risposta a questa richiesta fornisce la ChangeSetId e ChangeSetArn per il set di modifiche ed è simile alla seguente.

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

La richiesta di modifica viene aggiunta a una coda ed elaborata. Ciò includeva la convalida delle informazioni per garantire che soddisfino le linee guida. AWS Marketplace 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 AWS Marketplace l'API del catalogo utilizzando l'operazione DescribeChangeSet API.

Convalide sincrone

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

Gli errori seguenti sono specifici AddInstanceTypes 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.

Limita un tipo di istanza

Puoi utilizzare l'API del catalogo per limitare o limitare i tipi di istanze disponibili per il tuo AMI-based prodotto in AWS Marketplace.

Gli abbonati esistenti non saranno interessati da questa modifica e potranno utilizzare i tipi di istanze con restrizioni. Tuttavia, nessun nuovo acquirente sarà in grado di utilizzare tipi di istanze con restrizioni. Per interrompere gli abbonamenti ai tipi di istanze correnti (una volta che i tipi di istanze saranno limitati), devi contattare il team operativo del AWS Marketplace venditore.

RestrictInstanctTypeslimita i tipi di istanze a tutte le versioni presenti nel documento del prodotto. Nel tipo di AddInstanceTypes modifica, stai aggiornando tutte le versioni del prodotto. Non sarai in grado di limitare i tipi di istanze consigliati. Il tipo di istanza consigliato è a livello di versione, quindi è possibile che il venditore non sia in grado di limitare più tipi di istanza.

Per un prodotto a consumo interno, è necessario chiamare tipi di modifica diversi al momento della chiamata. RestrictDimensions Ciò impedisce la creazione di nuove offerte per i tipi di istanza soggetti a restrizioni.

Per limitare o limitare i tipi di istanze disponibili per il AMI-based prodotto, richiama l'operazione StartChangeSet API con il tipo di RestrictInstanceTypes modifica, come mostrato nell'esempio seguente.

Sintassi della richiesta

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "RestrictInstanceTypes",
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "AmiProduct@1.0"
      },
      "DetailsDocument":
      {
        "InstanceTypes":
        [
          "m1.medium"
        ]
      }
    }
  ]
}

Fornisci informazioni per i campi per aggiungere il tipo di RestrictInstanceTypes modifica.

Sintassi della risposta

Viene creato un set di modifiche per la tua richiesta. La risposta a questa richiesta fornisce la ChangeSetId e ChangeSetArn per il set di modifiche ed è simile alla seguente.

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

La richiesta di modifica viene aggiunta a una coda ed elaborata. Ciò includeva la convalida delle informazioni per garantire che soddisfino le linee guida. AWS Marketplace 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 AWS Marketplace l'API del catalogo utilizzando l'operazione DescribeChangeSet API.

Convalide sincrone

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

Gli errori seguenti sono specifici RestrictInstanceTypes 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.