View a markdown version of this page

AWS Service Catalog API の概要 - AWS Service Catalog

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

AWS Service Catalog API の概要

Service Catalog API を使用する利点

AWS Service Catalog API は、 を使用する代わりに、すべてのエンドユーザーアクションをプログラムで制御します AWS マネジメントコンソール。API を使用すると、以下を実行できます。

  • 独自のカスタムインターフェイスとアプリケーションを記述する

  • エンドユーザー製品のプロビジョニングオペレーションをきめ細かく制御する

  • リソースプロビジョニングをオーケストレーションパイプラインに統合する

  • リソースを使用してアプリケーションをホストする一元的な場所にアクセスする

Service Catalog にアクセスする

言語固有の APIs を使用してアプリケーションを構築するには、ソフトウェア開発者向けのライブラリ、サンプルコード、チュートリアル、その他のリソースを使用します。これらのライブラリには、リクエストの暗号化署名、リクエストの再試行、エラーレスポンスの処理などのタスクを自動化する基本機能が用意されているので、開発を簡単に始められます。開始するには、Amazon Web Services のツールを開き、 SDK で任意の SDKs

コマンドラインインターフェイスを使用する場合は、以下の選択肢があります。

AWS コマンドラインインターフェイス (CLI)

使用を開始する方法については『AWS Command Line Interface ユーザーガイド』を参照してください。Service Catalog のコマンドの詳細については、「 コマンドリファレンス」の「servicecatalog」を参照してください。 AWS CLI

AWS Tools for Windows PowerShell

使用を開始する方法については『AWS Tools for PowerShell ユーザーガイド』を参照してください。Service Catalog のコマンドレットの詳細については、AWS Tools for PowerShell 「 コマンドレットリファレンス」を開き、 を展開しますAWS Service Catalog

AWS Service Catalog API は次のカテゴリに論理的に分割できます。

製品検出

これらのオペレーションを使用して、 製品とその起動要件に関する情報を検出または取得します。これらのオペレーションは、リソースを作成または変更しません。

SearchProducts

発信者がアクセスできるすべての製品を一覧表示します。

DescribeProduct

製品に関する詳細情報を取得します。

DescribeProductView

機能的に と同じですがDescribeProduct、製品の ID ではなく製品ビューの ID を取得する点が異なります。

ListLaunchPaths

ユーザーが指定された製品にアクセスする方法をすべて一覧表示します。これは、製品へのパスと呼ばれます。製品をプロビジョニングするには、ユーザーはパスを選択する必要があります。

DescribeProvisioningParameters

指定された製品のプロビジョニングに必要なパラメータを取得し、製品のプロビジョニング時に何が起こるかに関する追加のメタデータを提供します。

ProvisioningArtifactParameterは、製品を正常にプロビジョニングするためにユーザーが指定する必要があるものです (EC2 インスタンスのサイズなど)。ConstraintSummary オブジェクトには、許可される値のリストと、ProvisioningArtifactParameterオブジェクトに関する追加のメタデータが含まれます。

プロビジョニングリクエスト

これらのオペレーションを使用して、製品のプロビジョニングをリクエスト、更新、または終了します。

ProvisionProduct

製品のプロビジョニングをリクエストします。製品をプロビジョニングするには、その製品を実際に使用するためにオンラインにするために必要なリソースを起動します。たとえば、 CloudFormation テンプレートでバックアップされた製品をプロビジョニングすると、 CloudFormation スタックとその基盤となるすべてのリソースを起動することになります。

UpdateProvisionedProduct

プロビジョニング済み製品の設定を更新します。例えば、 がサポートする製品 CloudFormation では、基盤となる CloudFormation スタックが更新されます。リクエスタには、指定された ProvisionedProduct への十分なアクセス許可が必要です。

TerminateProvisionedProduct

プロビジョニング済み製品の終了をリクエストします。例えば、 がサポートする製品の場合 CloudFormation、これにより基盤となる CloudFormation スタックが削除されます。リクエスタには、指定されたプロビジョニング済み製品への十分なアクセス許可が必要です。

