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à.
AWS Service Catalog Panoramica delle API
Vantaggi dell'utilizzo dell'API Service Catalog
L' AWS Service Catalog API fornisce il controllo programmatico su tutte le azioni dell'utente finale in alternativa all'utilizzo di. Console di gestione AWS Quando si utilizza l'API, è possibile effettuare le seguenti operazioni:
-
Scrivi le tue interfacce e app personalizzate
-
Ottieni un controllo dettagliato delle operazioni di fornitura dei prodotti per gli utenti finali
-
Integra il provisioning delle risorse nelle tue pipeline di orchestrazione
-
Accedi a una posizione centrale che ospita le tue applicazioni con le relative risorse
Accedi al Service Catalog
Per creare applicazioni utilizzando API specifiche per una lingua, utilizza le librerie, il codice di esempio, i tutorial e altre risorse per gli sviluppatori di software. Le librerie offrono funzioni di base per automatizzare attività quali la firma crittografica delle richieste, la ripetizione delle richieste e la gestione delle risposte agli errori, semplificando le attività iniziali. Per iniziare, apri gli strumenti per Amazon Web Services
Se preferisci usare un'interfaccia a riga di comando, hai a disposizione le seguenti opzioni:
- AWS Interfaccia a riga di comando (CLI)
-
Per iniziare, consulta la AWS Command Line Interface Guida per l'utente di . Per ulteriori informazioni sui comandi per Service Catalog, vedere servicecatalog nel Command Reference.AWS CLI
- AWS Strumenti per Windows PowerShell
-
Per iniziare, consulta la AWS Strumenti per PowerShell Guida per l'utente di . Per ulteriori informazioni sui cmdlet per Service Catalog, aprire il AWS Strumenti per PowerShell Cmdlet Reference ed espandere. AWS Service Catalog
L' AWS Service Catalog API può essere suddivisa logicamente nelle seguenti categorie.
Argomenti
Scoperta del prodotto
Utilizza queste operazioni per scoprire o ottenere informazioni sui prodotti e sui relativi requisiti di lancio. Queste operazioni non creano o modificano risorse.
- SearchProducts
-
Elenca tutti i prodotti a cui il chiamante ha accesso.
- DescribeProduct
-
Ottieni informazioni dettagliate su un prodotto.
- DescribeProductView
-
Identico dal punto di vista funzionale a
DescribeProduct, tranne per il fatto che richiede l'ID di una visualizzazione del prodotto anziché l'ID di un prodotto. - ListLaunchPaths
-
Elenca tutti i modi in cui l'utente ha accesso a un prodotto specifico, denominati percorsi verso il prodotto. Un utente deve selezionare un percorso per effettuare il provisioning del prodotto.
- DescribeProvisioningParameters
-
Ottiene i parametri necessari per il provisioning di un prodotto specifico e fornisce metadati aggiuntivi su ciò che accadrà quando il prodotto viene fornito.
Ciascuno
ProvisioningArtifactParameterè qualcosa che l'utente deve specificare per fornire correttamente il prodotto (ad esempio, la dimensione di un'istanza EC2). GliConstraintSummaryoggetti contengono l'elenco dei valori consentiti e dei metadati aggiuntivi sugli oggetti.ProvisioningArtifactParameter
Richieste di approvvigionamento
Utilizza queste operazioni per richiedere, aggiornare o terminare la fornitura di un prodotto.
- ProvisionProduct
-
Richiede la fornitura di un prodotto. Fornire un prodotto significa mettere a disposizione le risorse necessarie per portarlo online per un utilizzo effettivo. Ad esempio, fornire un prodotto supportato da un CloudFormation modello significa avviare uno CloudFormation stack e tutte le relative risorse sottostanti.
- UpdateProvisionedProduct
-
Aggiorna la configurazione di un prodotto fornito. Ad esempio, un prodotto supportato da CloudFormation aggiorna lo CloudFormation stack sottostante. Il richiedente deve disporre di autorizzazioni di accesso sufficienti per quanto specificato. ProvisionedProduct
- TerminateProvisionedProduct
-
Richiede la cessazione di un prodotto fornito. Ad esempio, per un prodotto supportato da CloudFormation, questo elimina lo stack sottostante. CloudFormation Il richiedente deve disporre di autorizzazioni di accesso sufficienti al prodotto fornito specificato.
Prodotti con provisioning
Utilizzate queste operazioni per ottenere informazioni sui prodotti forniti. Queste operazioni non creano o modificano risorse.
- ListRecordHistory
-
Elenca tutte le richieste eseguite, anche per i prodotti con provisioning terminato.
- DescribeRecord
-
Ottiene informazioni su una richiesta. Utilizzate questa operazione dopo l'operazione di richiesta per ottenere
RecordDetailinformazioni correnti. - SearchProvisionedProducts
-
Ottiene informazioni sui prodotti forniti che soddisfano i criteri specificati.
- ScanProvisionedProducts
-
Elenca i prodotti forniti che non sono terminati.
- DescribeProvisionedProduct
-
Ottiene informazioni su un prodotto fornito.
- ImportAsProvisionedProduct
-
Richiede l'importazione di una risorsa come prodotto fornito di Service Catalog associato a un prodotto Service Catalog e a un elemento di provisioning. Una volta importate, tutte le azioni di governance di Service Catalog supportate sono supportate sul prodotto fornito.
- UpdateProvisionedProductProperties
-
Richiede aggiornamenti alle proprietà del prodotto fornito specificato.
Piani di prodotto forniti
Utilizzate queste operazioni per gestire i piani di prodotto assegnati. Un piano include l'elenco di risorse da creare o modificare quando si esegue il piano.
- CreateProvisionedProductPlan
Crea un piano.
- DescribeProvisionedProductPlan
Ottiene informazioni sulle modifiche alle risorse per un piano.
- ExecuteProvisionedProductPlan
Effettua il provisioning o modifica un prodotto in base a un piano.
- ListProvisionedProductPlans
Elenca i piani per un prodotto fornito.
- DeleteProvisionedProductPlan
Elimina un piano.
Portafogli
Gli amministratori del catalogo utilizzano queste operazioni per fornire tutte le operazioni necessarie per la gestione del portafoglio.
- CreatePortfolio
Crea un portafoglio.
- DeletePortfolio
Elimina un portfolio.
- DescribePortfolio
Ottiene informazioni dettagliate su un portfolio.
- DescribePortfolioShares
Restituisce un riepilogo di ciascuna delle azioni di portafoglio create per il portafoglio specificato.
- ListPortfolios
Elenca tutti i portafogli del catalogo.
- ListPortfoliosForProduct
Elenca tutti i portafogli a cui è associato un prodotto.
- UpdatePortfolio
Aggiorna un portfolio.
- UpdatePortfolioShare
Aggiorna una quota di portafoglio.
- CreatePortfolioShare
Condivide un portafoglio con un AWS account.
- DeletePortfolioShare
Interrompe la condivisione di un portafoglio.
- AcceptPortfolioShare
Accetta un'offerta per condividere un portafoglio.
- RejectPortfolioShare
Rifiuta un'offerta di condivisione di un portafoglio.
- ListAcceptedPortfolioShares
Elenca i dettagli di tutti i portafogli per i quali la condivisione è stata accettata da questo account.
- ListPortfolioAccess
Elenca gli ID degli account che hanno accesso a un portafoglio.
Associazione principale
Gli amministratori del catalogo utilizzano queste operazioni per fornire tutte le operazioni necessarie per l'associazione principale.
- AssociatePrincipalWithPortfolio
Associa un ARN principale a un portafoglio.
- DisassociatePrincipalFromPortfolio
Dissocia un ARN principale da un portafoglio.
- ListPrincipalsForPortfolio
Elenca tutti gli ARN principali associati a un portafoglio.
Prodotti
Gli amministratori del catalogo utilizzano queste operazioni per fornire tutte le operazioni necessarie per la gestione dei prodotti.
- SearchProductsAsAdmin
Ottiene informazioni di riepilogo e sullo stato dei prodotti.
- DescribeProductAsAdmin
Ottiene informazioni su un prodotto.
- CreateProduct
Crea un prodotto.
- CopyProduct
Copia un prodotto.
- DescribeCopyProductStatus
Ottiene lo stato dell'operazione di copia del prodotto.
- UpdateProduct
Aggiorna un prodotto.
- DeleteProduct
Elimina un prodotto.
- AssociateProductWithPortfolio
Associa un prodotto a un portafoglio.
- DisassociateProductFromPortfolio
Dissocia un prodotto da un portafoglio.
Approvvigionamento di artefatti
Gli amministratori del catalogo utilizzano queste operazioni per gestire gli elementi di provisioning (noti anche come versioni del prodotto).
- DescribeProvisioningArtifact
Ottiene informazioni su un elemento di provisioning.
- CreateProvisioningArtifact
Crea un elemento di approvvigionamento per un prodotto.
- DeleteProvisioningArtifact
Elimina un elemento di approvvigionamento.
- ListProvisioningArtifacts
Elenca tutti gli elementi di approvvigionamento associati a un prodotto.
- UpdateProvisioningArtifact
Aggiorna un elemento di approvvigionamento.
Vincoli
L'amministratore del catalogo utilizza queste operazioni e gestisce i vincoli.
- CreateConstraint
Crea un vincolo.
- DeleteConstraint
Elimina un vincolo.
- DescribeConstraint
Ottiene informazioni su un vincolo.
- UpdateConstraint
Aggiorna un vincolo.
- ListConstraintsForPortfolio
Ottiene informazioni sui vincoli per un portafoglio e un prodotto.
Azioni di servizio
Gli amministratori del catalogo utilizzano queste operazioni per gestire le azioni di servizio.
- AssociateServiceActionWithProvisioningArtifact
Associa un'azione self-service a un elemento di approvvigionamento.
- CreateServiceAction
Crea un'operazione self-service
- DeleteServiceAction
Elimina un'operazione self-service
- DescribeServiceAction
Descrive un'operazione self-service
- DescribeServiceActionExecutionParameters
Trova i parametri predefiniti per una specifica azione self-service su uno specifico prodotto fornito e restituisce una mappa dei risultati all'utente.
- ExecuteProvisionedProductServiceAction
Esegue un'azione self-service su un prodotto fornito.
- UpdateServiceAction
Aggiorna un'operazione self-service
TagOptions
Gli amministratori del catalogo utilizzano queste operazioni per gestire. TagOptions
- CreateTagOption
Crea un TagOption.
- ListTagOptions
Elenca i tuoi TagOptions.
- DescribeTagOption
Descrive a TagOption.
- UpdateTagOption
Aggiornamenti a TagOption.
- AssociateTagOptionWithResource
Associa a TagOption a una risorsa.
- DisassociateTagOptionFromResource
Dissocia una TagOption da una risorsa.
- ListResourcesForTagOption
Elenca le risorse per un. TagOption
- DeleteTagOption
Elimina un TagOption.
AppRegistry
Funge da archivio per le applicazioni, le relative risorse e i metadati delle applicazioni utilizzati nell'azienda.
- AssociateAttributeGroup
Associa un gruppo di attributi a un'applicazione per ampliare i metadati dell'applicazione con gli attributi del gruppo.
- AssociateResource
Associa una risorsa a un'applicazione.
- CreateApplication
Crea una nuova applicazione che è il nodo di primo livello in una gerarchia di astrazioni di risorse cloud correlate.
- CreateAttributeGroup
Crea un nuovo gruppo di attributi come container per gli attributi definiti dall'utente.
- DeleteApplication
Elimina un'applicazione specificata dall'ID o dal nome dell'applicazione.
- DeleteAttributeGroup
Elimina un gruppo di attributi, specificato dall'ID o dal nome del gruppo di attributi.
- DisassociateAttributeGroup
Dissocia un gruppo di attributi da un'applicazione per rimuovere gli attributi aggiuntivi contenuti nel gruppo di attributi dai metadati dell'applicazione.
- DisassociateResource
Dissocia una risorsa dall'applicazione.
- GetApplication
Recupera le informazioni sui metadati su una delle tue applicazioni.
- GetAssociatedResource
Ottiene la risorsa associata all'applicazione.
- GetAttributeGroup
Recupera un gruppo di attributi, in base al nome o all'ID.
- ListApplications
Elenca tutti i gruppi di attributi associati all'applicazione specificata.
- ListAssociatedAttributeGroups
Elenca tutti i gruppi di attributi associati all'applicazione specificata.
- ListAssociatedResources
Elenca tutte le risorse associate all'applicazione specificata.
- ListAttributeGroups
Elenca tutti i gruppi di attributi a cui si ha accesso.
- ListAttributeGroupsForApplication
Elenca i dettagli di tutti i gruppi di attributi associati a un'applicazione specifica.
- ListTagsForResource
Elenca tutti i tag della risorsa.
- TagResource
Assegna uno o più tag (coppie chiave-valore) alla risorsa specificata.
- SyncResource
Sincronizza la risorsa con ciò che è attualmente registrato in. AppRegistry
- UntagResource
Rimuove i tag da una risorsa.
- UpdateApplication
Aggiorna un'applicazione esistente con nuovi attributi.
- UpdateAttributeGroup
Aggiorna un gruppo di attributi esistente con nuovi dettagli.
Esempio di workflow
In questo scenario, l'amministratore crea le risorse utilizzando AWS Service Catalog e un utente finale trova i prodotti disponibili ed effettua il provisioning del prodotto. Questo è un esempio di flusso di lavoro; questo non è l'unico modo di utilizzare l' AWS Service Catalog API.
Attività dell'amministratore
Crea portafogli, visualizzazioni dei prodotti, prodotti, versioni dei prodotti e vincoli.
Assegna gli utenti IAM ai prodotti, il che consente loro di accedere.
Attività per l'utente finale
-
L'utente chiama SearchProductssenza argomenti. Ciò restituisce l'elenco dei prodotti a cui l'utente ha accesso, nonché un "SearchDomain" che può essere utilizzato per definire i risultati.
-
L'utente continua a chiamare SearchProductscon filtri di ricerca aggiuntivi fino a trovare il prodotto desiderato.
-
L'utente chiama DescribeProductViewper trovare l'elenco degli elementi di provisioning (noti anche come versioni) per questo prodotto. Ciò determina ciò che l'utente effettivamente fornisce.
-
L'utente chiama ListLaunchPathsper trovare l'elenco dei percorsi per questo prodotto, insieme ai vincoli per ogni percorso. Ciò determina l'insieme di vincoli applicato al prodotto fornito.
-
Dopo aver scelto un elemento di provisioning e un percorso, l'utente chiama. DescribeProvisioningParameters Ciò restituisce l'elenco dei parametri che l'utente deve fornire prima di effettuare il provisioning di un prodotto utilizzando l'elemento e il percorso di provisioning, insieme a eventuali istruzioni d'uso aggiuntive che l'amministratore ha deciso di fornire.
-
L'utente chiama ProvisionProduct, specificando il prodotto, l'elemento di provisioning, il percorso e i parametri di input. I parametri di input sono un elenco di coppie chiave-valore, in cui le chiavi vengono ottenute utilizzando DescribeProvisioningParameterse i valori vengono forniti dall'utente (ad esempio,).
{ParameterKey:"dbpassword", ParameterValue:"mycoolpassword"}Questo avvia un flusso di lavoro per creare le risorse specificate. AWS Crea inoltre un dettaglio del record che tiene traccia della richiesta di approvvigionamento e un oggetto di prodotto fornito che rappresenta le risorse sottostanti AWS . -
L'utente esegue un sondaggio DescribeRecordper vedere quando lo stato dei dettagli del record cambia dallo
IN_PROGRESSstato allo stato completato (uno oSUCCEEDEDl'altro).ERROR -
Quando i dettagli del record per la richiesta sono completati, l'utente chiama ancora DescribeRecorduna volta. Gli output identificano le risorse create.
-
L'utente chiama UpdateProvisionedProductper aggiornare le risorse sottostanti esistenti. A seconda degli aggiornamenti specifici richiesti, questa operazione può essere aggiornata senza interruzioni, con qualche interruzione o sostituire completamente il prodotto fornito.
-
Infine, l'utente chiama TerminateProvisionedProductper terminare il prodotto fornito.
