AWS Fundamentals Logo
AWS Fundamentals
aws servicecatalog

AWS AWS Service Catalog CLI Commands

90 CLI commands available for AWS Service Catalog.

CommandSample
accept-portfolio-share

Accepts an offer to share the specified portfolio.

associate-budget-with-resource

Associates the specified budget with the specified resource.

associate-principal-with-portfolio

Associates the specified principal ARN with the specified portfolio. If you share the portfolio with principal name sharing enabled, the PrincipalARN association is included in the share. The PortfolioID, PrincipalARN, and PrincipalType parameters are required. You can associate a maximum of 10 Pr

associate-product-with-portfolio

Associates the specified product with the specified portfolio. A delegated admin is authorized to invoke this command.

associate-service-action-with-provisioning-artifact

Associates a self-service action with a provisioning artifact.

associate-tag-option-with-resource

Associate the specified TagOption with the specified portfolio or product.

batch-associate-service-action-with-provisioning-artifact

Associates multiple self-service actions with provisioning artifacts.

batch-disassociate-service-action-from-provisioning-artifact

Disassociates a batch of self-service actions from the specified provisioning artifact.

copy-product

Copies the specified source product to the specified target product or a new product. You can copy a product to the same account or another account. You can copy a product to the same Region or another Region. If you copy a product to another account, you must first share the product in a portfolio

create-constraint

Creates a constraint. A delegated admin is authorized to invoke this command.

create-portfolio

Creates a portfolio. A delegated admin is authorized to invoke this command.

create-portfolio-share

Shares the specified portfolio with the specified account or organization node. Shares to an organization node can only be created by the management account of an organization or by a delegated administrator. You can share portfolios to an organization, an organizational unit, or a specific account.

create-product

Creates a product. A delegated admin is authorized to invoke this command. The user or role that performs this operation must have the cloudformation:GetTemplate IAM policy permission. This policy permission is required when using the ImportFromPhysicalId template source in the information data sect

create-provisioned-product-plan

Creates a plan. A plan includes the list of resources to be created (when provisioning a new product) or modified (when updating a provisioned product) when the plan is executed. You can create one plan for each provisioned product. To create a plan for an existing provisioned product, the product s

create-provisioning-artifact

Creates a provisioning artifact (also known as a version) for the specified product. You cannot create a provisioning artifact for a product that was shared with you. The user or role that performs this operation must have the cloudformation:GetTemplate IAM policy permission. This policy permission

create-service-action

Creates a self-service action.

create-tag-option

Creates a TagOption.

delete-constraint

Deletes the specified constraint. A delegated admin is authorized to invoke this command.

delete-portfolio

Deletes the specified portfolio. You cannot delete a portfolio if it was shared with you or if it has associated products, users, constraints, or shared accounts. A delegated admin is authorized to invoke this command.

delete-portfolio-share

Stops sharing the specified portfolio with the specified account or organization node. Shares to an organization node can only be deleted by the management account of an organization or by a delegated administrator. Note that if a delegated admin is de-registered, portfolio shares created from that

delete-product

Deletes the specified product. You cannot delete a product if it was shared with you or is associated with a portfolio. A delegated admin is authorized to invoke this command.

delete-provisioned-product-plan

Deletes the specified plan.

delete-provisioning-artifact

Deletes the specified provisioning artifact (also known as a version) for the specified product. You cannot delete a provisioning artifact associated with a product that was shared with you. You cannot delete the last provisioning artifact for a product, because a product must have at least one prov

delete-service-action

Deletes a self-service action.

delete-tag-option

Deletes the specified TagOption. You cannot delete a TagOption if it is associated with a product or portfolio.

describe-constraint

Gets information about the specified constraint.

describe-copy-product-status

Gets the status of the specified copy product operation.

describe-portfolio

Gets information about the specified portfolio. A delegated admin is authorized to invoke this command.

describe-portfolio-share-status

Gets the status of the specified portfolio share operation. This API can only be called by the management account in the organization or by a delegated admin.

describe-portfolio-shares

Returns a summary of each of the portfolio shares that were created for the specified portfolio. You can use this API to determine which accounts or organizational nodes this portfolio have been shared, whether the recipient entity has imported the share, and whether TagOptions are included with the

describe-product

Gets information about the specified product. Running this operation with administrator access results in a failure. DescribeProductAsAdmin should be used instead.

describe-product-as-admin

Gets information about the specified product. This operation is run with administrator access.

describe-product-view

Gets information about the specified product.

describe-provisioned-product

Gets information about the specified provisioned product.

describe-provisioned-product-plan

Gets information about the resource changes for the specified plan.

describe-provisioning-artifact

Gets information about the specified provisioning artifact (also known as a version) for the specified product.

describe-provisioning-parameters

Gets information about the configuration required to provision the specified product using the specified provisioning artifact. If the output contains a TagOption key with an empty list of values, there is a TagOption conflict for that key. The end user cannot take action to fix the conflict, and la

describe-record

Gets information about the specified request operation. Use this operation after calling a request operation (for example, ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct). If a provisioned product was transferred to a new owner using UpdateProvisionedProductProperties,

describe-service-action

Describes a self-service action.

describe-service-action-execution-parameters

Finds the default parameters for a specific self-service action on a specific provisioned product and returns a map of the results to the user.

describe-tag-option

Gets information about the specified TagOption.

disable-aws-organizations-access

Disable portfolio sharing through the Organizations service. This command will not delete your current shares, but prevents you from creating new shares throughout your organization. Current shares are not kept in sync with your organization structure if the structure changes after calling this API.

disassociate-budget-from-resource

Disassociates the specified budget from the specified resource.

disassociate-principal-from-portfolio

