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

Collabora con il marketplace privato utilizzando Marketplace AWS "Hello, World!"

Puoi utilizzarlo AWS Marketplace Catalog API per gestire un marketplace privato per la tua Account AWS organizzazione.

Tutti i tipi di modifica possono essere richiamati solo dall'account di gestione dell'organizzazione o da un account membro che funge da amministratore delegato per il marketplace privato. Se attualmente sei un cliente di Private Marketplace e non AWS Organizations disponi dell'integrazione per Private Marketplace, puoi creare e gestire un marketplace privato da qualsiasi account della tua organizzazione che disponga della policy AWSPrivateMarketplaceAdminFullAccess IAM.

Per ulteriori informazioni sui marketplace privati, consulta Private Marketplaces nella Guida all'Marketplace AWS acquisto.

La tabella seguente descrive in dettaglio una serie di attività per la gestione dei marketplace privati e i tipi di modifica applicabili a ciascuna attività.

Creazione di un marketplace privato

Un marketplace privato per un utente Account AWS può essere considerato come un elenco di prodotti che gli utenti possono acquistare tramite quell'account e il marchio per il marketplace. In un'organizzazione con più account, puoi utilizzare il raggruppamento AWS Organizations chiamato unità organizzativa (OU) per associarlo a un'esperienza. Ad esempio, potresti avere un set di prodotti che tutti gli account dell'organizzazione sono autorizzati ad acquistare oppure potresti avere un elenco di prodotti diverso per ogni unità organizzativa dell'organizzazione. È inoltre possibile disporre di un elenco diverso di prodotti per i singoli account dell'organizzazione. Ogni elenco di prodotti e marchi approvati viene definito esperienza di approvvigionamento.

In AWS Marketplace Catalog API, quattro entità rappresentano un'esperienza:

I passaggi per creare un'esperienza di approvvigionamento sono i seguenti:

Crea l'Experienceentità

Per creare l'Experienceentità, utilizza l'StartChangeSetazione con il CreateExperience valore del ChangeType parametro da cui richiedere la creazione dell'esperienza Marketplace AWS. Vedere l'esempio di codice seguente.

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "CreateExperience",
      "DetailsDocument":
      {
        "Name": "ExamplePrivateMarketplace"
      },
      "Entity":
      {
        "Type": "Experience@1.0"
      }
    }
  ],
  "ChangeSetName": "Create Private Marketplace Example"
}

In questa azione, Entity è un modello per l'entità che desideri creare. Gli viene assegnato un al EntityId momento della creazione. ChangeSetNameidentifica la modifica per aiutarti a trovarla in un secondo momento.

La risposta avrà il seguente aspetto.

{
   "ChangeSetArn": "arn:...:AWSMarketplace/ChangeSet/abcd1234example5678frjzkz",
   "ChangeSetId": "abcd1234example5678frjzkz"
}

La risposta include un messaggio ChangeSetId che è possibile utilizzare per conoscere lo stato della richiesta di modifica man mano che viene elaborataDescribeChangeSet. Puoi anche usarla ListEntities per trovare la tua Experience entità senza ilChangeSetId. Per ulteriori informazioni sui set di modifiche, consulta Utilizzo dei set di modifiche.

Per impostazione predefinita, Experience un'entità appena creata non dispone di una politica di approvvigionamento. Viene inoltre creata con impostazioni predefinite per il branding. Per ulteriori informazioni sulle impostazioni di branding e su come personalizzarle, consulta. Modificare il branding di un'esperienza di marketplace privato

Crea un'entità ProcurementPolicy

È necessario creare un'ProcurementPolicyentità. Per impostazione predefinita, una nuova Experience entità è disabilitata, quindi è possibile creare la politica di approvvigionamento prima di abilitarla.

Per consentire o rifiutare i prodotti nel tuo marketplace privato, devi creare la politica di approvvigionamento. Per farlo, chiamate di nuovoStartChangeSet, ma questa volta con il ChangeType consenso di. CreateProcurementPolicy Il seguente esempio di codice crea una politica di approvvigionamento vuota.

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "CreateProcurementPolicy",
      "DetailsDocument":
      {
        "Name": "ExampleProcurementPolicy"
      },
      "Entity":
      {
        "Type": "Experience@1.0",
        "Identifier": "exp-1234example@1"
      }
    }
  ]
}

