AWS servicecatalog documentation change
Summary
Updated title, introduction, benefits section; removed API access details and workflow; added video section and simplified content structure.
Security assessment
Added documentation about 'Fine-grain access control' security feature using IAM for portfolio access management. No vulnerability fixes or incident responses are present.
Diff
diff --git a/servicecatalog/latest/dg/what-is-service-catalog.md b/servicecatalog/latest/dg/what-is-service-catalog.md index 703490601..d59130951 100644 --- a//servicecatalog/latest/dg/what-is-service-catalog.md +++ b//servicecatalog/latest/dg/what-is-service-catalog.md @@ -1 +1 @@ -[View a markdown version of this page](what-is-service-catalog.md) +[View a markdown version of this page](introduction.md) @@ -3 +3 @@ -[](/pdfs/servicecatalog/latest/dg/service-catalog-dg.pdf#what-is-service-catalog "Open PDF") +[](/pdfs/servicecatalog/latest/adminguide/service-catalog-ag.pdf#introduction "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 @@ -Benefits of Using the Service Catalog APIAccess Service CatalogExample Workflow +Video: Introduction to AWS Service Catalog @@ -9 +9 @@ Benefits of Using the Service Catalog APIAccess Service CatalogExample Workflow -# What Is AWS Service Catalog? +# What Is Service Catalog? @@ -11 +11 @@ Benefits of Using the Service Catalog APIAccess Service CatalogExample Workflow -[AWS Service Catalog](https://aws.amazon.com/servicecatalog) enables organizations to create and manage catalogs of products that are approved for use in AWS. +Service Catalog enables organizations to create and manage catalogs of IT services that are approved for AWS. These IT services can include everything from virtual machine images, servers, software, databases, and more to complete multi-tier application architectures. @@ -13 +13 @@ Benefits of Using the Service Catalog APIAccess Service CatalogExample Workflow -If you are new to AWS Service Catalog, see the following guides: [Service Catalog Administrator Guide](https://docs.aws.amazon.com/servicecatalog/latest/adminguide/) and [Service Catalog User Guide](https://docs.aws.amazon.com/servicecatalog/latest/userguide/). +Service Catalog allows organizations to centrally manage commonly deployed IT services, and helps organizations achieve consistent governance and meet compliance requirements. End users can quickly deploy only the approved IT services they need, following the constraints set by your organization. @@ -15 +15 @@ If you are new to AWS Service Catalog, see the following guides: [Service Catalo -## Benefits of Using the Service Catalog API +Service Catalog provides the following benefits: @@ -17 +17 @@ If you are new to AWS Service Catalog, see the following guides: [Service Catalo -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: + * ****Standardization**** @@ -19 +19 @@ The AWS Service Catalog API provides programmatic control over all end-user acti - * Write your own custom interfaces and apps +Administer and manage approved assets by restricting where the product can be launched, the type of instance that can be used, and many other configuration options. The result is a standardized landscape for product provisioning for your entire organization. @@ -21 +21 @@ The AWS Service Catalog API provides programmatic control over all end-user acti - * Obtain fine-grained control of end user product provisioning operations + * ****Self-service discovery and launch**** @@ -23 +23 @@ The AWS Service Catalog API provides programmatic control over all end-user acti - * Integrate resource provisioning into your orchestration pipelines +Users browse listings of products (services or applications) that they have access to, locate the product that they want to use, and launch it all on their own as a provisioned product. @@ -25 +25 @@ The AWS Service Catalog API provides programmatic control over all end-user acti - * Access a central location that hosts your applications with their resources + * **Fine-grain access control** @@ -26,0 +27 @@ The AWS Service Catalog API provides programmatic control over all end-user acti +Administrators assemble portfolios of products from their catalog, add constraints and resource tags to be used at provisioning, and then grant access to the portfolio through AWS Identity and Access Management (IAM) users and groups. @@ -27,0 +29 @@ The AWS Service Catalog API provides programmatic control over all end-user acti + * **Extensibility and version control** @@ -28,0 +31 @@ The AWS Service Catalog API provides programmatic control over all end-user acti +Administrators can add a product to any number of portfolios and restrict it without creating another copy. Updating the product to a new version propagates the update to all products in every portfolio that references it. @@ -30 +32,0 @@ The AWS Service Catalog API provides programmatic control over all end-user acti -## Access Service Catalog @@ -32 +33,0 @@ The AWS Service Catalog API provides programmatic control over all end-user acti -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 [Tools for Amazon Web Services](https://aws.amazon.com/tools/) and locate the SDK of your choice under **SDKs**. @@ -34 +34,0 @@ To build applications using language-specific APIs, use the libraries, sample co -If you prefer to use a command line interface, you have the following options: @@ -36,44 +36 @@ 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**. - -## Example Workflow - -In this scenario, the administrator creates resources using Service Catalog and an end user finds what products are available and provisions the product. This is an example workflow; this is not the only way to use the Service Catalog API. - -###### Administrator Tasks - - * Create portfolios, product views, products, product versions, and constraints. - - * Assign IAM users to products, which gives them access. - - - - -###### End User Tasks - - 1. The user calls [SearchProducts](./API_SearchProducts.html) with no arguments. This returns the list of products the user has access to, as well as a "SearchDomain" that can be used to scope the results. - - 2. The user continues to call [SearchProducts](./API_SearchProducts.html) with additional search filters until the desired product is found. - - 3. The user calls [DescribeProductView](./API_DescribeProductView.html) to find the list of provisioning artifacts (also known as versions) for this product. This determines what the user actually provisions. - - 4. The user calls [ListLaunchPaths](./API_ListLaunchPaths.html) to find the list of paths for this product, along with the constraints for each path. This determines what set of constraints is applied on the provisioned product. - - 5. After choosing a provisioning artifact and a path, the user calls [DescribeProvisioningParameters](./API_DescribeProvisioningParameters.html). This returns the list of parameters the user must provide before provisioning a product using the provisioning artifact and path, along with whatever additional usage instructions the administrator decided to provide. - - 6. The user calls [ProvisionProduct](./API_ProvisionProduct.html), specifying the product, provisioning artifact, path, and input parameters. The input parameters are a list of key-value pairs, where the keys are obtained using [DescribeProvisioningParameters](./API_DescribeProvisioningParameters.html) and the values are user-provided (for example, `{ParameterKey:"dbpassword", ParameterValue:"mycoolpassword"}`). This starts a workflow to create the specified AWS resources. It also creates a record detail that tracks the provisioning request, and a provisioned product object that represents the underlying AWS resources. - - 7. The user polls [DescribeRecord](./API_DescribeRecord.html) to see when the status of the record detail changes from the `IN_PROGRESS` state to a completed state (either `SUCCEEDED` or `ERROR`). - - 8. When the record detail for the request is in a completed state, the user calls [DescribeRecord](./API_DescribeRecord.html) once more. The outputs identifies the created resources. - - 9. The user calls [UpdateProvisionedProduct](./API_UpdateProvisionedProduct.html) to update the underlying resources in place. Depending on the specific updates requested, this operation can update with no interruption, with some interruption, or replace the provisioned product entirely. - - 10. Finally, the user calls [TerminateProvisionedProduct](./API_TerminateProvisionedProduct.html) to terminate the provisioned product. +For more information, see the [Service Catalog detail page](http://aws.amazon.com/servicecatalog/details). @@ -80,0 +38 @@ In this scenario, the administrator creates resources using Service Catalog and +The Service Catalog API provides programmatic control over all end-user actions as an alternative to using the AWS Management Console. For more information, see [Service Catalog Developer Guide](https://docs.aws.amazon.com/servicecatalog/latest/dg/). @@ -81,0 +40 @@ In this scenario, the administrator creates resources using Service Catalog and +## Video: Introduction to AWS Service Catalog @@ -82,0 +42 @@ In this scenario, the administrator creates resources using Service Catalog and +This video (7:27) describes how to create, organize, and govern a curated catalog of AWS products, and share products with permissions level. As a result, end users can quickly provision approved IT resources without direct access to the underlying AWS services. @@ -90 +50 @@ To use the Amazon Web Services Documentation, Javascript must be enabled. Please -API Overview +Overview