aws-elixir

v0.4.0

aws-elixir v0.4.0 AWS.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, you need to 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)

Summary

Functions

accept_portfolio_share(client, input, options \\ [])

Accepts an offer to share a portfolio

associate_principal_with_portfolio(client, input, options \\ [])

Associates the specified principal ARN with the specified portfolio

associate_product_with_portfolio(client, input, options \\ [])

Associates a product with a portfolio

create_constraint(client, input, options \\ [])

Creates a new constraint

create_portfolio(client, input, options \\ [])

Creates a new portfolio

create_portfolio_share(client, input, options \\ [])

Creates a new portfolio share

create_product(client, input, options \\ [])

Creates a new product

create_provisioning_artifact(client, input, options \\ [])

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

delete_constraint(client, input, options \\ [])

Deletes the specified constraint

delete_portfolio(client, input, options \\ [])

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

delete_portfolio_share(client, input, options \\ [])

Deletes the specified portfolio share

delete_product(client, input, options \\ [])

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

delete_provisioning_artifact(client, input, options \\ [])

Deletes the specified provisioning artifact. This operation will 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)

describe_constraint(client, input, options \\ [])

Retrieves detailed information for a specified constraint

describe_portfolio(client, input, options \\ [])

Retrieves detailed information and any tags associated with the specified portfolio

describe_product(client, input, options \\ [])

Retrieves information about a specified product

describe_product_as_admin(client, input, options \\ [])

Retrieves information about a specified product, run with administrator access

describe_product_view(client, input, options \\ [])

Retrieves information about a specified product

describe_provisioning_artifact(client, input, options \\ [])

Retrieves detailed information about the specified provisioning artifact

describe_provisioning_parameters(client, 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

describe_record(client, 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)

disassociate_principal_from_portfolio(client, input, options \\ [])

Disassociates a previously associated principal ARN from a specified portfolio

disassociate_product_from_portfolio(client, input, options \\ [])

Disassociates the specified product from the specified portfolio

list_accepted_portfolio_shares(client, input, options \\ [])

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

list_constraints_for_portfolio(client, input, options \\ [])

Retrieves detailed constraint information for the specified portfolio and product

list_launch_paths(client, 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

list_portfolio_access(client, input, options \\ [])

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

list_portfolios(client, input, options \\ [])

Lists all portfolios in the catalog

list_portfolios_for_product(client, input, options \\ [])

Lists all portfolios that the specified product is associated with

list_principals_for_portfolio(client, input, options \\ [])

Lists all principal ARNs associated with the specified portfolio

list_provisioning_artifacts(client, input, options \\ [])

Lists all provisioning artifacts associated with the specified product

list_record_history(client, input, options \\ [])

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

provision_product(client, input, options \\ [])

Requests a Provision of a specified product. A ProvisionedProduct 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

reject_portfolio_share(client, input, options \\ [])

Rejects an offer to share a portfolio

scan_provisioned_products(client, input, options \\ [])

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

search_products(client, input, options \\ [])

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

search_products_as_admin(client, 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

terminate_provisioned_product(client, 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

update_constraint(client, input, options \\ [])

Updates an existing constraint

update_portfolio(client, input, options \\ [])

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

update_product(client, input, options \\ [])

Updates an existing product

update_provisioned_product(client, 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

update_provisioning_artifact(client, input, options \\ [])

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

Functions

accept_portfolio_share(client, input, options \\ [])

Accepts an offer to share a portfolio.

associate_principal_with_portfolio(client, input, options \\ [])

Associates the specified principal ARN with the specified portfolio.

associate_product_with_portfolio(client, input, options \\ [])

Associates a product with a portfolio.

create_constraint(client, input, options \\ [])

Creates a new constraint.

create_portfolio(client, input, options \\ [])

Creates a new portfolio.

create_portfolio_share(client, input, options \\ [])

Creates a new portfolio share.

create_product(client, input, options \\ [])

Creates a new product.

create_provisioning_artifact(client, input, options \\ [])

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

delete_constraint(client, input, options \\ [])

Deletes the specified constraint.

delete_portfolio(client, input, options \\ [])

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

delete_portfolio_share(client, input, options \\ [])

Deletes the specified portfolio share.

delete_product(client, input, options \\ [])

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

delete_provisioning_artifact(client, input, options \\ [])

Deletes the specified provisioning artifact. This operation will 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).

describe_constraint(client, input, options \\ [])

Retrieves detailed information for a specified constraint.

describe_portfolio(client, input, options \\ [])

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

describe_product(client, 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.

describe_product_as_admin(client, input, options \\ [])

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

describe_product_view(client, 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.

describe_provisioning_artifact(client, input, options \\ [])

Retrieves detailed information about the specified provisioning artifact.

describe_provisioning_parameters(client, 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.

describe_record(client, 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).

disassociate_principal_from_portfolio(client, input, options \\ [])

Disassociates a previously associated principal ARN from a specified portfolio.

disassociate_product_from_portfolio(client, input, options \\ [])

Disassociates the specified product from the specified portfolio.

list_accepted_portfolio_shares(client, input, options \\ [])

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

list_constraints_for_portfolio(client, input, options \\ [])

Retrieves detailed constraint information for the specified portfolio and product.

list_launch_paths(client, 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.

list_portfolio_access(client, input, options \\ [])

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

list_portfolios(client, input, options \\ [])

Lists all portfolios in the catalog.

list_portfolios_for_product(client, input, options \\ [])

Lists all portfolios that the specified product is associated with.

list_principals_for_portfolio(client, input, options \\ [])

Lists all principal ARNs associated with the specified portfolio.

list_provisioning_artifacts(client, input, options \\ [])

Lists all provisioning artifacts associated with the specified product.

list_record_history(client, input, options \\ [])

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

provision_product(client, input, options \\ [])

Requests a Provision of a specified product. A ProvisionedProduct 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.

reject_portfolio_share(client, input, options \\ [])

Rejects an offer to share a portfolio.

scan_provisioned_products(client, input, options \\ [])

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

search_products(client, 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.

search_products_as_admin(client, 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.

terminate_provisioned_product(client, 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.

update_constraint(client, input, options \\ [])

Updates an existing constraint.

update_portfolio(client, input, options \\ [])

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

update_product(client, input, options \\ [])

Updates an existing product.

update_provisioned_product(client, 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.

update_provisioning_artifact(client, input, options \\ [])

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