L'Entityentità fornita in questa azione è l'Experienceentità all'interno della quale si desidera creare la politica di approvvigionamento, quindi è necessario includere l'identificatore dell'entità creata in precedenza. Usa ListEntities per trovare l'entità. Experience È inoltre possibile restituire l'identificatore utilizzando l'DescribeChangeSetidentificatore del set di modifiche dell'azione CreateExperience

Puoi nuovamente utilizzare DescribeChangeSet il tipo di CreateProcurementPolicy modifica per seguire l'elaborazione della tua richiesta.

Dopo aver creato la politica di approvvigionamento, il tuo marketplace privato viene visualizzato in. Console di gestione AWS(Puoi andare alla pagina Private Marketplace per vederlo.) Dopo aver completato questi passaggi, il tuo marketplace privato verrà disabilitato, avrà un marchio predefinito, avrà una politica di approvvigionamento vuota e non sarà associato a nessun responsabile della tua organizzazione. Puoi aggiornare il marchio e aggiungere tutti i prodotti che desideri, associare l'esperienza a uno o più account e quindi abilitare il tuo marketplace privato.

Le sezioni seguenti descrivono la gestione del tuo marketplace privato con. AWS Marketplace Catalog API

Modificare il branding di un'esperienza di marketplace privato

Puoi personalizzare l'aspetto del tuo marketplace privato per i tuoi utenti. Senza personalizzazione, il tuo marketplace privato avrà le impostazioni di branding predefinite, descritte di seguito. Gli aspetti del branding che puoi modificare in un marketplace privato includono quanto segue:

Per impostare questi valori, devi prima creare un'BrandingSettingsentità con il tipo di CreateBrandingSettings modifica. Puoi quindi richiedere una UpdateBrandingSettings modifica per impostare o modificare il marchio. Devi creare un BrandingSettings oggetto solo una volta. Per creare questo oggetto, chiamate StartChangeSet con il tipo di CreateBrandingSettings modifica, come mostrato nel seguente esempio di codice.

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "CreateBrandingSettings",
      "DetailsDocument":
      {
        "Name": "ExampleBrandingSettingsName"
      },
      "Entity":
      {
        "Type": "Experience@1.0",
        "Identifier": "exp-1234example@2"
      }
    }
  ]
}

Questo esempio modifica l'Experienceentità aggiungendovi l'BrandingSettingsoggetto. La revisione dell'identificatore di entità è stata incrementata a. 2 Per ulteriori informazioni sulle revisioni degli identificatori, vedere. Identificatore

È possibile modificare le impostazioni chiamando StartChangeSet con il tipo di UpdateBrandingSettings modifica. Le impostazioni fanno parte Configuration dell'DetailsDocumentoggetto.

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateBrandingSettings",
      "DetailsDocument":
      {
        "Name": "ExampleBrandingSettingsName",
        "Description": "Example description",
        "Configuration":
        {
          "Title": "ExampleName",
          "Information": "Example description.",
          "ThemeColor": "#0e7f74",
          "LogoUrl": "https://example.com/path/mylogo.png"
        }
      },
      "Entity":
      {
        "Type": "Experience@1.0",
        "Identifier": "exp-1234example@3"
      }
    }
  ]
}

Attivazione o disabilitazione di un'esperienza di marketplace privata

Quando un marketplace privato è abilitato (e dispone di una politica di approvvigionamento), gli utenti degli account associati possono acquistare solo i prodotti che hai approvato. Quando non è abilitata un'esperienza di marketplace privato per un account, gli utenti possono acquistare prodotti nell'intero Marketplace AWS catalogo.

Per abilitare un marketplace privato, utilizza l'StartChangeRequestazione con il tipo di UpdateExperience modifica.

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateExperience",
      "DetailsDocument":
      {
        "Status": "Enabled"
      },
      "Entity":
      {
        "Type": "Experience@1.0",
        "Identifier": "exp-1234example@4"
      }
    }
  ]
}

Allo stesso modo, puoi utilizzare la stessa azione eChangeType, tuttavia, modificarla Status in DetailsDocument Disabled per disabilitare un marketplace privato.

Abilitazione o disabilitazione delle richieste degli utenti

