baiji v0.6.0 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
Associates a product with a portfolio
Associate a TagOption identifier with a resource identifier
Creates a new constraint. For more information, see Using Constraints
Creates a new portfolio
Creates a new portfolio share
Creates a new product
Create a new provisioning artifact for the specified product. This operation does not work with a product that has been shared with you
Create a new TagOption
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
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
)
Describes a TagOption
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
Associates the specified principal ARN with the specified portfolio.
Associates a product with a portfolio.
Associate a TagOption identifier with a resource identifier.
Creates a new constraint. For more information, see Using Constraints.
Creates a new portfolio.
Creates a new product.
Create a new provisioning artifact for the specified product. This operation does not work with a product that has been shared with you.
See the bottom of this topic for an example JSON request.
Create a new TagOption.
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 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.
Retrieves detailed information and any tags associated with the specified portfolio.
Retrieves information about a specified product.
This operation is functionally identical to DescribeProductView
except
that it takes as input ProductId
instead of ProductViewId
.
Retrieves information about a specified product, run with administrator access.
Retrieves information about a specified product.
This operation is functionally identical to DescribeProduct
except that
it takes as input ProductViewId
instead of ProductId
.
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.
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
”.
Retrieves a paginated list of the full details of a specific request. Use
this operation after calling a request operation (ProvisionProduct
,
TerminateProvisionedProduct
, or UpdateProvisionedProduct
).
Describes a TagOption.
Disassociates a previously associated principal ARN from a specified portfolio.
Disassociates the specified product from the specified portfolio.
Disassociates a TagOption from a resource.
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.
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
.
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.
The output of this operation can be used as input for other operations,
such as DescribeProductView
.
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.
This operation does not delete any records associated with the ProvisionedProduct object.
You can check the status of this request using the DescribeRecord
operation.
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.
You can check the status of this request using the DescribeRecord
operation.
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.