AWS servicecatalog documentation change
Summary
Updated documentation links from Developer Guide to Administrator Guide, added new sections about API benefits/access methods, converted relative API links to absolute URLs, and added a comprehensive Example Workflow section.
Security assessment
The changes are routine documentation improvements without evidence of addressing security vulnerabilities. The added workflow describes standard provisioning operations without security-specific guidance. Link updates and new usage examples don't indicate security fixes.
Diff
diff --git a/servicecatalog/latest/dg/service-catalog-api-overview.md b/servicecatalog/latest/dg/service-catalog-api-overview.md index 803394c22..8b8422d24 100644 --- a//servicecatalog/latest/dg/service-catalog-api-overview.md +++ b//servicecatalog/latest/dg/service-catalog-api-overview.md @@ -3 +3 @@ -[](/pdfs/servicecatalog/latest/dg/service-catalog-dg.pdf#service-catalog-api-overview "Open PDF") +[](/pdfs/servicecatalog/latest/adminguide/service-catalog-ag.pdf#service-catalog-api-overview "Open PDF") @@ -5 +5 @@ -[Documentation](/index.html)[AWS Service Catalog](/servicecatalog/index.html)[Developer Guide](what-is-service-catalog.html) +[Documentation](/index.html)[AWS Service Catalog](/servicecatalog/index.html)[Administrator Guide](introduction.html) @@ -7 +7 @@ -Product DiscoveryProvisioning RequestsProvisioned ProductsProvisioned Product PlansPortfoliosPrincipal AssociationProductsProvisioning ArtifactsConstraintsService ActionsTagOptionsAppRegistry +Product DiscoveryProvisioning RequestsProvisioned ProductsProvisioned Product PlansPortfoliosPrincipal AssociationProductsProvisioning ArtifactsConstraintsService ActionsTagOptionsAppRegistryExample Workflow @@ -10,0 +11,31 @@ Product DiscoveryProvisioning RequestsProvisioned ProductsProvisioned Product Pl +**Benefits of Using the Service Catalog API** + +The AWS Service Catalog API provides programmatic control over all end-user actions as an alternative to using the AWS Management Console. When you use the API, you can do the following: + + * Write your own custom interfaces and apps + + * Obtain fine-grained control of end user product provisioning operations + + * Integrate resource provisioning into your orchestration pipelines + + * Access a central location that hosts your applications with their resources + + + + +**Access Service Catalog** + +To build applications using language-specific APIs, use the libraries, sample code, tutorials, and other resources for software developers. These libraries provide basic functions that automate tasks such as cryptographically signing your requests, retrying requests, and handling error responses, making it is easier for you to get started. To get started, open the [Tools for Amazon Web Services](https://aws.amazon.com/tools) and locate the SDK of your choice under **SDKs**. + +If you prefer to use a command line interface, you have the following options: + +**AWS Command Line Interface (CLI)** + + +To get started, see the [AWS Command Line Interface User Guide](https://docs.aws.amazon.com/cli/latest/userguide/). For more information about the commands for Service Catalog, see [servicecatalog](https://docs.aws.amazon.com/cli/latest/reference/servicecatalog/index.html) in the _AWS CLI Command Reference_. + +**AWS Tools for Windows PowerShell** + + +To get started, see the [AWS Tools for PowerShell User Guide](https://docs.aws.amazon.com/powershell/latest/userguide/). For more information about the cmdlets for Service Catalog, open the [AWS Tools for PowerShell Cmdlet Reference](https://docs.aws.amazon.com/powershell/latest/reference/) and expand **AWS Service Catalog**. + @@ -13 +44 @@ The AWS Service Catalog API can be logically divided into the following categori -###### Operations by category +###### Topics @@ -38,0 +70,2 @@ The AWS Service Catalog API can be logically divided into the following categori + * Example Workflow + @@ -46 +79 @@ Use these operations to discover or get information about products and the launc -[SearchProducts](./API_SearchProducts.html) +[SearchProducts](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_SearchProducts.html) @@ -51 +84 @@ Lists all products to which the caller has access. -[DescribeProduct](./API_DescribeProduct.html) +[DescribeProduct](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_DescribeProduct.html) @@ -56 +89 @@ Get detailed information about a product. -[DescribeProductView](./API_DescribeProductView.html) +[DescribeProductView](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_DescribeProductView.html) @@ -61 +94 @@ Functionally identical to `DescribeProduct`, except that it takes the ID of a pr -[ListLaunchPaths](./API_ListLaunchPaths.html) +[ListLaunchPaths](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_ListLaunchPaths.html) @@ -66 +99 @@ Lists all of the ways the user has access to a specified product, referred to as -[DescribeProvisioningParameters](./API_DescribeProvisioningParameters.html) +[DescribeProvisioningParameters](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_DescribeProvisioningParameters.html) @@ -77 +110 @@ Use these operations to request, update, or terminate provisioning for a product -[ProvisionProduct](./API_ProvisionProduct.html) +[ProvisionProduct](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_ProvisionProduct.html) @@ -82 +115 @@ Requests provisioning for a product. To provision a product is to launch the res -[UpdateProvisionedProduct](./API_UpdateProvisionedProduct.html) +[UpdateProvisionedProduct](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_UpdateProvisionedProduct.html) @@ -87 +120 @@ Updates the configuration of a provisioned product. For example, a product backe -[TerminateProvisionedProduct](./API_TerminateProvisionedProduct.html) +[TerminateProvisionedProduct](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_TerminateProvisionedProduct.html) @@ -96 +129 @@ Use these operations to get information about provisioned products. These operat -[ListRecordHistory](./API_ListRecordHistory.html) +[ListRecordHistory](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_ListRecordHistory.html) @@ -101 +134 @@ Lists all requests performed, even for terminated provisioned products. -[DescribeRecord](./API_DescribeRecord.html) +[DescribeRecord](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_DescribeRecord.html) @@ -106 +139 @@ Gets information about a request. Use this operation after the request operation -[SearchProvisionedProducts](./API_SearchProvisionedProducts.html) +[SearchProvisionedProducts](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_SearchProvisionedProducts.html) @@ -111 +144 @@ Gets information about the provisioned products that meet specified criteria. -[ScanProvisionedProducts](./API_ScanProvisionedProducts.html) +[ScanProvisionedProducts](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_ScanProvisionedProducts.html) @@ -116 +149 @@ Lists the provisioned products that are not terminated. -[DescribeProvisionedProduct](./API_DescribeProvisionedProduct.html) +[DescribeProvisionedProduct](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_DescribeProvisionedProduct.html) @@ -121 +154 @@ Gets information about a provisioned product. -[ImportAsProvisionedProduct](./API_ImportAsProvisionedProduct.html) +[ImportAsProvisionedProduct](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_ImportAsProvisionedProduct.html) @@ -126 +159 @@ Requests the import of a resource as a Service Catalog provisioned product that -[UpdateProvisionedProductProperties](./API_UpdateProvisionedProductProperties.html) +[UpdateProvisionedProductProperties](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_UpdateProvisionedProductProperties.html) @@ -135 +168 @@ Use these operations to manage your provisioned product plans. A plan includes t -[CreateProvisionedProductPlan](./API_CreateProvisionedProductPlan.html) +[CreateProvisionedProductPlan](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_CreateProvisionedProductPlan.html) @@ -140 +173 @@ Creates a plan. -[DescribeProvisionedProductPlan](./API_DescribeProvisionedProductPlan.html) +[DescribeProvisionedProductPlan](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_DescribeProvisionedProductPlan.html) @@ -145 +178 @@ Gets information about the resource changes for a plan. -[ExecuteProvisionedProductPlan](./API_ExecuteProvisionedProductPlan.html) +[ExecuteProvisionedProductPlan](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_ExecuteProvisionedProductPlan.html) @@ -150 +183 @@ Provisions or modifies a product based on a plan. -[ListProvisionedProductPlans](./API_ListProvisionedProductPlans.html) +[ListProvisionedProductPlans](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_ListProvisionedProductPlans.html) @@ -155 +188 @@ Lists the plans for a provisioned product. -[DeleteProvisionedProductPlan](./API_DeleteProvisionedProductPlan.html) +[DeleteProvisionedProductPlan](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_DeleteProvisionedProductPlan.html) @@ -164 +197 @@ Catalog administrators use these operations provide all necessary operations for -[CreatePortfolio](./API_CreatePortfolio.html) +[CreatePortfolio](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_CreatePortfolio.html) @@ -169 +202 @@ Creates a portfolio. -[DeletePortfolio](./API_DeletePortfolio.html) +[DeletePortfolio](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_DeletePortfolio.html) @@ -174 +207 @@ Deletes a portfolio. -[DescribePortfolio](./API_DescribePortfolio.html) +[DescribePortfolio](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_DescribePortfolio.html) @@ -179 +212 @@ Gets detailed information about a portfolio. -[DescribePortfolioShares](./API_DescribePortfolioShares.html) +[DescribePortfolioShares](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_DescribePortfolioShares.html) @@ -184 +217 @@ Returns a summary of each of the portfolio shares that were created for the spec -[ListPortfolios](./API_ListPortfolios.html) +[ListPortfolios](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_ListPortfolios.html) @@ -189 +222 @@ Lists all portfolios in the catalog. -[ListPortfoliosForProduct](./API_ListPortfoliosForProduct.html) +[ListPortfoliosForProduct](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_ListPortfoliosForProduct.html) @@ -194 +227 @@ Lists all portfolios that a product is associated with. -[UpdatePortfolio](./API_UpdatePortfolio.html) +[UpdatePortfolio](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_UpdatePortfolio.html) @@ -199 +232 @@ Updates a portfolio. -[UpdatePortfolioShare](./API_UpdatePortfolioShare.html) +[UpdatePortfolioShare](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_UpdatePortfolioShare.html) @@ -204 +237 @@ Updates a portfolio share. -[CreatePortfolioShare](./API_CreatePortfolioShare.html) +[CreatePortfolioShare](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_CreatePortfolioShare.html) @@ -209 +242 @@ Shares a portfolio with an AWS account. -[DeletePortfolioShare](./API_DeletePortfolioShare.html) +[DeletePortfolioShare](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_DeletePortfolioShare.html) @@ -214 +247 @@ Stops sharing a portfolio. -[AcceptPortfolioShare](./API_AcceptPortfolioShare.html) +[AcceptPortfolioShare](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_AcceptPortfolioShare.html) @@ -219 +252 @@ Accepts an offer to share a portfolio. -[RejectPortfolioShare](./API_RejectPortfolioShare.html) +[RejectPortfolioShare](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_RejectPortfolioShare.html) @@ -224 +257 @@ Rejects an offer to share a portfolio. -[ListAcceptedPortfolioShares](./API_ListAcceptedPortfolioShares.html) +[ListAcceptedPortfolioShares](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_ListAcceptedPortfolioShares.html) @@ -229 +262 @@ Lists details of all portfolios for which sharing was accepted by this account. -[ListPortfolioAccess](./API_ListPortfolioAccess.html) +[ListPortfolioAccess](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_ListPortfolioAccess.html) @@ -238 +271 @@ Catalog administrators use these operations provide all necessary operations for -[AssociatePrincipalWithPortfolio](./API_AssociatePrincipalWithPortfolio.html) +[AssociatePrincipalWithPortfolio](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_AssociatePrincipalWithPortfolio.html) @@ -243 +276 @@ Associates a principal ARN with a portfolio. -[DisassociatePrincipalFromPortfolio](./API_DisassociatePrincipalFromPortfolio.html) +[DisassociatePrincipalFromPortfolio](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_DisassociatePrincipalFromPortfolio.html) @@ -248 +281 @@ Disassociates a principal ARN from a portfolio. -[ListPrincipalsForPortfolio](./API_ListPrincipalsForPortfolio.html) +[ListPrincipalsForPortfolio](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_ListPrincipalsForPortfolio.html) @@ -257 +290 @@ Catalog administrators use these operations provide all necessary operations for -[SearchProductsAsAdmin](./API_SearchProductsAsAdmin.html) +[SearchProductsAsAdmin](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_SearchProductsAsAdmin.html) @@ -262 +295 @@ Gets summary and status information for products. -[DescribeProductAsAdmin](./API_DescribeProductAsAdmin.html) +[DescribeProductAsAdmin](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_DescribeProductAsAdmin.html) @@ -267 +300 @@ Gets information about a product. -[CreateProduct](./API_CreateProduct.html) +[CreateProduct](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_CreateProduct.html) @@ -272 +305 @@ Creates a product. -[CopyProduct](./API_CopyProduct.html) +[CopyProduct](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_CopyProduct.html) @@ -277 +310 @@ Copies a product. -[DescribeCopyProductStatus](./API_DescribeCopyProductStatus.html) +[DescribeCopyProductStatus](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_DescribeCopyProductStatus.html) @@ -282 +315 @@ Gets the status of a copy product operation. -[UpdateProduct](./API_UpdateProduct.html) +[UpdateProduct](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_UpdateProduct.html) @@ -287 +320 @@ Updates a product. -[DeleteProduct](./API_DeleteProduct.html) +[DeleteProduct](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_DeleteProduct.html) @@ -292 +325 @@ Deletes a product. -[AssociateProductWithPortfolio](./API_AssociateProductWithPortfolio.html) +[AssociateProductWithPortfolio](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_AssociateProductWithPortfolio.html) @@ -297 +330 @@ Associates a product with a portfolio. -[DisassociateProductFromPortfolio](./API_DisassociateProductFromPortfolio.html) +[DisassociateProductFromPortfolio](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_DisassociateProductFromPortfolio.html) @@ -306 +339 @@ Catalog administrators use these operations to manage provisioning artifacts (al -[DescribeProvisioningArtifact](./API_DescribeProvisioningArtifact.html) +[DescribeProvisioningArtifact](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_DescribeProvisioningArtifact.html) @@ -311 +344 @@ Gets information about a provisioning artifact. -[CreateProvisioningArtifact](./API_CreateProvisioningArtifact.html) +[CreateProvisioningArtifact](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_CreateProvisioningArtifact.html) @@ -316 +349 @@ Creates a provisioning artifact for a product. -[DeleteProvisioningArtifact](./API_DeleteProvisioningArtifact.html) +[DeleteProvisioningArtifact](https://docs.aws.amazon.com/servicecatalog/latest/APIReference/API_DeleteProvisioningArtifact.html) @@ -321 +354 @@ Deletes a provisioning artifact. -[ListProvisioningArtifacts](./API_ListProvisioningArtifacts.html)