Gli utenti della tua organizzazione possono visualizzare il pubblico completo Marketplace AWS, ma possono abbonarsi solo ai prodotti che hai consentito. Per impostazione predefinita, possono richiedere l'aggiunta di un prodotto che non si trova nel marketplace privato. Queste richieste vengono visualizzate nella pagina dell'amministratore del marketplace privato (Private Marketplace), dove puoi decidere se accettare o rifiutare la richiesta (e se bloccare ulteriori richieste per lo stesso prodotto). Non puoi visualizzare o rispondere alle richieste utilizzando l'API Catalog.

Puoi abilitare o disabilitare la possibilità per gli utenti di creare richieste per la tua esperienza di marketplace privata. Da utilizzare StartChangeSet con il tipo di UpdateProcurementPolicy modifica. La possibilità di effettuare richieste è disabilitata nel seguente esempio di codice.

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateProcurementPolicy",
      "DetailsDocument":
      {
        "Configuration":
        {
          "PolicyResourceRequests": "Deny"
        }
      },
      "Entity":
      {
        "Type": "Experience@1.0",
        "Identifier": "exp-1234example@5"
      }
    }
  ]
}

Per abilitare la funzionalità di richiesta di modifica per gli utenti, usa Allow invece di Deny inPolicyResourceRequests.

Per informazioni su come ottenere lo stato corrente di questa impostazione, consulta la sezione successiva,Ottenere un elenco di prodotti in un'esperienza di marketplace privata.

Ottenere un elenco di prodotti in un'esperienza di marketplace privata

I prodotti consentiti (e rifiutati) in un marketplace privato fanno parte della politica di approvvigionamento dell'Experienceentità. Per ottenere i dettagli sulle politiche di approvvigionamento in un marketplace privato, devi prima ottenere l'identificatore della politica di approvvigionamento dall'Experienceentità, quindi chiamare DescribeEntity con quell'identificatore.

Per ottenere l'identificatore della politica di approvvigionamento, utilizzalo DescribeEntity sull'Experienceentità che ti interessa, come mostrato nel comando seguente.

GET /DescribeEntity?catalog=AWSMarketplace&entityId=exp-example01

Di seguito è riportata una risposta di esempio:

{
  "Details": "{\"Name\":\"New Private Marketplace\", \"Status\":\"Enabled\", \"ProcurementPolicies\":[\"procpolicy-123example456\"], \"BrandingSettings\":[\"brandsettings-456example123\"]}",
  "DetailsDocument":
  {
    "Name": "New Private Marketplace",
    "Status": "Enabled",
    "ProcurementPolicies":
    [
      "procpolicy-123example456"
    ],
    "BrandingSettings":
    [
      "brandsettings-456example123"
    ]
  },
  "EntityArn": "arn:<...>:AWSMarketplace/Experience/exp-example-01",
  "EntityIdentifier": "exp-example01@6",
  "EntityType": "Experience@1.0",
  "LastModifiedDate": "2021-01-13T20:31:36Z"
}

È possibile utilizzare il comando restituito EntityId per la politica di approvvigionamento per ottenere i dettagli, come illustrato nel comando seguente.

GET /DescribeEntity?catalog=AWSMarketplace&entityId=procpolicy-123example456

Ciò restituisce i dettagli completi della politica, inclusi i prodotti consentiti e quelli rifiutati. Di seguito è riportata una risposta di esempio:

