baiji v0.6.5 Baiji.ServiceCatalog

AWS Service Catalog

Overview

AWS Service Catalog allows organizations to create and manage catalogs of IT services that are approved for use on AWS. This documentation provides reference material for the AWS Service Catalog end user API. To get the most out of this documentation, be familiar with the terminology discussed in AWS Service Catalog Concepts.

Additional Resources

  • [AWS Service Catalog Administrator Guide](http://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html)
  • [AWS Service Catalog User Guide](http://docs.aws.amazon.com/servicecatalog/latest/userguide/introduction.html)

Link to this section Summary

Functions

Returns a map containing the input/output shapes for this endpoint

Outputs values common to all actions

Accepts an offer to share a portfolio

Associates the specified principal ARN with the specified portfolio

Associate a TagOption identifier with a resource identifier

Copies the specified source product to the specified target product or a new product

Creates a new constraint. For more information, see Using Constraints

Create a new provisioning artifact for the specified product. This operation does not work with a product that has been shared with you

Deletes the specified constraint

Deletes the specified portfolio. This operation does not work with a portfolio that has been shared with you or if it has products, users, constraints, or shared accounts associated with it

Deletes the specified portfolio share

Deletes the specified product. This operation does not work with a product that has been shared with you or is associated with a portfolio

Deletes the specified provisioning artifact. This operation does not work on a provisioning artifact associated with a product that has been shared with you, or on the last provisioning artifact associated with a product (a product must have at least one provisioning artifact)

Retrieves detailed information for a specified constraint

Describes the status of the specified copy product operation

Retrieves detailed information and any tags associated with the specified portfolio

Retrieves information about a specified product

Retrieves information about a specified product, run with administrator access

Retrieves information about a specified product

Retrieve detailed information about the provisioned product

Retrieves detailed information about the specified provisioning artifact

Provides information about parameters required to provision a specified product in a specified manner. Use this operation to obtain the list of ProvisioningArtifactParameters parameters available to call the ProvisionProduct operation for the specified product

Retrieves a paginated list of the full details of a specific request. Use this operation after calling a request operation (ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct)

Disassociates a previously associated principal ARN from a specified portfolio

Disassociates the specified product from the specified portfolio

Disassociates a TagOption from a resource

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

Retrieves detailed constraint information for the specified portfolio and product

Returns a paginated list of all paths to a specified product. A path is how the user has access to a specified product, and is necessary when provisioning a product. A path also determines the constraints put on the product

Lists the account IDs that have been authorized sharing of the specified portfolio

Lists all portfolios in the catalog

Lists all portfolios that the specified product is associated with

Lists all principal ARNs associated with the specified portfolio

Lists all provisioning artifacts associated with the specified product

Returns a paginated list of all performed requests, in the form of RecordDetails objects that are filtered as specified

Lists resources associated with a TagOption

Lists detailed TagOptions information

Requests a provision of a specified product. A provisioned product is a resourced instance for a product. For example, provisioning a CloudFormation-template-backed product results in launching a CloudFormation stack and all the underlying resources that come with it

Rejects an offer to share a portfolio

Returns a paginated list of all the ProvisionedProduct objects that are currently available (not terminated)

Returns a paginated list all of the Products objects to which the caller has access

Retrieves summary and status information about all products created within the caller’s account. If a portfolio ID is provided, this operation retrieves information for only those products that are associated with the specified portfolio

Requests termination of an existing ProvisionedProduct object. If there are Tags associated with the object, they are terminated when the ProvisionedProduct object is terminated

Updates an existing constraint

Updates the specified portfolio’s details. This operation does not work with a product that has been shared with you

Updates an existing product

Requests updates to the configuration of an existing ProvisionedProduct object. If there are tags associated with the object, they cannot be updated or added with this operation. Depending on the specific updates requested, this operation may update with no interruption, with some interruption, or replace the ProvisionedProduct object entirely

Updates an existing provisioning artifact’s information. This operation does not work on a provisioning artifact associated with a product that has been shared with you

Updates an existing TagOption

Link to this section Functions

Returns a map containing the input/output shapes for this endpoint

Outputs values common to all actions

Link to this function accept_portfolio_share(input \\ %{}, options \\ [])

Accepts an offer to share a portfolio.

Link to this function associate_principal_with_portfolio(input \\ %{}, options \\ [])

Associates the specified principal ARN with the specified portfolio.

Link to this function associate_product_with_portfolio(input \\ %{}, options \\ [])

Associates a product with a portfolio.

Link to this function associate_tag_option_with_resource(input \\ %{}, options \\ [])

Associate a TagOption identifier with a resource identifier.

Link to this function copy_product(input \\ %{}, options \\ [])

Copies the specified source product to the specified target product or a new product.

You can copy the product to the same account or another account. You can copy the product to the same region or another region.

This operation is performed asynchronously. To track the progress of the operation, use DescribeCopyProductStatus.

Link to this function create_constraint(input \\ %{}, options \\ [])

Creates a new constraint. For more information, see Using Constraints.

Link to this function create_portfolio(input \\ %{}, options \\ [])

Creates a new portfolio.

Link to this function create_portfolio_share(input \\ %{}, options \\ [])

Creates a new portfolio share.

Link to this function create_product(input \\ %{}, options \\ [])

Creates a new product.

Link to this function create_provisioning_artifact(input \\ %{}, options \\ [])

Create a new provisioning artifact for the specified product. This operation does not work with a product that has been shared with you.

Link to this function create_tag_option(input \\ %{}, options \\ [])

Create a new TagOption.

Link to this function delete_constraint(input \\ %{}, options \\ [])

Deletes the specified constraint.

Link to this function delete_portfolio(input \\ %{}, options \\ [])

Deletes the specified portfolio. This operation does not work with a portfolio that has been shared with you or if it has products, users, constraints, or shared accounts associated with it.

Link to this function delete_portfolio_share(input \\ %{}, options \\ [])

Deletes the specified portfolio share.

Link to this function delete_product(input \\ %{}, options \\ [])

Deletes the specified product. This operation does not work with a product that has been shared with you or is associated with a portfolio.

Link to this function delete_provisioning_artifact(input \\ %{}, options \\ [])

Deletes the specified provisioning artifact. This operation does not work on a provisioning artifact associated with a product that has been shared with you, or on the last provisioning artifact associated with a product (a product must have at least one provisioning artifact).

Link to this function describe_constraint(input \\ %{}, options \\ [])

Retrieves detailed information for a specified constraint.

Link to this function describe_copy_product_status(input \\ %{}, options \\ [])

Describes the status of the specified copy product operation.

Link to this function describe_portfolio(input \\ %{}, options \\ [])

Retrieves detailed information and any tags associated with the specified portfolio.

Link to this function describe_product(input \\ %{}, options \\ [])

Retrieves information about a specified product.

This operation is functionally identical to DescribeProductView except that it takes as input ProductId instead of ProductViewId.

Link to this function describe_product_as_admin(input \\ %{}, options \\ [])

Retrieves information about a specified product, run with administrator access.

Link to this function describe_product_view(input \\ %{}, options \\ [])

Retrieves information about a specified product.

This operation is functionally identical to DescribeProduct except that it takes as input ProductViewId instead of ProductId.

Link to this function describe_provisioned_product(input \\ %{}, options \\ [])

Retrieve detailed information about the provisioned product.

Link to this function describe_provisioning_artifact(input \\ %{}, options \\ [])

Retrieves detailed information about the specified provisioning artifact.

Link to this function describe_provisioning_parameters(input \\ %{}, options \\ [])

Provides information about parameters required to provision a specified product in a specified manner. Use this operation to obtain the list of ProvisioningArtifactParameters parameters available to call the ProvisionProduct operation for the specified product.

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 launch is not blocked. In subsequent calls to the ProvisionProduct operation, do not include conflicted TagOption keys as tags. Calls to ProvisionProduct with empty TagOption values cause the error “Parameter validation failed: Missing required parameter in Tags[N]:Value “. Calls to ProvisionProduct with conflicted TagOption keys automatically tag the provisioned product with the conflicted keys with the value “sc-tagoption-conflict-portfolioId-productId”.

Link to this function describe_record(input \\ %{}, options \\ [])

Retrieves a paginated list of the full details of a specific request. Use this operation after calling a request operation (ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct).

Link to this function describe_tag_option(input \\ %{}, options \\ [])

Describes a TagOption.

Link to this function disassociate_principal_from_portfolio(input \\ %{}, options \\ [])

Disassociates a previously associated principal ARN from a specified portfolio.

Link to this function disassociate_product_from_portfolio(input \\ %{}, options \\ [])

Disassociates the specified product from the specified portfolio.

Link to this function disassociate_tag_option_from_resource(input \\ %{}, options \\ [])

Disassociates a TagOption from a resource.

Link to this function list_accepted_portfolio_shares(input \\ %{}, options \\ [])

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

Link to this function list_constraints_for_portfolio(input \\ %{}, options \\ [])

Retrieves detailed constraint information for the specified portfolio and product.

Link to this function list_launch_paths(input \\ %{}, options \\ [])

Returns a paginated list of all paths to a specified product. A path is how the user has access to a specified product, and is necessary when provisioning a product. A path also determines the constraints put on the product.

Link to this function list_portfolio_access(input \\ %{}, options \\ [])

Lists the account IDs that have been authorized sharing of the specified portfolio.

Link to this function list_portfolios(input \\ %{}, options \\ [])

Lists all portfolios in the catalog.

Link to this function list_portfolios_for_product(input \\ %{}, options \\ [])

Lists all portfolios that the specified product is associated with.

Link to this function list_principals_for_portfolio(input \\ %{}, options \\ [])

Lists all principal ARNs associated with the specified portfolio.

Link to this function list_provisioning_artifacts(input \\ %{}, options \\ [])

Lists all provisioning artifacts associated with the specified product.

Link to this function list_record_history(input \\ %{}, options \\ [])

Returns a paginated list of all performed requests, in the form of RecordDetails objects that are filtered as specified.

Link to this function list_resources_for_tag_option(input \\ %{}, options \\ [])

Lists resources associated with a TagOption.

Link to this function list_tag_options(input \\ %{}, options \\ [])

Lists detailed TagOptions information.

Link to this function provision_product(input \\ %{}, options \\ [])

Requests a provision of a specified product. A provisioned product is a resourced instance for a product. For example, provisioning a CloudFormation-template-backed product results in launching a CloudFormation stack and all the underlying resources that come with it.

You can check the status of this request using the DescribeRecord operation. The error “Parameter validation failed: Missing required parameter in Tags[N]:Value” indicates that your request contains a tag which has a tag key but no corresponding tag value (value is empty or null). Your call may have included values returned from a DescribeProvisioningParameters call that resulted in a TagOption key with an empty list. This happens when TagOption keys are in conflict. For more information, see DescribeProvisioningParameters.

Link to this function reject_portfolio_share(input \\ %{}, options \\ [])

Rejects an offer to share a portfolio.

Link to this function scan_provisioned_products(input \\ %{}, options \\ [])

Returns a paginated list of all the ProvisionedProduct objects that are currently available (not terminated).

Link to this function search_products(input \\ %{}, options \\ [])

Returns a paginated list all of the Products objects to which the caller has access.

The output of this operation can be used as input for other operations, such as DescribeProductView.

Link to this function search_products_as_admin(input \\ %{}, options \\ [])

Retrieves summary and status information about all products created within the caller’s account. If a portfolio ID is provided, this operation retrieves information for only those products that are associated with the specified portfolio.

Link to this function terminate_provisioned_product(input \\ %{}, options \\ [])

Requests termination of an existing ProvisionedProduct object. If there are Tags associated with the object, they are terminated when the ProvisionedProduct object is terminated.

This operation does not delete any records associated with the ProvisionedProduct object.

You can check the status of this request using the DescribeRecord operation.

Link to this function update_constraint(input \\ %{}, options \\ [])

Updates an existing constraint.

Link to this function update_portfolio(input \\ %{}, options \\ [])

Updates the specified portfolio’s details. This operation does not work with a product that has been shared with you.

Link to this function update_product(input \\ %{}, options \\ [])

Updates an existing product.

Link to this function update_provisioned_product(input \\ %{}, options \\ [])

Requests updates to the configuration of an existing ProvisionedProduct object. If there are tags associated with the object, they cannot be updated or added with this operation. Depending on the specific updates requested, this operation may update with no interruption, with some interruption, or replace the ProvisionedProduct object entirely.

You can check the status of this request using the DescribeRecord operation.

Link to this function update_provisioning_artifact(input \\ %{}, options \\ [])

Updates an existing provisioning artifact’s information. This operation does not work on a provisioning artifact associated with a product that has been shared with you.

Link to this function update_tag_option(input \\ %{}, options \\ [])

Updates an existing TagOption.