プロビジョニングされた製品

これらのオペレーションを使用して、プロビジョニングされた製品に関する情報を取得します。これらのオペレーションは、リソースを作成または変更しません。

ListRecordHistory

終了したプロビジョニング済み製品であっても、実行されたすべてのリクエストを一覧表示します。

DescribeRecord

リクエストに関する情報を取得します。リクエストオペレーションの後にこのオペレーションを使用して、現在のRecordDetail情報を取得します。

SearchProvisionedProducts

指定された基準を満たすプロビジョニング済み製品に関する情報を取得します。

ScanProvisionedProducts

終了されていないプロビジョニング済み製品を一覧表示します。

DescribeProvisionedProduct

プロビジョニングされた製品に関する情報を取得します。

ImportAsProvisionedProduct

Service Catalog 製品とプロビジョニングアーティファクトに関連付けられている Service Catalog プロビジョニング済み製品としてのリソースのインポートをリクエストします。インポートされると、サポートされているすべての Service Catalog ガバナンスアクションがプロビジョニング済み製品でサポートされます。

UpdateProvisionedProductProperties

指定されたプロビジョニング済み製品のプロパティの更新をリクエストします。

プロビジョニング済み製品プラン

これらのオペレーションを使用して、プロビジョニングされた製品プランを管理します。プランには、プランの実行時に作成または変更するリソースのリストが含まれます。

CreateProvisionedProductPlan

プランを作成します。

DescribeProvisionedProductPlan

プランのリソース変更に関する情報を取得します。

ExecuteProvisionedProductPlan

プランに基づいて製品をプロビジョニングまたは変更します。

ListProvisionedProductPlans

プロビジョニング済み製品のプランを一覧表示します。

DeleteProvisionedProductPlan

プランを削除します。

ポートフォリオ

カタログ管理者は、これらのオペレーションを使用して、ポートフォリオ管理に必要なすべてのオペレーションを提供します。

CreatePortfolio

ポートフォリオを作成します。

DeletePortfolio

ポートフォリオを削除します。

DescribePortfolio

ポートフォリオに関する詳細情報を取得します。

DescribePortfolioShares

指定されたポートフォリオ用に作成された各ポートフォリオ共有の概要を返します。

ListPortfolios

カタログ内のすべてのポートフォリオを一覧表示します。

ListPortfoliosForProduct

製品が関連付けられているすべてのポートフォリオを一覧表示します。

UpdatePortfolio

ポートフォリオを更新します。

UpdatePortfolioShare

ポートフォリオ共有を更新します。

CreatePortfolioShare

ポートフォリオを AWS アカウントと共有します。

DeletePortfolioShare

ポートフォリオの共有を停止します。

AcceptPortfolioShare

ポートフォリオを共有するオファーを受け入れます。

RejectPortfolioShare

ポートフォリオを共有するオファーを拒否します。

ListAcceptedPortfolioShares

このアカウントが共有を承諾したすべてのポートフォリオの詳細を一覧表示します。

ListPortfolioAccess

ポートフォリオにアクセスできるアカウント IDs を一覧表示します。

プリンシパルの関連付け

カタログ管理者は、これらのオペレーションを使用して、プリンシパルの関連付けに必要なすべてのオペレーションを提供します。

AssociatePrincipalWithPortfolio

プリンシパル ARN をポートフォリオに関連付けます。

DisassociatePrincipalFromPortfolio

ポートフォリオからプリンシパル ARN の関連付けを解除します。

ListPrincipalsForPortfolio

ポートフォリオに関連付けられているすべてのプリンシパル ARNs を一覧表示します。

製品

カタログ管理者は、これらのオペレーションを使用して、製品管理に必要なすべてのオペレーションを提供します。

SearchProductsAsAdmin

製品の概要とステータス情報を取得します。

DescribeProductAsAdmin

製品に関する情報を取得します。