{
  "Details": "{\"Name\":\"ExampleProcurementPolicy\", \"Statements\":[{\"Effect\":\"Allow\",\"Resources\":[{\"Type\":\"Product\",\"Ids\":[\"example1-1234-abcd-5678-90abcdef1234\"]},{\"Type\":\"Product\",\"Ids\":[\"example2-2345-bcde-6789-01bcdea2345\"]}]},{\"Effect\":\"Deny\",\"Resources\":[{\"Type\":\"Product\",\"Ids\":[\"example3-3456-cdef-7890-12defabc5678\"]}]}],\"Configuration\":{\"PolicyResourceRequests\":\"Allow\"}}",
  "DetailsDocument":
  {
    "Name": "ExampleProcurementPolicy",
    "Statements":
    [
      {
        "Effect": "Allow",
        "Resources":
        [
          {
            "Type": "Product",
            "Ids":
            [
              "example1-1234-abcd-5678-90abcdef1234"
            ]
          },
          {
            "Type": "Product",
            "Ids":
            [
              "example2-2345-bcde-6789-01bcdea2345"
            ]
          }
        ]
      },
      {
        "Effect": "Deny",
        "Resources":
        [
          {
            "Type": "Product",
            "Ids":
            [
              "example3-3456-cdef-7890-12defabc5678"
            ]
          }
        ]
      }
    ],
    "Configuration":
    {
      "PolicyResourceRequests": "Allow"
    }
  },
  "EntityArn": "arn:<...>AWSMarketplace/ProcurementPolicy/procpolicy-123example456",
  "EntityIdentifier": "procpolicy-123example456@4",
  "EntityType": "ProcurementPolicy@1.0",
  "LastModifiedDate": "2020-10-01T12:00:00Z"
}

In questo esempio, la politica di approvvigionamento prevede due prodotti consentiti e un prodotto negato. La politica consente le richieste di risorse degli utenti.

Aggiungere o rimuovere prodotti da un marketplace privato

Per impostazione predefinita, un marketplace privato non contiene prodotti approvati. Utilizza le richieste di modifica per aggiungere o rimuovere un prodotto. Per aggiungere un prodotto, usa il tipo di AllowProductProcurement modifica. Per rimuovere un prodotto, usa il tipo di DenyProductProcurement modifica.

Il seguente esempio di codice mostra il tipo di AllowProductProcurement modifica con l'StartChangeSetazione per aggiungere un prodotto a un marketplace privato.

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "AllowProductProcurement",
      "DetailsDocument":
      {
        "Products":
        [
          {
            "Ids":
            [
              "example-1234-abcd-5678-90abcded1234"
            ],
            "Notes": "Useful product"
          }
        ]
      },
      "Entity":
      {
        "Identifier": "exp-1234example@6",
        "Type": "Experience@1.0"
      }
    }
  ]
}

Aggiungi il prodotto all'Experienceentità per un marketplace privato utilizzandoAllowProductProcurement. La sintassi per rimuovere un prodotto da un marketplace privato è identica, con l'eccezione che utilizzi DenyProductProcurement ChangeType invece diAllowProductProcurement. I prodotti vengono aggiunti all'elenco consentito (o negato) dell'ProcurementPolicyentità contenuta dall'entità. Experience

Ricerca di prodotti

Consultando i dettagli della tua politica di approvvigionamento, puoi trovare gli ID dei prodotti che sono già presenti su un marketplace privato. Tuttavia, AWS Marketplace Catalog API non fornisce un modo per trovare gli ID di prodotto di altri prodotti. Esistono due modi per ottenere gli ID dei prodotti da utilizzare con il servizio Catalog API:

Collaborazione con marketplace privati per AWS Organizations

Sia che lavori con un marketplace privato per il tuo account o per la tua organizzazione, utilizzi la stessa API. Tuttavia, ci sono delle differenze quando si lavora all'interno della propria organizzazione:

Per elencare Experience gli oggetti nel tuo account, chiama ListEntities come mostrato nel seguente esempio di codice.

POST /ListEntities HTTP/1.1
Content-Type: application/json

{
    "Catalog":"AWSMarketplace", 
    "EntityType":"Experience"
}

Tuttavia, per elencare le entità che sono state condivise con te, devi aggiungere un FilterList con a Scope ofSharedWithMe, come illustrato nel seguente esempio di codice. Di conseguenza, Marketplace AWS cerca al di fuori del tuo account per trovare le entità condivise con te.

POST /ListEntities HTTP/1.1
Content-Type: application/json

{"Catalog":"AWSMarketplace", 
"EntityType":"Experience",
 "FilterList": 
  [{
     "Name": "Scope",
     "ValueList":
      ["SharedWithMe"]
      }]}

In questo caso, vengono restituite solo le entità esterne al tuo account (quelle della tua organizzazione).

Analogamente, per chiamareListChangeSets, è necessario impostare l'ambito, come illustrato nel seguente esempio di codice.

POST /ListChangeSets HTTP/1.1
Content-Type: application/json

