AWS Service Catalog
Service Catalog Service Catalog enables organizations to create and manage catalogs of IT services that are approved for Amazon Web Services. To get the most…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Service Catalog
Service Catalog enables
organizations to create and manage catalogs of IT services that are approved for Amazon Web Services. To
get the most out of this documentation, you should be familiar with the terminology
discussed in Service Catalog
Concepts .
Endpoints 90
- POSTAccept portfolio share
/#X-Amz-Target=AWS242ServiceCatalogService.AcceptPortfolioShareAccepts an offer to share the specified portfolio. - POSTAssociate budget with resource
/#X-Amz-Target=AWS242ServiceCatalogService.AssociateBudgetWithResourceAssociates the specified budget with the specified resource. - POSTAssociate principal with portfolio
/#X-Amz-Target=AWS242ServiceCatalogService.AssociatePrincipalWithPortfolioAssociates the specified principal ARN with the specified portfolio. If you share the portfolio with principal name sharing enabled, the PrincipalARN… - POSTAssociate product with portfolio
/#X-Amz-Target=AWS242ServiceCatalogService.AssociateProductWithPortfolioAssociates the specified product with the specified portfolio. A delegated admin is authorized to invoke this command. - POSTAssociate service action with provisioning artifact
/#X-Amz-Target=AWS242ServiceCatalogService.AssociateServiceActionWithProvisioningArtifactAssociates a self-service action with a provisioning artifact. - POSTAssociate tag option with resource
/#X-Amz-Target=AWS242ServiceCatalogService.AssociateTagOptionWithResourceAssociate the specified TagOption with the specified portfolio or product. - POSTBatch associate service action with provisioning artifact
/#X-Amz-Target=AWS242ServiceCatalogService.BatchAssociateServiceActionWithProvisioningArtifactAssociates multiple self-service actions with provisioning artifacts. - POSTBatch disassociate service action from provisioning artifact
/#X-Amz-Target=AWS242ServiceCatalogService.BatchDisassociateServiceActionFromProvisioningArtifactDisassociates a batch of self-service actions from the specified provisioning artifact. - POSTCopy product
/#X-Amz-Target=AWS242ServiceCatalogService.CopyProductCopies 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… - POSTCreate constraint
/#X-Amz-Target=AWS242ServiceCatalogService.CreateConstraintCreates a constraint. A delegated admin is authorized to invoke this command. - POSTCreate portfolio
/#X-Amz-Target=AWS242ServiceCatalogService.CreatePortfolioCreates a portfolio. A delegated admin is authorized to invoke this command. - POSTCreate portfolio share
/#X-Amz-Target=AWS242ServiceCatalogService.CreatePortfolioShareShares the specified portfolio with the specified account or organization node. Shares to an organization node can only be created by the management account… - POSTCreate product
/#X-Amz-Target=AWS242ServiceCatalogService.CreateProductCreates a product. A delegated admin is authorized to invoke this command. The user or role that performs this operation must have the… - POSTCreate provisioned product plan
/#X-Amz-Target=AWS242ServiceCatalogService.CreateProvisionedProductPlanCreates 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… - POSTCreate provisioning artifact
/#X-Amz-Target=AWS242ServiceCatalogService.CreateProvisioningArtifactCreates a provisioning artifact (also known as a version) for the specified product. You cannot create a provisioning artifact for a product that was shared… - POSTCreate service action
/#X-Amz-Target=AWS242ServiceCatalogService.CreateServiceActionCreates a self-service action. - POSTCreate tag option
/#X-Amz-Target=AWS242ServiceCatalogService.CreateTagOptionCreates a TagOption. - POSTDelete constraint
/#X-Amz-Target=AWS242ServiceCatalogService.DeleteConstraintDeletes the specified constraint. A delegated admin is authorized to invoke this command. - POSTDelete portfolio
/#X-Amz-Target=AWS242ServiceCatalogService.DeletePortfolioDeletes the specified portfolio. You cannot delete a portfolio if it was shared with you or if it has associated products, users, constraints, or shared… - POSTDelete portfolio share
/#X-Amz-Target=AWS242ServiceCatalogService.DeletePortfolioShareStops sharing the specified portfolio with the specified account or organization node. Shares to an organization node can only be deleted by the management… - POSTDelete product
/#X-Amz-Target=AWS242ServiceCatalogService.DeleteProductDeletes 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… - POSTDelete provisioned product plan
/#X-Amz-Target=AWS242ServiceCatalogService.DeleteProvisionedProductPlanDeletes the specified plan. - POSTDelete provisioning artifact
/#X-Amz-Target=AWS242ServiceCatalogService.DeleteProvisioningArtifactDeletes the specified provisioning artifact (also known as a version) for the specified product. You cannot delete a provisioning artifact associated with a… - POSTDelete service action
/#X-Amz-Target=AWS242ServiceCatalogService.DeleteServiceActionDeletes a self-service action. - POSTDelete tag option
/#X-Amz-Target=AWS242ServiceCatalogService.DeleteTagOptionDeletes the specified TagOption. You cannot delete a TagOption if it is associated with a product or portfolio. - POSTDescribe constraint
/#X-Amz-Target=AWS242ServiceCatalogService.DescribeConstraintGets information about the specified constraint. - POSTDescribe copy product status
/#X-Amz-Target=AWS242ServiceCatalogService.DescribeCopyProductStatusGets the status of the specified copy product operation. - POSTDescribe portfolio
/#X-Amz-Target=AWS242ServiceCatalogService.DescribePortfolioGets information about the specified portfolio. A delegated admin is authorized to invoke this command. - POSTDescribe portfolio share status
/#X-Amz-Target=AWS242ServiceCatalogService.DescribePortfolioShareStatusGets 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. - POSTDescribe portfolio shares
/#X-Amz-Target=AWS242ServiceCatalogService.DescribePortfolioSharesReturns 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… - POSTDescribe product
/#X-Amz-Target=AWS242ServiceCatalogService.DescribeProductGets information about the specified product. Running this operation with administrator access results in a failure. DescribeProductAsAdmin should be used… - POSTDescribe product as admin
/#X-Amz-Target=AWS242ServiceCatalogService.DescribeProductAsAdminGets information about the specified product. This operation is run with administrator access. - POSTDescribe product view
/#X-Amz-Target=AWS242ServiceCatalogService.DescribeProductViewGets information about the specified product. - POSTDescribe provisioned product
/#X-Amz-Target=AWS242ServiceCatalogService.DescribeProvisionedProductGets information about the specified provisioned product. - POSTDescribe provisioned product plan
/#X-Amz-Target=AWS242ServiceCatalogService.DescribeProvisionedProductPlanGets information about the resource changes for the specified plan. - POSTDescribe provisioning artifact
/#X-Amz-Target=AWS242ServiceCatalogService.DescribeProvisioningArtifactGets information about the specified provisioning artifact (also known as a version) for the specified product. - POSTDescribe provisioning parameters
/#X-Amz-Target=AWS242ServiceCatalogService.DescribeProvisioningParametersGets information about the configuration required to provision the specified product using the specified provisioning artifact. If the output contains a… - POSTDescribe record
/#X-Amz-Target=AWS242ServiceCatalogService.DescribeRecordGets information about the specified request operation. Use this operation after calling a request operation (for example, ProvisionProduct ,… - POSTDescribe service action
/#X-Amz-Target=AWS242ServiceCatalogService.DescribeServiceActionDescribes a self-service action. - POSTDescribe service action execution parameters
/#X-Amz-Target=AWS242ServiceCatalogService.DescribeServiceActionExecutionParametersFinds the default parameters for a specific self-service action on a specific provisioned product and returns a map of the results to the user. - POSTDescribe tag option
/#X-Amz-Target=AWS242ServiceCatalogService.DescribeTagOptionGets information about the specified TagOption. - POSTDisable aWS organizations access
/#X-Amz-Target=AWS242ServiceCatalogService.DisableAWSOrganizationsAccessDisable portfolio sharing through the Organizations service. This command will not delete your current shares, but prevents you from creating new shares… - POSTDisassociate budget from resource
/#X-Amz-Target=AWS242ServiceCatalogService.DisassociateBudgetFromResourceDisassociates the specified budget from the specified resource. - POSTDisassociate principal from portfolio
/#X-Amz-Target=AWS242ServiceCatalogService.DisassociatePrincipalFromPortfolioDisassociates a previously associated principal ARN from a specified portfolio. The PrincipalType and PrincipalARN must match the… - POSTDisassociate product from portfolio
/#X-Amz-Target=AWS242ServiceCatalogService.DisassociateProductFromPortfolioDisassociates the specified product from the specified portfolio. A delegated admin is authorized to invoke this command. - POSTDisassociate service action from provisioning artifact
/#X-Amz-Target=AWS242ServiceCatalogService.DisassociateServiceActionFromProvisioningArtifactDisassociates the specified self-service action association from the specified provisioning artifact. - POSTDisassociate tag option from resource
/#X-Amz-Target=AWS242ServiceCatalogService.DisassociateTagOptionFromResourceDisassociates the specified TagOption from the specified resource. - POSTEnable aWS organizations access
/#X-Amz-Target=AWS242ServiceCatalogService.EnableAWSOrganizationsAccessEnable portfolio sharing feature through Organizations. This API will allow Service Catalog to receive updates on your organization in order to sync your… - POSTExecute provisioned product plan
/#X-Amz-Target=AWS242ServiceCatalogService.ExecuteProvisionedProductPlanProvisions or modifies a product based on the resource changes for the specified plan. - POSTExecute provisioned product service action
/#X-Amz-Target=AWS242ServiceCatalogService.ExecuteProvisionedProductServiceActionExecutes a self-service action against a provisioned product. - POSTGet aWS organizations access status
/#X-Amz-Target=AWS242ServiceCatalogService.GetAWSOrganizationsAccessStatusGet 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… - POSTGet provisioned product outputs
/#X-Amz-Target=AWS242ServiceCatalogService.GetProvisionedProductOutputsThis 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… - POSTImport as provisioned product
/#X-Amz-Target=AWS242ServiceCatalogService.ImportAsProvisionedProductRequests the import of a resource as an Service Catalog provisioned product that is associated to an Service Catalog product and provisioning artifact. Once… - POSTList accepted portfolio shares
/#X-Amz-Target=AWS242ServiceCatalogService.ListAcceptedPortfolioSharesLists all imported portfolios for which account-to-account shares were accepted by this account. By specifying the PortfolioShareType , you can list… - POSTList budgets for resource
/#X-Amz-Target=AWS242ServiceCatalogService.ListBudgetsForResourceLists all the budgets associated to the specified resource. - POSTList constraints for portfolio
/#X-Amz-Target=AWS242ServiceCatalogService.ListConstraintsForPortfolioLists the constraints for the specified portfolio and product. - POSTList launch paths
/#X-Amz-Target=AWS242ServiceCatalogService.ListLaunchPathsLists 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… - POSTList organization portfolio access
/#X-Amz-Target=AWS242ServiceCatalogService.ListOrganizationPortfolioAccessLists 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… - POSTList portfolio access
/#X-Amz-Target=AWS242ServiceCatalogService.ListPortfolioAccessLists 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… - POSTList portfolios
/#X-Amz-Target=AWS242ServiceCatalogService.ListPortfoliosLists all portfolios in the catalog. - POSTList portfolios for product
/#X-Amz-Target=AWS242ServiceCatalogService.ListPortfoliosForProductLists all portfolios that the specified product is associated with. - POSTList principals for portfolio
/#X-Amz-Target=AWS242ServiceCatalogService.ListPrincipalsForPortfolioLists all PrincipalARN s and corresponding PrincipalType s associated with the specified portfolio. - POSTList provisioned product plans
/#X-Amz-Target=AWS242ServiceCatalogService.ListProvisionedProductPlansLists the plans for the specified provisioned product or all plans to which the user has access. - POSTList provisioning artifacts
/#X-Amz-Target=AWS242ServiceCatalogService.ListProvisioningArtifactsLists all provisioning artifacts (also known as versions) for the specified product. - POSTList provisioning artifacts for service action
/#X-Amz-Target=AWS242ServiceCatalogService.ListProvisioningArtifactsForServiceActionLists all provisioning artifacts (also known as versions) for the specified self-service action. - POSTList record history
/#X-Amz-Target=AWS242ServiceCatalogService.ListRecordHistoryLists the specified requests or all performed requests. - POSTList resources for tag option
/#X-Amz-Target=AWS242ServiceCatalogService.ListResourcesForTagOptionLists the resources associated with the specified TagOption. - POSTList service actions
/#X-Amz-Target=AWS242ServiceCatalogService.ListServiceActionsLists all self-service actions. - POSTList service actions for provisioning artifact
/#X-Amz-Target=AWS242ServiceCatalogService.ListServiceActionsForProvisioningArtifactReturns a paginated list of self-service actions associated with the specified Product ID and Provisioning Artifact ID. - POSTList stack instances for provisioned product
/#X-Amz-Target=AWS242ServiceCatalogService.ListStackInstancesForProvisionedProductReturns summary information about stack instances that are associated with the specified CFN_STACKSET type provisioned product. You can filter for stack… - POSTList tag options
/#X-Amz-Target=AWS242ServiceCatalogService.ListTagOptionsLists the specified TagOptions or all TagOptions. - POSTNotify provision product engine workflow result
/#X-Amz-Target=AWS242ServiceCatalogService.NotifyProvisionProductEngineWorkflowResultNotifies the result of the provisioning engine execution. - POSTNotify terminate provisioned product engine workflow result
/#X-Amz-Target=AWS242ServiceCatalogService.NotifyTerminateProvisionedProductEngineWorkflowResultNotifies the result of the terminate engine execution. - POSTNotify update provisioned product engine workflow result
/#X-Amz-Target=AWS242ServiceCatalogService.NotifyUpdateProvisionedProductEngineWorkflowResultNotifies the result of the update engine execution. - POSTProvision product
/#X-Amz-Target=AWS242ServiceCatalogService.ProvisionProductProvisions the specified product. A provisioned product is a resourced instance of a product. For example, provisioning a product that's based on an… - POSTReject portfolio share
/#X-Amz-Target=AWS242ServiceCatalogService.RejectPortfolioShareRejects an offer to share the specified portfolio. - POSTScan provisioned products
/#X-Amz-Target=AWS242ServiceCatalogService.ScanProvisionedProductsLists the provisioned products that are available (not terminated). To use additional filtering, see SearchProvisionedProducts . - POSTSearch products
/#X-Amz-Target=AWS242ServiceCatalogService.SearchProductsGets information about the products to which the caller has access. - POSTSearch products as admin
/#X-Amz-Target=AWS242ServiceCatalogService.SearchProductsAsAdminGets information about the products for the specified portfolio or all products. - POSTSearch provisioned products
/#X-Amz-Target=AWS242ServiceCatalogService.SearchProvisionedProductsGets information about the provisioned products that meet the specified criteria. - POSTTerminate provisioned product
/#X-Amz-Target=AWS242ServiceCatalogService.TerminateProvisionedProductTerminates the specified provisioned product. This operation does not delete any records associated with the provisioned product. You can check the status of… - POSTUpdate constraint
/#X-Amz-Target=AWS242ServiceCatalogService.UpdateConstraintUpdates the specified constraint. - POSTUpdate portfolio
/#X-Amz-Target=AWS242ServiceCatalogService.UpdatePortfolioUpdates the specified portfolio. You cannot update a product that was shared with you. - POSTUpdate portfolio share
/#X-Amz-Target=AWS242ServiceCatalogService.UpdatePortfolioShareUpdates the specified portfolio share. You can use this API to enable or disable TagOptions sharing or Principal sharing for an existing portfolio share. The… - POSTUpdate product
/#X-Amz-Target=AWS242ServiceCatalogService.UpdateProductUpdates the specified product. - POSTUpdate provisioned product
/#X-Amz-Target=AWS242ServiceCatalogService.UpdateProvisionedProductRequests updates to the configuration of the specified provisioned product. If there are tags associated with the object, they cannot be updated or added.… - POSTUpdate provisioned product properties
/#X-Amz-Target=AWS242ServiceCatalogService.UpdateProvisionedProductPropertiesRequests updates to the properties of the specified provisioned product. - POSTUpdate provisioning artifact
/#X-Amz-Target=AWS242ServiceCatalogService.UpdateProvisioningArtifactUpdates the specified provisioning artifact (also known as a version) for the specified product. You cannot update a provisioning artifact for a product that… - POSTUpdate service action
/#X-Amz-Target=AWS242ServiceCatalogService.UpdateServiceActionUpdates a self-service action. - POSTUpdate tag option
/#X-Amz-Target=AWS242ServiceCatalogService.UpdateTagOptionUpdates the specified TagOption.
API details
- Base URL
https://servicecatalog.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 90 operations on 90 pathsPOST 90
- Description format
- AWS Smithy model, API version
2015-12-10 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the AWS Service Catalog in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Service Catalog collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Accept portfolio share” (POST /#X-Amz-Target=AWS242ServiceCatalogService.AcceptPortfolioShare), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AWS Service Catalog?
Service Catalog Service Catalog enables organizations to create and manage catalogs of IT services that are approved for Amazon Web Services. To get the most… It is listed under Developer tools and has 90 endpoints.
Who publishes the AWS Service Catalog?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AWS Service Catalog?
Requests go to https://servicecatalog.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the AWS Service Catalog?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the AWS Service Catalog have?
90 operations on 90 paths (90 POST).
Is forking the AWS Service Catalog free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.