Menu
AWS Service Catalog
Developer Guide

AWS Service Catalog API Overview

The AWS Service Catalog API can be logically divided into the following categories.

Product Discovery

Use these operations to discover or get information about products and what is required to launch them. These operations do not create or modify resources.

SearchProducts

Lists all products to which the caller has access.

DescribeProduct

Get detailed information about a product.

DescribeProductView

Functionally identical to DescribeProduct, except that it takes the ID of a product view instead of the ID of a product.

ListLaunchPaths

Lists all of the ways the user has access to a specified product, referred to as paths to the product. A user must select a path in order to provision the product.

DescribeProvisioningParameters

Gets the parameters needed to provision a specified product, and provides additional metadata about what will happen when the product is provisioned.

Each ProvisioningArtifactParameter is something the user must specify in order to successfully provision the product (for example, the size of an EC2 instance). The ConstraintSummary objects contain the list of allowable values and additional metadata about the ProvisioningArtifactParameter objects.

Provisioning Requests

Use these operations to request, update, or terminate provisioning for a product.

ProvisionProduct

Requests provisioning for a product. To provision a product is to launch the resources needed to bring that product online for actual use. For example, provisioning a product backed by an AWS CloudFormation template means launching an AWS CloudFormation stack and all its underlying resources.

UpdateProvisionedProduct

Updates the configuration of a provisioned product. For example, a product backed by AWS CloudFormation gets its underlying AWS CloudFormation stack updated. The requester must have sufficient access permissions to the specified ProvisionedProduct.

TerminateProvisionedProduct

Requests termination of a provisioned product. For example, for a product backed by AWS CloudFormation, this deletes the underlying AWS CloudFormation stack. The requester must have sufficient access permissions to the specified provisioned product.

Provisioned Products

Use these operations to get information about provisioned products. These operations do not create or modify resources.

ListRecordHistory

Lists all requests performed, even for terminated provisioned products.

DescribeRecord

Gets information about a request. Use this operation after the request operation to obtain current RecordDetail information.

SearchProvisionedProducts

Gets information about the provisioned products that meet specified criteria.

ScanProvisionedProducts

Lists the provisioned products that are not terminated.

DescribeProvisionedProduct

Gets information about a provisioned product.

Provisioned Product Plans

Use these operations to manage your provisioned product plans. A plan includes the list of resources that will be created or modified when the plan is executed.

CreateProvisionedProductPlan

Creates a plan.

DescribeProvisionedProductPlan

Gets information about the resource changes for a plan.

ExecuteProvisionedProductPlan

Provisions or modifies a product based on a plan.

ListProvisionedProductPlans

Lists the plans for a provisioned product.

DeleteProvisionedProductPlan

Deletes a plan.

Portfolios

Intended for the catalog administrator, these operations provide all necessary operations for portfolio management.

CreatePortfolio

Creates a portfolio.

DeletePortfolio

Deletes a portfolio.

DescribePortfolio

Gets detailed information about a portfolio.

ListPortfolios

Lists all portfolios in the catalog.

ListPortfoliosForProduct

Lists all portfolios that a product is associated with.

UpdatePortfolio

Updates a portfolio.

CreatePortfolioShare

Shares a portfolio with an AWS account.

DeletePortfolioShare

Stops sharing a portfolio.

AcceptPortfolioShare

Accepts an offer to share a portfolio.

RejectPortfolioShare

Rejects an offer to share a portfolio.

ListAcceptedPortfolioShares

Lists details of all portfolios for which sharing was accepted by this account.

ListPortfolioAccess

Lists the account IDs that have access to a portfolio.

Principal Association

Intended for the catalog administrator, these operations provide all necessary operations for principal association.

AssociatePrincipalWithPortfolio

Associates a principal ARN with a portfolio.

DisassociatePrincipalFromPortfolio

Disassociates a principal ARN from a portfolio.

ListPrincipalsForPortfolio

Lists all principal ARNs associated with a portfolio.

Products

Intended for the catalog administrator, these operations provide all necessary operations for product management.

SearchProductsAsAdmin

Gets summary and status information for products.

DescribeProductAsAdmin

Gets information about a product.

CreateProduct

Creates a product.

CopyProduct

Copies a product.

DescribeCopyProductStatus

Gets the status of a copy product operation.

UpdateProduct

Updates a product.

DeleteProduct

Deletes a product.

AssociateProductWithPortfolio

Associates a product with a portfolio.

DisassociateProductFromPortfolio

Disassociates a product from a portfolio.

Provisioning Artifacts

Intended for the catalog administrator, these operations manage provisioning artifacts (also known as product versions).

DescribeProvisioningArtifact

Gets information about a provisioning artifact.

CreateProvisioningArtifact

Creates a provisioning artifact for a product.

DeleteProvisioningArtifact

Deletes a provisioning artifact.

ListProvisioningArtifacts

Lists all provisioning artifacts associated with a product.

UpdateProvisioningArtifact

Updates a provisioning artifact.

Constraints

Intended for the catalog administrator, these operations manage constraints.

CreateConstraint

Creates a constraint.

DeleteConstraint

Deletes a constraint.

DescribeConstraint

Gets information about a constraint.

UpdateConstraint

Updates a constraint.

ListConstraintsForPortfolio

Gets constraint information for the a portfolio and product.

TagOptions

Intended for the catalog administrator, these operations manage TagOptions.

CreateTagOption

Creates a TagOption.

ListTagOptions

Lists your TagOptions.

DescribeTagOption

Describes a TagOption.

UpdateTagOption

Updates a TagOption.

AssociateTagOptionWithResource

Associates a TagOption with a resource.

DisassociateTagOptionFromResource

Disassociates a TagOption from a resource.

ListResourcesForTagOption

Lists the resources for a TagOption.

DeleteTagOption

Deletes a TagOption.