{"Catalog":"AWSMarketplace", 
 "FilterList": 
  [{
     "Name": "Scope",
     "ValueList":
      ["SharedWithMe"]
      }]}

Ciò restituisce i set di modifiche che si applicano a un marketplace privato condiviso per l'organizzazione.

Associare i principi alle esperienze

Un'esperienza di mercato privato deve essere associata a uno o più principi per avere effetti sull'organizzazione. Per una singola Account AWS persona, devi associare l'account all'esperienza per utilizzare il marketplace privato. In un'organizzazione, puoi avere più esperienze applicate a diversi dirigenti.

Per associare un responsabile a un'esperienza, utilizza il tipo di AssociateAudience modifica all'StartChangeSetazione, come illustrato nel seguente esempio di codice.

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "Entity":
      {
        "Type": "Experience@1.0",
        "Identifier": "exp-example01@1"
      },
      "ChangeType": "AssociateAudience",
      "DetailsDocument":
      {
        "Name": "AudienceName",
        "Description": "Audience example.",
        "Principals":
        [
          "012345678901",
          "ou-abcd-01234567",
          "o-0123456789"
        ]
      }
    }
  ],
  "ChangeSetName": "Set Audience for experience 01"
}

Il pubblico è l'elenco dei principali associati a. Experience Un principale è un' Account AWS unità organizzativa o un'organizzazione definita dal relativo ID. Principalsè un elenco, quindi puoi includere più presidi da associare all'esperienza. Dopo la prima chiamata, le chiamate successive al tipo di AssociateAudience modifica aggiungeranno i principali all'associazione per l'esperienza.

Puoi anche rimuovere account da un'esperienza. A tale scopo, utilizzate il tipo di DisassociateAudience modifica, come illustrato nel seguente esempio di codice.

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "Entity":
      {
        "Type": "Experience@1.0",
        "Identifier": "exp-example01@02"
      },
      "ChangeType": "DisassociateAudience",
      "DetailsDocument":
      {
        "Principals":
        [
          "012345678901",
          "ou-abcd-01234567",
          "o-0123456789"
        ]
      }
    }
  ],
  "ChangeSetName": "Disassociate audience example"
}

Archiviazione e riattivazione di un'esperienza di marketplace privata

Puoi rimuovere un'esperienza di marketplace privata archiviandola. Le esperienze archiviate non possono essere aggiornate o utilizzate per gestire gli account della tua organizzazione. Se hai dei segmenti di pubblico associati a un'esperienza archiviata, puoi associarli a un'esperienza diversa. Se decidi di utilizzare l'esperienza in un secondo momento, puoi sempre riattivarla. Gli amministratori dell'account di gestione o di un account membro che è amministratore delegato di Private Marketplace dispongono delle autorizzazioni per archiviare e riattivare le esperienze. Se sei attualmente cliente di Private Marketplace e non disponi dell' AWS Organizations integrazione per Private Marketplace, gli amministratori dell'account che ha creato l'esperienza dispongono delle autorizzazioni per archiviare e riattivare le esperienze.

Per archiviare un'esperienza, utilizza il tipo di RestrictExperience modifica con l'StartChangeSetazione, come mostrato nel seguente esempio di codice.

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "RestrictExperience",
      "DetailsDocument":
      {},
      "Entity":
      {
        "Type": "Experience@1.0",
        "Identifier": "exp-1234example"
      }
    }
  ]
}

Per riattivare un'esperienza, usa il tipo di ReviveExperience modifica con l'StartChangeSetazione, come mostrato nel seguente esempio di codice.

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "ReviveExperience",
      "DetailsDocument":
      {},
      "Entity":
      {
        "Type": "Experience@1.0",
        "Identifier": "exp-1234example"
      }
    }
  ]
}

Errori nell'API del marketplace privato

I seguenti errori sono specifici delle azioni del marketplace privato nell'API Marketplace AWS Catalog.

Tipi di entità definiti dal marketplace privato

La tabella seguente elenca i tipi di entità del marketplace privato, lo scopo e le azioni su cui è possibile specificare ciascuno di essi. Ogni tipo di entità può essere utilizzato per specificare una risorsa Amazon Resource Name (ARN) che può essere utilizzata nella policy AWS Identity and Access Management (IAM). Per ulteriori dettagli sui formati ARN, vedere. Entità API del catalogo