Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
AWS Service Catalog Présentation de l'API
Avantages de l'utilisation de l'API Service Catalog
L' AWS Service Catalog API fournit un contrôle programmatique sur toutes les actions de l'utilisateur final au lieu d'utiliser le. AWS Management Console Lorsque vous utilisez l'API, vous pouvez effectuer les opérations suivantes :
-
Écrivez vos propres interfaces et applications personnalisées
-
Bénéficiez d'un contrôle précis des opérations d'approvisionnement des produits destinés aux utilisateurs finaux
-
Intégrez le provisionnement des ressources dans vos pipelines d'orchestration
-
Accédez à un emplacement central qui héberge vos applications avec leurs ressources
Accéder au Service Catalog
Pour créer des applications à l'aide d'API spécifiques à un langage, utilisez les bibliothèques, les exemples de code, les didacticiels et les autres ressources destinées aux développeurs de logiciels. Ces bibliothèques offrent des fonctions de base qui automatisent les tâches telles que la signature cryptographique des demandes, les nouvelles tentatives de demande et la gestion des réponses d'erreur. Vous pouvez ainsi démarrer plus facilement. Pour commencer, ouvrez les Outils pour Amazon Web Services
Si vous préférez utiliser une CLI, vous disposez des options suivantes :
- AWS Interface de ligne de commande (CLI)
-
Consultez le AWS Command Line Interface Guide de l’utilisateur pour démarrer. Pour plus d'informations sur les commandes de Service Catalog, consultez servicecatalog dans le AWS CLI Command Reference.
- AWS Outils pour Windows PowerShell
-
Consultez le Outils AWS pour PowerShell Guide de l’utilisateur pour démarrer. Pour plus d'informations sur les applets de commande pour Service Catalog, ouvrez le Outils AWS pour PowerShell Cmdlet Reference et développez-le. AWS Service Catalog
L' AWS Service Catalog API peut être divisée de manière logique dans les catégories suivantes.
Rubriques
Découverte de produits
Utilisez ces opérations pour découvrir ou obtenir des informations sur les produits et leurs exigences de lancement. Ces opérations ne créent ni ne modifient les ressources.
- SearchProducts
-
Répertorie tous les produits auxquels l'appelant a accès.
- DescribeProduct
-
Obtenez des informations détaillées sur un produit.
- DescribeProductView
-
Identique sur le plan fonctionnel à
DescribeProduct, sauf qu'il prend l'ID d'une vue de produit au lieu de l'ID d'un produit. - ListLaunchPaths
-
Répertorie tous les moyens par lesquels l'utilisateur a accès à un produit spécifique, appelés chemins d'accès au produit. L'utilisateur doit sélectionner un chemin pour approvisionner le produit.
- DescribeProvisioningParameters
-
Obtient les paramètres nécessaires pour approvisionner un produit spécifique et fournit des métadonnées supplémentaires sur ce qui se passera lors du provisionnement du produit.
Chacun d'entre eux
ProvisioningArtifactParameterest un élément que l'utilisateur doit spécifier pour approvisionner correctement le produit (par exemple, la taille d'une instance EC2). LesConstraintSummaryobjets contiennent la liste des valeurs autorisées et des métadonnées supplémentaires lesProvisioningArtifactParameterconcernant.
Demandes de provisionnement
Utilisez ces opérations pour demander, mettre à jour ou mettre fin au provisionnement d'un produit.
- ProvisionProduct
-
Demande le provisionnement d'un produit. Fournir un produit, c'est lancer les ressources nécessaires pour mettre ce produit en ligne pour une utilisation réelle. Par exemple, le provisionnement d'un produit basé sur un CloudFormation modèle implique le lancement d'une CloudFormation pile et de toutes ses ressources sous-jacentes.
- UpdateProvisionedProduct
-
Met à jour la configuration d'un produit approvisionné. Par exemple, un produit soutenu par CloudFormation met à jour sa CloudFormation pile sous-jacente. Le demandeur doit disposer d'autorisations d'accès suffisantes à ce qui est spécifié ProvisionedProduct.
- TerminateProvisionedProduct
-
Demande la résiliation d'un produit approvisionné. Par exemple, pour un produit soutenu par CloudFormation, cela supprime la CloudFormation pile sous-jacente. Le demandeur doit disposer d'autorisations d'accès suffisantes au produit provisionné spécifié.
Produits provisionnés
Utilisez ces opérations pour obtenir des informations sur les produits approvisionnés. Ces opérations ne créent ni ne modifient les ressources.
- ListRecordHistory
-
Répertorie toutes les demandes effectuées, même pour les produits provisionnés résiliés.
- DescribeRecord
-
Obtient les informations relatives à une demande. Utilisez cette opération après l'opération de demande pour obtenir les
RecordDetailinformations actuelles. - SearchProvisionedProducts
-
Obtient des informations sur les produits approvisionnés qui répondent aux critères spécifiés.
- ScanProvisionedProducts
-
Répertorie les produits approvisionnés qui ne sont pas résiliés.
- DescribeProvisionedProduct
-
Permet d'obtenir des informations sur un produit approvisionné.
- ImportAsProvisionedProduct
-
Demande l'importation d'une ressource en tant que produit fourni par Service Catalog associé à un produit Service Catalog et à un artefact de provisionnement. Une fois importées, toutes les actions de gouvernance du Service Catalog prises en charge sont prises en charge sur le produit fourni.
- UpdateProvisionedProductProperties
-
Demande des mises à jour des propriétés du produit provisionné spécifié.
Plans de produits provisionnés
Utilisez ces opérations pour gérer vos plans de produits provisionnés. Un plan inclut la liste des ressources à créer ou à modifier lorsque vous l'exécutez.
- CreateProvisionedProductPlan
Crée un plan.
- DescribeProvisionedProductPlan
Permet d'obtenir des informations sur les modifications apportées aux ressources d'un plan.
- ExecuteProvisionedProductPlan
Provisionne ou modifie un produit en fonction d'un plan.
- ListProvisionedProductPlans
Répertorie les plans d'un produit approvisionné.
- DeleteProvisionedProductPlan
Supprime un plan.
Portefeuilles
Les administrateurs de catalogue utilisent ces opérations pour effectuer toutes les opérations nécessaires à la gestion du portefeuille.
- CreatePortfolio
Crée un portefeuille.
- DeletePortfolio
Supprime un portefeuille.
- DescribePortfolio
Permet d'obtenir des informations détaillées sur un portefeuille.
- DescribePortfolioShares
Renvoie un résumé de chacune des actions du portefeuille créées pour le portefeuille spécifié.
- ListPortfolios
Répertorie tous les portfolios du catalogue.
- ListPortfoliosForProduct
Répertorie tous les portefeuilles auxquels un produit est associé.
- UpdatePortfolio
Met à jour un portefeuille.
- UpdatePortfolioShare
Met à jour une part de portefeuille.
- CreatePortfolioShare
Partage un portefeuille avec un AWS compte.
- DeletePortfolioShare
Arrête de partager un portefeuille.
- AcceptPortfolioShare
Accepte une offre de partage d'un portefeuille.
- RejectPortfolioShare
Rejette une offre de partage d'un portefeuille.
- ListAcceptedPortfolioShares
Répertorie les détails de tous les portefeuilles pour lesquels le partage a été accepté par ce compte.
- ListPortfolioAccess
Répertorie les identifiants de compte ayant accès à un portefeuille.
Association principale
Les administrateurs de catalogue utilisent ces opérations pour effectuer toutes les opérations nécessaires à l'association principale.
- AssociatePrincipalWithPortfolio
Associe un ARN principal à un portefeuille.
- DisassociatePrincipalFromPortfolio
Dissocie un ARN principal d'un portefeuille.
- ListPrincipalsForPortfolio
Répertorie tous les principaux ARN associés à un portefeuille.
Produits
Les administrateurs de catalogue utilisent ces opérations pour effectuer toutes les opérations nécessaires à la gestion des produits.
- SearchProductsAsAdmin
Permet d'obtenir un résumé et des informations sur le statut des produits.
- DescribeProductAsAdmin
Permet d'obtenir des informations sur un produit.
- CreateProduct
Crée un produit.
- CopyProduct
Copie un produit.
- DescribeCopyProductStatus
Obtient le statut d'une opération de copie du produit.
- UpdateProduct
Met à jour un produit.
- DeleteProduct
Supprime un produit.
- AssociateProductWithPortfolio
Associe un produit à un portefeuille.
- DisassociateProductFromPortfolio
Dissocie un produit d'un portefeuille.
Artefacts de provisionnement
Les administrateurs de catalogue utilisent ces opérations pour gérer les artefacts de provisionnement (également appelés versions de produit).
- DescribeProvisioningArtifact
Obtient des informations sur un artefact d'approvisionnement.
- CreateProvisioningArtifact
Crée un artefact d'approvisionnement pour un produit.
- DeleteProvisioningArtifact
Supprime un artefact de provisionnement.
- ListProvisioningArtifacts
Répertorie tous les artefacts d'approvisionnement associés à un produit.
- UpdateProvisioningArtifact
Met à jour un artefact d'approvisionnement.
Constaintes
L'administrateur du catalogue utilise ces opérations pour gérer les contraintes.
- CreateConstraint
Crée une contrainte.
- DeleteConstraint
Supprime une contrainte.
- DescribeConstraint
Obtient des informations sur une contrainte.
- UpdateConstraint
Met à jour une contrainte.
- ListConstraintsForPortfolio
Obtient les informations de contrainte pour un portefeuille et un produit.
Actions liées au service
Les administrateurs de catalogue utilisent ces opérations pour gérer les actions de service.
- AssociateServiceActionWithProvisioningArtifact
Associe une action en libre-service à un artefact d'approvisionnement.
- CreateServiceAction
Crée une action en libre-service.
- DeleteServiceAction
Supprime une action en libre-service.
- DescribeServiceAction
Décrit une action en libre-service.
- DescribeServiceActionExecutionParameters
Recherche les paramètres par défaut pour une action en libre-service spécifique sur un produit fourni spécifique et renvoie une carte des résultats à l'utilisateur.
- ExecuteProvisionedProductServiceAction
Exécute une action en libre-service sur un produit approvisionné.
- UpdateServiceAction
Met à jour une action en libre-service.
TagOptions
Les administrateurs de catalogue utilisent ces opérations pour gérer TagOptions.
- CreateTagOption
Crée un TagOption.
- ListTagOptions
Répertorie votre TagOptions.
- DescribeTagOption
Décrit un TagOption.
- UpdateTagOption
Met à jour un TagOption.
- AssociateTagOptionWithResource
Associe a TagOption à une ressource.
- DisassociateTagOptionFromResource
Dissocie un TagOption d'une ressource.
- ListResourcesForTagOption
Répertorie les ressources pour un TagOption.
- DeleteTagOption
Supprime un TagOption.
AppRegistry
Sert de référentiel pour vos applications, leurs ressources et les métadonnées des applications que vous utilisez dans votre entreprise.
- AssociateAttributeGroup
Associe un groupe d'attributs à une application pour augmenter les métadonnées de l'application avec les attributs du groupe.
- AssociateResource
Associe une ressource à une application.
- CreateApplication
Crée une nouvelle application qui est le nœud de niveau supérieur d'une hiérarchie d'abstractions de ressources cloud associées.
- CreateAttributeGroup
Crée un nouveau groupe d'attributs en tant que conteneur pour les attributs définis par l'utilisateur.
- DeleteApplication
Supprime une application spécifiée par son ID ou son nom d'application.
- DeleteAttributeGroup
Supprime un groupe d'attributs, spécifié par son ID ou son nom de groupe d'attributs.
- DisassociateAttributeGroup
Dissocie un groupe d'attributs d'une application afin de supprimer les attributs supplémentaires contenus dans le groupe d'attributs des métadonnées de l'application.
- DisassociateResource
Dissocie une ressource de l'application.
- GetApplication
Récupère les informations de métadonnées relatives à l'une de vos applications.
- GetAssociatedResource
Obtient la ressource associée à l'application.
- GetAttributeGroup
Récupère un groupe d'attributs, soit par son nom, soit par son identifiant.
- ListApplications
Répertorie tous les groupes d'attributs associés à l'application spécifiée.
- ListAssociatedAttributeGroups
Répertorie tous les groupes d'attributs associés à l'application spécifiée.
- ListAssociatedResources
Répertorie toutes les ressources associées à l'application spécifiée.
- ListAttributeGroups
Répertorie tous les groupes d'attributs auxquels vous avez accès.
- ListAttributeGroupsForApplication
Répertorie les détails de tous les groupes d'attributs associés à une application spécifique.
- ListTagsForResource
Répertorie toutes les balises de la ressource.
- TagResource
Affecte une ou plusieurs balises (paires clé-valeur) à la ressource spécifiée.
- SyncResource
Synchronise la ressource avec ce qui est actuellement enregistré dans AppRegistry.
- UntagResource
Supprime des balises d'une ressource.
- UpdateApplication
Met à jour une application existante avec de nouveaux attributs.
- UpdateAttributeGroup
Met à jour un groupe d'attributs existant avec de nouveaux détails.
Exemple de flux de travail
Dans ce scénario, l'administrateur crée des ressources en utilisant AWS Service Catalog et un utilisateur final trouve quels produits sont disponibles et approvisionne le produit. Il s'agit d'un exemple de flux de travail ; ce n'est pas la seule façon d'utiliser l' AWS Service Catalog API.
Tâches d'administrateur
Créez des portefeuilles, des vues de produits, des produits, des versions de produits et des contraintes.
Assignez les utilisateurs IAM aux produits, ce qui leur donne accès.
Tâches de l'utilisateur final
-
L'utilisateur appelle SearchProductssans arguments. Cela renvoie la liste des produits auxquels l'utilisateur a accès, ainsi qu'un « SearchDomain » qui peut être utilisé pour définir les résultats.
-
L'utilisateur continue d'appeler SearchProductsavec des filtres de recherche supplémentaires jusqu'à ce que le produit souhaité soit trouvé.
-
L'utilisateur appelle DescribeProductViewpour trouver la liste des artefacts d'approvisionnement (également appelés versions) pour ce produit. Cela détermine ce que l'utilisateur fournit réellement.
-
L'utilisateur appelle ListLaunchPathspour trouver la liste des chemins de ce produit, ainsi que les contraintes associées à chaque chemin. Cela détermine quel ensemble de contraintes est appliqué au produit approvisionné.
-
Après avoir choisi un artefact d'approvisionnement et un chemin, l'utilisateur appelle. DescribeProvisioningParameters Cela renvoie la liste des paramètres que l'utilisateur doit fournir avant de provisionner un produit à l'aide de l'artefact et du chemin d'approvisionnement, ainsi que les instructions d'utilisation supplémentaires que l'administrateur a décidé de fournir.
-
L'utilisateur appelle ProvisionProduct, spécifiant le produit, l'artefact d'approvisionnement, le chemin et les paramètres d'entrée. Les paramètres d'entrée sont une liste de paires clé-valeur, dans laquelle les clés sont obtenues à l'aide DescribeProvisioningParameterset les valeurs sont fournies par l'utilisateur (par exemple,).
{ParameterKey:"dbpassword", ParameterValue:"mycoolpassword"}Cela lance un flux de travail pour créer les AWS ressources spécifiées. Il crée également un enregistrement détaillé qui suit la demande de provisionnement, ainsi qu'un objet de produit provisionné qui représente les ressources sous-jacentes AWS . -
L'utilisateur interroge DescribeRecordpour savoir quand le statut des détails de l'enregistrement passe de l'
IN_PROGRESSétat à l'état terminé (SUCCEEDEDou nonERROR). -
Lorsque les détails de l'enregistrement de la demande sont terminés, l'utilisateur appelle à DescribeRecordnouveau. Les sorties identifient les ressources créées.
-
L'utilisateur appelle UpdateProvisionedProductpour mettre à jour les ressources sous-jacentes en place. En fonction des mises à jour spécifiques demandées, cette opération peut être mise à jour sans interruption, avec certaines interruptions, ou remplacer entièrement le produit fourni.
-
Enfin, l'utilisateur appelle TerminateProvisionedProductpour mettre fin au produit approvisionné.