Disassociates a previously associated principal ARN from a specified portfolio. The PrincipalType and PrincipalARN must match the AssociatePrincipalWithPortfolio call request details. For example, to disassociate an association created with a PrincipalARN of PrincipalType IAM you must use the Princi

disassociate-product-from-portfolio

Disassociates the specified product from the specified portfolio. A delegated admin is authorized to invoke this command.

disassociate-service-action-from-provisioning-artifact

Disassociates the specified self-service action association from the specified provisioning artifact.

disassociate-tag-option-from-resource

Disassociates the specified TagOption from the specified resource.

enable-aws-organizations-access

Enable portfolio sharing feature through Organizations. This API will allow Service Catalog to receive updates on your organization in order to sync your shares with the current structure. This API can only be called by the management account in the organization. When you call this API, Service Cata

execute-provisioned-product-plan

Provisions or modifies a product based on the resource changes for the specified plan.

execute-provisioned-product-service-action

Executes a self-service action against a provisioned product.

get-aws-organizations-access-status

Get the Access Status for Organizations portfolio share feature. This API can only be called by the management account in the organization or by a delegated admin.

get-provisioned-product-outputs

This API takes either a ProvisonedProductId or a ProvisionedProductName, along with a list of one or more output keys, and responds with the key/value pairs of those outputs.

import-as-provisioned-product

Requests the import of a resource as an Service Catalog provisioned product that is associated to an Service Catalog product and provisioning artifact. Once imported, all supported governance actions are supported on the provisioned product. Resource import only supports CloudFormation stack ARNs

list-accepted-portfolio-shares

Lists all imported portfolios for which account-to-account shares were accepted by this account. By specifying the PortfolioShareType, you can list portfolios for which organizational shares were accepted by this account.

list-budgets-for-resource

Lists all the budgets associated to the specified resource.

list-constraints-for-portfolio

Lists the constraints for the specified portfolio and product.

list-launch-paths

Lists the paths to the specified product. A path describes how the user gets access to a specified product and is necessary when provisioning a product. A path also determines the constraints that are put on a product. A path is dependent on a specific product, porfolio, and principal. When prov

list-organization-portfolio-access

Lists the organization nodes that have access to the specified portfolio. This API can only be called by the management account in the organization or by a delegated admin. If a delegated admin is de-registered, they can no longer perform this operation.

list-portfolio-access

Lists the account IDs that have access to the specified portfolio. A delegated admin can list the accounts that have access to the shared portfolio. Note that if a delegated admin is de-registered, they can no longer perform this operation.

list-portfolios

Lists all portfolios in the catalog.

list-portfolios-for-product

Lists all portfolios that the specified product is associated with.

list-principals-for-portfolio

Lists all PrincipalARNs and corresponding PrincipalTypes associated with the specified portfolio.

list-provisioned-product-plans

Lists the plans for the specified provisioned product or all plans to which the user has access.

list-provisioning-artifacts

Lists all provisioning artifacts (also known as versions) for the specified product.

list-provisioning-artifacts-for-service-action

Lists all provisioning artifacts (also known as versions) for the specified self-service action.

list-record-history

Lists the specified requests or all performed requests.

list-resources-for-tag-option

Lists the resources associated with the specified TagOption.

list-service-actions

Lists all self-service actions.

list-service-actions-for-provisioning-artifact

Returns a paginated list of self-service actions associated with the specified Product ID and Provisioning Artifact ID.

list-stack-instances-for-provisioned-product

Returns summary information about stack instances that are associated with the specified CFN_STACKSET type provisioned product. You can filter for stack instances that are associated with a specific Amazon Web Services account name or Region.

list-tag-options

Lists the specified TagOptions or all TagOptions.

notify-provision-product-engine-workflow-result

Notifies the result of the provisioning engine execution.

notify-terminate-provisioned-product-engine-workflow-result

Notifies the result of the terminate engine execution.

notify-update-provisioned-product-engine-workflow-result

Notifies the result of the update engine execution.

provision-product

Provisions the specified product. A provisioned product is a resourced instance of a product. For example, provisioning a product that's based on an CloudFormation template launches an CloudFormation stack and its underlying resources. You can check the status of this request using DescribeRecord

reject-portfolio-share

Rejects an offer to share the specified portfolio.

scan-provisioned-products

Lists the provisioned products that are available (not terminated). To use additional filtering, see SearchProvisionedProducts.

search-products

Gets information about the products to which the caller has access.

search-products-as-admin

Gets information about the products for the specified portfolio or all products.

search-provisioned-products

Gets information about the provisioned products that meet the specified criteria.

terminate-provisioned-product

Terminates the specified provisioned product. This operation does not delete any records associated with the provisioned product. You can check the status of this request using DescribeRecord.

update-constraint

Updates the specified constraint.

update-portfolio

Updates the specified portfolio. You cannot update a product that was shared with you.

update-portfolio-share

Updates the specified portfolio share. You can use this API to enable or disable TagOptions sharing or Principal sharing for an existing portfolio share. The portfolio share cannot be updated if the CreatePortfolioShare operation is IN_PROGRESS, as the share is not available to recipient entities.

update-product

Updates the specified product.

update-provisioned-product

Requests updates to the configuration of the specified provisioned product. If there are tags associated with the object, they cannot be updated or added. Depending on the specific updates requested, this operation can update with no interruption, with some interruption, or replace the provisioned p

update-provisioned-product-properties

Requests updates to the properties of the specified provisioned product.

update-provisioning-artifact

Updates the specified provisioning artifact (also known as a version) for the specified product. You cannot update a provisioning artifact for a product that was shared with you.

update-service-action

Updates a self-service action.

update-tag-option

Updates the specified TagOption.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Stats

Total Commands90
ServiceService Catalog