CreateProduct

製品を作成します。

CopyProduct

製品をコピーします。

DescribeCopyProductStatus

コピー製品オペレーションのステータスを取得します。

UpdateProduct

製品を更新します。

DeleteProduct

製品を削除します。

AssociateProductWithPortfolio

製品をポートフォリオに関連付けます。

DisassociateProductFromPortfolio

ポートフォリオから製品の関連付けを解除します。

アーティファクトのプロビジョニング

カタログ管理者は、これらのオペレーションを使用してプロビジョニングアーティファクト (製品バージョンとも呼ばれます) を管理します。

DescribeProvisioningArtifact

プロビジョニングアーティファクトに関する情報を取得します。

CreateProvisioningArtifact

製品のプロビジョニングアーティファクトを作成します。

DeleteProvisioningArtifact

プロビジョニングアーティファクトを削除します。

ListProvisioningArtifacts

製品に関連付けられているすべてのプロビジョニングアーティファクトを一覧表示します。

UpdateProvisioningArtifact

プロビジョニングアーティファクトを更新します。

制約

カタログ管理者は、これらのオペレーションを使用して制約を管理します。

CreateConstraint

制約を作成します。

DeleteConstraint

制約を削除します。

DescribeConstraint

制約に関する情報を取得します。

UpdateConstraint

制約を更新します。

ListConstraintsForPortfolio

ポートフォリオと製品の制約情報を取得します。

サービスアクション

カタログ管理者は、これらのオペレーションを使用してサービスアクションを管理します。

AssociateServiceActionWithProvisioningArtifact

セルフサービスアクションをプロビジョニングアーティファクトに関連付けます。

CreateServiceAction

セルフサービスアクションを作成します。

DeleteServiceAction

セルフサービスアクションを削除します。

DescribeServiceAction

セルフサービスアクションについて説明します。

DescribeServiceActionExecutionParameters

特定のプロビジョニング済み製品に対する特定のセルフサービスアクションのデフォルトパラメータを検索し、結果のマップをユーザーに返します。

ExecuteProvisionedProductServiceAction

プロビジョニングされた製品に対してセルフサービスアクションを実行します。

UpdateServiceAction

セルフサービスアクションを更新します。

TagOptions

カタログ管理者は、これらのオペレーションを使用して TagOptions を管理します。

CreateTagOption

TagOption を作成します。

ListTagOptions

TagOptions を一覧表示します。

DescribeTagOption

TagOption について説明します。

UpdateTagOption

TagOption を更新します。

AssociateTagOptionWithResource

TagOption をリソースに関連付けます。

DisassociateTagOptionFromResource

リソースから TagOption の関連付けを解除します。

ListResourcesForTagOption

TagOption のリソースを一覧表示します。

DeleteTagOption

TagOption を削除します。

AppRegistry

アプリケーション、そのリソース、およびエンタープライズで使用するアプリケーションメタデータのリポジトリとして機能します。

AssociateAttributeGroup

属性グループをアプリケーションに関連付けて、アプリケーションのメタデータをグループの属性で補強します。

AssociateResource

リソースをアプリケーションに関連付けます。

CreateApplication

関連するクラウドリソースの抽象化階層の最上位ノードである新しいアプリケーションを作成します。

CreateAttributeGroup

ユーザー定義属性のコンテナとして新しい属性グループを作成します。

DeleteApplication

アプリケーション ID または名前で指定されたアプリケーションを削除します。

DeleteAttributeGroup

属性グループ ID または名前で指定された属性グループを削除します。

DisassociateAttributeGroup

アプリケーションから属性グループの関連付けを解除して、その属性グループに含まれる追加の属性をアプリケーションのメタデータから削除します。

DisassociateResource

アプリケーションからリソースの関連付けを解除します。

GetApplication

アプリケーションの 1 つに関するメタデータ情報を取得します。

GetAssociatedResource

アプリケーションに関連付けられたリソースを取得します。

GetAttributeGroup

