Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.
AWS Service Catalog Überblick über die API
Vorteile der Verwendung der Service Catalog API
Die AWS Service Catalog API bietet programmgesteuerte Kontrolle über alle Endbenutzeraktionen als Alternative zur Verwendung von. AWS-Managementkonsole Wenn Sie die API verwenden, können Sie Folgendes tun:
-
Schreiben Sie Ihre eigenen benutzerdefinierten Benutzeroberflächen und Apps
-
Verschaffen Sie sich eine detaillierte Kontrolle über die Bereitstellung von Produkten für Endbenutzer
-
Integrieren Sie die Ressourcenbereitstellung in Ihre Orchestrierungspipelines
-
Greifen Sie auf einen zentralen Ort zu, an dem Ihre Anwendungen mit ihren Ressourcen gehostet werden
Auf den Service Catalog zugreifen
Verwenden Sie die Bibliotheken, den Beispielcode, die Tutorials und andere Ressourcen für Softwareentwickler, um Anwendungen mithilfe sprachspezifischer APIs zu erstellen. Diese Bibliotheken bieten grundlegende Funktionen zur Automatisierung von Aufgaben, z. B. kryptografisches Signieren von Anfragen, Wiederholen von Anfragen und Behandlung von Fehlermeldungen. Dadurch wird Ihnen der Einstieg erleichtert. Öffnen Sie zunächst die Tools für Amazon Web Services
Falls Sie es bevorzugen, eine Kommandozeilenschnittstelle zu verwenden, haben Sie die folgenden Möglichkeiten:
- AWS Befehlszeilenschnittstelle (CLI)
-
Informationen zu den ersten Schritten finden Sie im AWS Command Line Interface -Benutzerhandbuch. Weitere Informationen zu den Befehlen für Service Catalog finden Sie unter servicecatalog in der AWS CLI Befehlsreferenz.
- AWS Tools für Windows PowerShell
-
Informationen zu den ersten Schritten finden Sie im AWS -Tools für PowerShell -Benutzerhandbuch. Weitere Informationen zu den Cmdlets für Service Catalog erhalten Sie, indem Sie die AWS -Tools für PowerShell Cmdlet-Referenz öffnen und erweitern. AWS Service Catalog
Die AWS Service Catalog API kann logisch in die folgenden Kategorien unterteilt werden.
Themen
Entdeckung von Produkten
Verwenden Sie diese Funktionen, um Produkte und deren Markteinführungsanforderungen zu finden oder Informationen darüber zu erhalten. Bei diesen Vorgängen werden keine Ressourcen erstellt oder geändert.
- SearchProducts
-
Listet alle Produkte auf, auf die der Anrufer Zugriff hat.
- DescribeProduct
-
Erhalten Sie detaillierte Informationen zu einem Produkt.
- DescribeProductView
-
Funktionell identisch mit
DescribeProduct, außer dass anstelle der ID eines Produkts die ID einer Produktansicht verwendet wird. - ListLaunchPaths
-
Listet alle Möglichkeiten auf, wie der Benutzer auf ein bestimmtes Produkt zugreifen kann, die als Pfade zum Produkt bezeichnet werden. Ein Benutzer muss einen Pfad auswählen, um das Produkt bereitzustellen.
- DescribeProvisioningParameters
-
Ruft die Parameter ab, die für die Bereitstellung eines bestimmten Produkts erforderlich sind, und stellt zusätzliche Metadaten darüber bereit, was passiert, wenn das Produkt bereitgestellt wird.
Jedes
ProvisioningArtifactParameterdavon muss der Benutzer angeben, um das Produkt erfolgreich bereitstellen zu können (z. B. die Größe einer EC2-Instance). DieConstraintSummaryObjekte enthalten die Liste der zulässigen Werte und zusätzliche Metadaten zu denProvisioningArtifactParameterObjekten.
Bereitstellungsanfragen
Verwenden Sie diese Vorgänge, um die Bereitstellung für ein Produkt anzufordern, zu aktualisieren oder zu beenden.
- ProvisionProduct
-
Fordert die Bereitstellung für ein Produkt an. Die Bereitstellung eines Produkts bedeutet, die Ressourcen bereitzustellen, die erforderlich sind, um das Produkt für den tatsächlichen Gebrauch online zu stellen. Die Bereitstellung eines Produkts, das von einer CloudFormation Vorlage unterstützt wird, bedeutet beispielsweise, einen CloudFormation Stack und all seine zugrunde liegenden Ressourcen auf den Markt zu bringen.
- UpdateProvisionedProduct
-
Aktualisiert die Konfiguration eines bereitgestellten Produkts. Beispielsweise wird bei einem Produkt, das von unterstützt CloudFormation wird, der zugrunde liegende CloudFormation Stack aktualisiert. Der Anforderer muss über ausreichende Zugriffsberechtigungen für die angegebenen ProvisionedProduct Daten verfügen.
- TerminateProvisionedProduct
-
Fordert die Kündigung eines bereitgestellten Produkts an. Bei einem Produkt, das von unterstützt wird CloudFormation, wird dadurch beispielsweise der zugrunde liegende CloudFormation Stack gelöscht. Der Anforderer muss über ausreichende Zugriffsberechtigungen für das angegebene bereitgestellte Produkt verfügen.
Bereitgestellte Produkte
Verwenden Sie diese Operationen, um Informationen über bereitgestellte Produkte abzurufen. Bei diesen Vorgängen werden keine Ressourcen erstellt oder geändert.
- ListRecordHistory
-
Listet alle ausgeführten Anfragen auf, auch für beendete bereitgestellte Produkte.
- DescribeRecord
-
Ruft Informationen zu einer Anfrage ab. Verwenden Sie diesen Vorgang nach dem Anforderungsvorgang, um aktuelle
RecordDetailInformationen abzurufen. - SearchProvisionedProducts
-
Ruft Informationen zu den bereitgestellten Produkten ab, die die angegebenen Kriterien erfüllen.
- ScanProvisionedProducts
-
Listet die bereitgestellten Produkte auf, die nicht beendet wurden.
- DescribeProvisionedProduct
-
Ruft Informationen über ein bereitgestelltes Produkt ab.
- ImportAsProvisionedProduct
-
Fordert den Import einer Ressource als von Service Catalog bereitgestelltes Produkt an, das einem Service Catalog-Produkt und einem Bereitstellungsartefakt zugeordnet ist. Nach dem Import werden alle unterstützten Service Catalog-Governance-Aktionen auf dem bereitgestellten Produkt unterstützt.
- UpdateProvisionedProductProperties
-
Fordert Aktualisierungen der Eigenschaften des angegebenen bereitgestellten Produkts an.
Pläne für bereitgestellte Produkte
Verwenden Sie diese Vorgänge, um Ihre bereitgestellten Produktpläne zu verwalten. Ein Plan umfasst die Liste der Ressourcen, die bei der Ausführung des Plans erstellt oder geändert werden müssen.
- CreateProvisionedProductPlan
Erstellt einen Plan.
- DescribeProvisionedProductPlan
Ruft Informationen zu den Ressourcenänderungen für einen Plan ab.
- ExecuteProvisionedProductPlan
Stellt ein Produkt auf der Grundlage eines Plans bereit oder ändert es.
- ListProvisionedProductPlans
Listet die Pläne für ein bereitgestelltes Produkt auf.
- DeleteProvisionedProductPlan
Löscht einen Plan.
Portfolios
Katalogadministratoren verwenden diese Operationen, um alle erforderlichen Operationen für das Portfoliomanagement bereitzustellen.
- CreatePortfolio
Erstellt ein Portfolio.
- DeletePortfolio
Löscht ein Portfolio.
- DescribePortfolio
Ruft detaillierte Informationen über ein Portfolio ab.
- DescribePortfolioShares
Gibt eine Zusammenfassung aller Portfolioaktien zurück, die für das angegebene Portfolio erstellt wurden.
- ListPortfolios
Listet alle Portfolios im Katalog auf.
- ListPortfoliosForProduct
Listet alle Portfolios auf, denen ein Produkt zugeordnet ist.
- UpdatePortfolio
Aktualisiert ein Portfolio.
- UpdatePortfolioShare
Aktualisiert eine Portfolioaktie.
- CreatePortfolioShare
Teilt ein Portfolio mit einem AWS Konto.
- DeletePortfolioShare
Beendet die gemeinsame Nutzung eines Portfolios.
- AcceptPortfolioShare
Nimmt ein Angebot zur gemeinsamen Nutzung eines Portfolios an.
- RejectPortfolioShare
Lehnt ein Angebot zur gemeinsamen Nutzung eines Portfolios ab.
- ListAcceptedPortfolioShares
Listet Details aller Portfolios auf, für die das Teilen von diesem Konto akzeptiert wurde.
- ListPortfolioAccess
Listet die Konto-IDs auf, die Zugriff auf ein Portfolio haben.
Hauptverband
Katalogadministratoren verwenden diese Operationen, um alle für die Hauptzuweisung erforderlichen Operationen bereitzustellen.
- AssociatePrincipalWithPortfolio
Ordnet einem Portfolio einen Haupt-ARN zu.
- DisassociatePrincipalFromPortfolio
Trennt einen Haupt-ARN von einem Portfolio.
- ListPrincipalsForPortfolio
Listet alle Haupt-ARNs auf, die einem Portfolio zugeordnet sind.
Produkte
Katalogadministratoren verwenden diese Operationen, um alle für das Produktmanagement erforderlichen Operationen bereitzustellen.
- SearchProductsAsAdmin
Ruft Zusammenfassungs- und Statusinformationen für Produkte ab.
- DescribeProductAsAdmin
Ruft Informationen zu einem Produkt ab.
- CreateProduct
Erzeugt ein Produkt.
- CopyProduct
Kopiert ein Produkt.
- DescribeCopyProductStatus
Ruft den Status eines Vorgangs zum Kopieren eines Produkts ab.
- UpdateProduct
Aktualisiert ein Produkt.
- DeleteProduct
Löscht ein Produkt.
- AssociateProductWithPortfolio
Ordnet ein Produkt einem Portfolio zu.
- DisassociateProductFromPortfolio
Trennt ein Produkt von einem Portfolio.
Bereitstellung von Artefakten
Katalogadministratoren verwenden diese Operationen, um Bereitstellungsartefakte (auch als Produktversionen bezeichnet) zu verwalten.
- DescribeProvisioningArtifact
Ruft Informationen über ein Bereitstellungsartefakt ab.
- CreateProvisioningArtifact
Erstellt ein Bereitstellungsartefakt für ein Produkt.
- DeleteProvisioningArtifact
Löscht ein Bereitstellungsartefakt.
- ListProvisioningArtifacts
Listet alle Bereitstellungsartefakte auf, die einem Produkt zugeordnet sind.
- UpdateProvisioningArtifact
Aktualisiert ein Bereitstellungsartefakt.
Beschränkungen
Der Katalogadministrator verwendet diese Operationen zur Verwaltung von Einschränkungen.
- CreateConstraint
Erzeugt eine Einschränkung.
- DeleteConstraint
Löscht eine Einschränkung.
- DescribeConstraint
Ruft Informationen über eine Einschränkung ab.
- UpdateConstraint
Aktualisiert eine Einschränkung.
- ListConstraintsForPortfolio
Ruft Einschränkungsinformationen für ein Portfolio und ein Produkt ab.
Dienstaktionen
Katalogadministratoren verwenden diese Operationen, um Serviceaktionen zu verwalten.
- AssociateServiceActionWithProvisioningArtifact
Ordnet eine Self-Service-Aktion einem Bereitstellungsartefakt zu.
- CreateServiceAction
Erstellt eine Self-Service-Aktion.
- DeleteServiceAction
Löscht eine Self-Service-Aktion.
- DescribeServiceAction
Beschreibt eine Self-Service-Aktion.
- DescribeServiceActionExecutionParameters
Findet die Standardparameter für eine bestimmte Self-Service-Aktion für ein bestimmtes bereitgestelltes Produkt und gibt dem Benutzer eine Übersicht der Ergebnisse zurück.
- ExecuteProvisionedProductServiceAction
Führt eine Self-Service-Aktion für ein bereitgestelltes Produkt aus.
- UpdateServiceAction
Aktualisiert eine Self-Service-Aktion.
TagOptions
Katalogadministratoren verwenden diese Operationen zur Verwaltung. TagOptions
- CreateTagOption
Erzeugt eine TagOption.
- ListTagOptions
Listet deine auf TagOptions.
- DescribeTagOption
Beschreibt ein TagOption.
- UpdateTagOption
Aktualisiert TagOption a.
- AssociateTagOptionWithResource
Ordnet a TagOption einer Ressource zu.
- DisassociateTagOptionFromResource
Trennt a TagOption von einer Ressource.
- ListResourcesForTagOption
Listet die Ressourcen für a TagOption auf.
- DeleteTagOption
Löscht ein TagOption.
AppRegistry
Dient als Repository für Ihre Anwendungen, deren Ressourcen und die Anwendungsmetadaten, die Sie in Ihrem Unternehmen verwenden.
- AssociateAttributeGroup
Ordnet einer Anwendung eine Attributgruppe zu, um die Metadaten der Anwendung um die Attribute der Gruppe zu erweitern.
- AssociateResource
Ordnet einer Anwendung eine Ressource zu.
- CreateApplication
Erstellt eine neue Anwendung, die den Knoten der obersten Ebene in einer Hierarchie verwandter Cloud-Ressourcenabstraktionen darstellt.
- CreateAttributeGroup
Erstellt eine neue Attributgruppe als Container für benutzerdefinierte Attribute.
- DeleteApplication
Löscht eine Anwendung, die entweder durch ihre Anwendungs-ID oder ihren Namen angegeben ist.
- DeleteAttributeGroup
Löscht eine Attributgruppe, die entweder durch ihre Attributgruppen-ID oder ihren Namen angegeben wird.
- DisassociateAttributeGroup
Trennt die Zuordnung einer Attributgruppe zu einer Anwendung, um die zusätzlichen Attribute, die in der Attributgruppe enthalten sind, aus den Metadaten der Anwendung zu entfernen.
- DisassociateResource
Trennt die Zuordnung einer Ressource zur Anwendung.
- GetApplication
Ruft Metadateninformationen zu einer Ihrer Anwendungen ab.
- GetAssociatedResource
Ruft die der Anwendung zugeordnete Ressource ab.
- GetAttributeGroup
Ruft eine Attributgruppe ab, entweder anhand ihres Namens oder ihrer ID.
- ListApplications
Listet alle Attributgruppen auf, die der angegebenen Anwendung zugeordnet sind.
- ListAssociatedAttributeGroups
Listet alle Attributgruppen auf, die der angegebenen Anwendung zugeordnet sind.
- ListAssociatedResources
Listet alle Ressourcen auf, die der angegebenen Anwendung zugeordnet sind.
- ListAttributeGroups
Führt alle Attributgruppen auf, auf die Sie Zugriff haben.
- ListAttributeGroupsForApplication
Listet die Details aller Attributgruppen auf, die einer bestimmten Anwendung zugeordnet sind.
- ListTagsForResource
Listet alle Tags der Ressource auf.
- TagResource
Weist der angegebenen Ressource ein oder mehrere Tags (Schlüssel-Wert-Paare) zu.
- SyncResource
Synchronisiert die Ressource mit dem, was aktuell aufgezeichnet ist. AppRegistry
- UntagResource
Entfernt Tags aus einer Ressource.
- UpdateApplication
Aktualisiert eine bestehende Anwendung mit neuen Attributen.
- UpdateAttributeGroup
Aktualisiert eine bestehende Attributgruppe mit neuen Details.
Beispiel für einen Arbeitsablauf
In diesem Szenario erstellt der Administrator Ressourcen mithilfe von AWS Service Catalog und ein Endbenutzer findet heraus, welche Produkte verfügbar sind, und stellt das Produkt bereit. Dies ist ein Beispiel-Workflow. Dies ist nicht die einzige Möglichkeit, die AWS Service Catalog API zu verwenden.
Aufgaben des Administrators
Erstellen Sie Portfolios, Produktansichten, Produkte, Produktversionen und Einschränkungen.
Weisen Sie IAM-Benutzern Produkten zu, sodass sie darauf zugreifen können.
Aufgaben von Endbenutzern
-
Der Benutzer ruft SearchProductsohne Argumente an. Dadurch wird die Liste der Produkte zurückgegeben, auf die der Benutzer Zugriff hat, sowie ein "SearchDomain", das verwendet werden kann, um die Ergebnisse einzugrenzen.
-
Der Benutzer ruft weiterhin SearchProductsmit zusätzlichen Suchfiltern an, bis das gewünschte Produkt gefunden wurde.
-
Der Benutzer ruft DescribeProductViewan, um die Liste der Bereitstellungsartefakte (auch als Versionen bezeichnet) für dieses Produkt zu finden. Dadurch wird bestimmt, was der Benutzer tatsächlich bereitstellt.
-
Der Benutzer ruft ListLaunchPathsan, um die Liste der Pfade für dieses Produkt zusammen mit den Einschränkungen für jeden Pfad zu finden. Dadurch wird bestimmt, welche Einschränkungen auf das bereitgestellte Produkt angewendet werden.
-
Nachdem der Benutzer ein Bereitstellungsartefakt und einen Pfad ausgewählt hat, ruft er an. DescribeProvisioningParameters Dadurch wird die Liste der Parameter zurückgegeben, die der Benutzer vor der Bereitstellung eines Produkts mithilfe des Bereitstellungsartefakts und des Bereitstellungspfads angeben muss, zusammen mit allen zusätzlichen Nutzungsanweisungen, die der Administrator angegeben hat.
-
Der Benutzer ruft auf und gibt dabei das Produkt ProvisionProduct, das Bereitstellungsartefakt, den Pfad und die Eingabeparameter an. Bei den Eingabeparametern handelt es sich um eine Liste von Schlüssel-Wert-Paaren, wobei die Schlüssel abgerufen DescribeProvisioningParametersund die Werte vom Benutzer bereitgestellt werden (z. B.).
{ParameterKey:"dbpassword", ParameterValue:"mycoolpassword"}Dadurch wird ein Workflow zum Erstellen der angegebenen Ressourcen gestartet. AWS Außerdem wird ein Datensatzdetail erstellt, das die Bereitstellungsanforderung verfolgt, und ein bereitgestelltes Produktobjekt, das die zugrunde liegenden AWS Ressourcen darstellt. -
Der Benutzer fragt ab, wann DescribeRecordsich der Status der Datensatzdetails vom Status in den
IN_PROGRESSStatus „Abgeschlossen“ ändert (entweder oderSUCCEEDED).ERROR -
Wenn sich die Datensatzdetails für die Anfrage im Status „Abgeschlossen“ befinden, ruft der Benutzer DescribeRecorderneut an. Die Ausgaben identifizieren die erstellten Ressourcen.
-
Der Benutzer ruft UpdateProvisionedProductan, um die vorhandenen zugrunde liegenden Ressourcen zu aktualisieren. Abhängig von den angeforderten spezifischen Updates kann dieser Vorgang ohne Unterbrechung oder mit einigen Unterbrechungen aktualisiert werden oder das bereitgestellte Produkt vollständig ersetzen.
-
Schließlich ruft der Benutzer an, TerminateProvisionedProductum das bereitgestellte Produkt zu beenden.