属性グループを名前または ID で取得します。

ListApplications

指定されたアプリケーションに関連付けられているすべての属性グループを一覧表示します。

ListAssociatedAttributeGroups

指定されたアプリケーションに関連付けられているすべての属性グループを一覧表示します。

ListAssociatedResources

指定されたアプリケーションに関連付けられているすべてのリソースを一覧表示します。

ListAttributeGroups

アクセス可能なすべての属性グループを一覧表示します。

ListAttributeGroupsForApplication

特定のアプリケーションに関連付けられているすべての属性グループの詳細を一覧表示します。

ListTagsForResource

リソースのすべてのタグを一覧表示します。

TagResource

指定されたリソースに 1 つ以上のタグ (キーと値のペア) を割り当てます。

SyncResource

リソースを AppRegistry に現在記録されているものと同期します。

UntagResource

リソースからタグを削除します。

UpdateApplication

既存のアプリケーションを新しい属性で更新します。

UpdateAttributeGroup

既存の属性グループを新しい詳細で更新します。

ワークフローの例

このシナリオでは、管理者は を使用してリソースを作成し AWS Service Catalog 、エンドユーザーは利用可能な製品を見つけて製品をプロビジョニングします。これはワークフローの例です。 AWS Service Catalog API を使用する唯一の方法ではありません。

管理者タスク
  • ポートフォリオ、製品ビュー、製品、製品バージョン、制約を作成します。

  • IAM ユーザーを製品に割り当て、アクセス権を付与します。

エンドユーザータスク
  1. ユーザーは引数なしで SearchProducts を呼び出します。これにより、ユーザーがアクセスできる製品のリストと、結果の範囲設定に使用できる「SearchDomain」が返されます。

  2. ユーザーは、目的の製品が見つかるまで、追加の検索フィルターを使用して SearchProducts を呼び出し続けます。

  3. ユーザーは DescribeProductView を呼び出して、この製品のプロビジョニングアーティファクト (バージョンとも呼ばれます) のリストを見つけます。これにより、ユーザーが実際にプロビジョニングする内容が決まります。

  4. ユーザーは ListLaunchPaths を呼び出して、この製品のパスのリストと各パスの制約を見つけます。これにより、プロビジョニングされた製品に適用される制約のセットが決まります。

  5. プロビジョニングアーティファクトとパスを選択すると、ユーザーは DescribeProvisioningParameters を呼び出します。これにより、プロビジョニングアーティファクトとパスを使用して製品をプロビジョニングする前にユーザーが提供する必要があるパラメータのリストと、管理者が提供することを決定した追加の使用手順が返されます。

  6. ユーザーは ProvisionProduct を呼び出し、製品、プロビジョニングアーティファクト、パス、入力パラメータを指定します。入力パラメータはキーと値のペアのリストであり、キーは DescribeProvisioningParameters を使用して取得され、値はユーザーが指定します (例: {ParameterKey:"dbpassword", ParameterValue:"mycoolpassword"})。これにより、指定された AWS リソースを作成するワークフローが開始されます。また、プロビジョニングリクエストを追跡するレコードの詳細と、基盤となる AWS リソースを表すプロビジョニング済み製品オブジェクトも作成します。

  7. ユーザーは DescribeRecord をポーリングして、レコードの詳細のステータスが IN_PROGRESS状態から完了状態 ( SUCCEEDEDまたは ) にいつ変化するかを確認しますERROR

  8. リクエストのレコード詳細が完了状態になると、ユーザーは DescribeRecord をもう一度呼び出します。出力は、作成されたリソースを識別します。

  9. ユーザーは UpdateProvisionedProduct を呼び出して、基盤となるリソースを更新します。リクエストされた特定の更新に応じて、このオペレーションは中断なしで更新したり、中断したり、プロビジョニングされた製品を完全に置き換えたりすることができます。

  10. 最後に、ユーザーは TerminateProvisionedProduct を呼び出して、プロビジョニングされた製品を終了します。