AWS.ServiceCatalog (aws-elixir v0.8.0) View Source

AWS Service Catalog

AWS Service Catalog enables organizations to create and manage catalogs of IT services that are approved for AWS.

To get the most out of this documentation, you should be familiar with the terminology discussed in AWS Service Catalog Concepts.

Link to this section Summary

Functions

Accepts an offer to share the specified portfolio.

Associates the specified budget with the specified resource.

Associates the specified principal ARN with the specified portfolio.

Associates the specified product with the specified portfolio.

Associates a self-service action with a provisioning artifact.

Associate the specified TagOption with the specified portfolio or product.

Associates multiple self-service actions with provisioning artifacts.

Disassociates a batch of self-service actions from the specified provisioning artifact.

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

Shares the specified portfolio with the specified account or organization node.

Creates a provisioning artifact (also known as a version) for the specified product.

Deletes the specified constraint.

Deletes the specified portfolio.

Stops sharing the specified portfolio with the specified account or organization node.

Deletes the specified product.

Deletes the specified provisioning artifact (also known as a version) for the specified product.

Deletes the specified TagOption.

Gets information about the specified constraint.

Gets the status of the specified copy product operation.

Gets information about the specified portfolio.

Gets the status of the specified portfolio share operation.

Returns a summary of each of the portfolio shares that were created for the specified portfolio.

Gets information about the specified product.

Gets information about the specified product.

Gets information about the specified product.

Gets information about the specified provisioned product.

Gets information about the resource changes for the specified plan.

Gets information about the specified provisioning artifact (also known as a version) for the specified product.

Gets information about the configuration required to provision the specified product using the specified provisioning artifact.

Gets information about the specified request operation.

Finds the default parameters for a specific self-service action on a specific provisioned product and returns a map of the results to the user.

Gets information about the specified TagOption.

Disable portfolio sharing through AWS Organizations feature.

Disassociates the specified budget from the specified resource.

Disassociates a previously associated principal ARN from a specified portfolio.

Disassociates the specified product from the specified portfolio.

Disassociates the specified self-service action association from the specified provisioning artifact.

Disassociates the specified TagOption from the specified resource.

Enable portfolio sharing feature through AWS Organizations.

Provisions or modifies a product based on the resource changes for the specified plan.

Executes a self-service action against a provisioned product.

Get the Access Status for AWS Organization portfolio share feature.

This API takes either a ProvisonedProductId or a ProvisionedProductName, along with a list of one or more output keys, and responds with the key/value pairs of those outputs.

Requests the import of a resource as a Service Catalog provisioned product that is associated to a Service Catalog product and provisioning artifact.

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

Lists all the budgets associated to the specified resource.

Lists the constraints for the specified portfolio and product.

Lists the paths to the specified product.

Lists the organization nodes that have access to the specified portfolio.

Lists the account IDs that have access to 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 the plans for the specified provisioned product or all plans to which the user has access.

Lists all provisioning artifacts (also known as versions) for the specified product.

Lists all provisioning artifacts (also known as versions) for the specified self-service action.

Lists the specified requests or all performed requests.

Lists the resources associated with the specified TagOption.

Lists all self-service actions.

Returns a paginated list of self-service actions associated with the specified Product ID and Provisioning Artifact ID.

Returns summary information about stack instances that are associated with the specified CFN_STACKSET type provisioned product.

Lists the specified TagOptions or all TagOptions.

Provisions the specified product.

Rejects an offer to share the specified portfolio.

Lists the provisioned products that are available (not terminated).

Gets information about the products to which the caller has access.

Gets information about the products for the specified portfolio or all products.

Gets information about the provisioned products that meet the specified criteria.

Terminates the specified provisioned product.

Updates the specified constraint.

Updates the specified portfolio.

Updates the specified portfolio share.

Updates the specified product.

Requests updates to the configuration of the specified provisioned product.

Requests updates to the properties of the specified provisioned product.

Updates the specified provisioning artifact (also known as a version) for the specified product.

Updates the specified TagOption.

Link to this section Functions

Link to this function

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

View Source

Accepts an offer to share the specified portfolio.

Link to this function

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

View Source

Associates the specified budget with the specified resource.

Link to this function

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

View Source

Associates the specified principal ARN with the specified portfolio.

Link to this function

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

View Source

Associates the specified product with the specified portfolio.

A delegated admin is authorized to invoke this command.

Link to this function

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

View Source

Associates a self-service action with a provisioning artifact.

Link to this function

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

View Source

Associate the specified TagOption with the specified portfolio or product.

Link to this function

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

View Source

Associates multiple self-service actions with provisioning artifacts.

Link to this function

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

View Source

Disassociates a batch of self-service actions from the specified provisioning artifact.

Link to this function

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

View Source

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

You can copy a product to the same account or another account. You can copy a 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(client, input, options \\ [])

View Source

Creates a constraint.

A delegated admin is authorized to invoke this command.

Link to this function

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

View Source

Creates a portfolio.

A delegated admin is authorized to invoke this command.

Link to this function

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

View Source

Shares the specified portfolio with the specified account or organization node.

Shares to an organization node can only be created by the management account of an organization or by a delegated administrator. You can share portfolios to an organization, an organizational unit, or a specific account.

Note that if a delegated admin is de-registered, they can no longer create portfolio shares.

AWSOrganizationsAccess must be enabled in order to create a portfolio share to an organization node.

You can't share a shared resource, including portfolios that contain a shared product.

If the portfolio share with the specified account or organization node already exists, this action will have no effect and will not return an error. To update an existing share, you must use the UpdatePortfolioShare API instead.

Link to this function

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

View Source

Creates a product.

A delegated admin is authorized to invoke this command.

The user or role that performs this operation must have the cloudformation:GetTemplate IAM policy permission. This policy permission is required when using the ImportFromPhysicalId template source in the information data section.

Link to this function

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

View Source

Creates a plan.

A plan includes the list of resources to be created (when provisioning a new product) or modified (when updating a provisioned product) when the plan is executed.

You can create one plan per provisioned product. To create a plan for an existing provisioned product, the product status must be AVAILBLE or TAINTED.

To view the resource changes in the change set, use DescribeProvisionedProductPlan. To create or modify the provisioned product, use ExecuteProvisionedProductPlan.

Link to this function

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

View Source

Creates a provisioning artifact (also known as a version) for the specified product.

You cannot create a provisioning artifact for a product that was shared with you.

The user or role that performs this operation must have the cloudformation:GetTemplate IAM policy permission. This policy permission is required when using the ImportFromPhysicalId template source in the information data section.

Link to this function

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

View Source

Creates a self-service action.

Link to this function

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

View Source

Creates a TagOption.

Link to this function

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

View Source

Deletes the specified constraint.

A delegated admin is authorized to invoke this command.

Link to this function

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

View Source

Deletes the specified portfolio.

You cannot delete a portfolio if it was shared with you or if it has associated products, users, constraints, or shared accounts.

A delegated admin is authorized to invoke this command.

Link to this function

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

View Source

Stops sharing the specified portfolio with the specified account or organization node.

Shares to an organization node can only be deleted by the management account of an organization or by a delegated administrator.

Note that if a delegated admin is de-registered, portfolio shares created from that account are removed.

Link to this function

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

View Source

Deletes the specified product.

You cannot delete a product if it was shared with you or is associated with a portfolio.

A delegated admin is authorized to invoke this command.

Link to this function

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

View Source

Deletes the specified plan.

Link to this function

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

View Source

Deletes the specified provisioning artifact (also known as a version) for the specified product.

You cannot delete a provisioning artifact associated with a product that was shared with you. You cannot delete the last provisioning artifact for a product, because a product must have at least one provisioning artifact.

Link to this function

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

View Source

Deletes a self-service action.

Link to this function

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

View Source

Deletes the specified TagOption.

You cannot delete a TagOption if it is associated with a product or portfolio.

Link to this function

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

View Source

Gets information about the specified constraint.

Link to this function

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

View Source

Gets the status of the specified copy product operation.

Link to this function

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

View Source

Gets information about the specified portfolio.

A delegated admin is authorized to invoke this command.

Link to this function

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

View Source

Gets the status of the specified portfolio share operation.

This API can only be called by the management account in the organization or by a delegated admin.

Link to this function

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

View Source

Returns a summary of each of the portfolio shares that were created for the specified portfolio.

You can use this API to determine which accounts or organizational nodes this portfolio have been shared, whether the recipient entity has imported the share, and whether TagOptions are included with the share.

The PortfolioId and Type parameters are both required.

Link to this function

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

View Source

Gets information about the specified product.

Link to this function

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

View Source

Gets information about the specified product.

This operation is run with administrator access.

Link to this function

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

View Source

Gets information about the specified product.

Link to this function

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

View Source

Gets information about the specified provisioned product.

Link to this function

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

View Source

Gets information about the resource changes for the specified plan.

Link to this function

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

View Source

Gets information about the specified provisioning artifact (also known as a version) for the specified product.

Link to this function

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

View Source

Gets information about the configuration required to provision the specified product using the specified provisioning artifact.

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 ProvisionProduct, do not include conflicted TagOption keys as tags, or this causes the error "Parameter validation failed: Missing required parameter in Tags[N]:Value". Tag the provisioned product with the value sc-tagoption-conflict-portfolioId-productId.

Link to this function

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

View Source

Gets information about the specified request operation.

Use this operation after calling a request operation (for example, ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct).

If a provisioned product was transferred to a new owner using UpdateProvisionedProductProperties, the new owner will be able to describe all past records for that product. The previous owner will no longer be able to describe the records, but will be able to use ListRecordHistory to see the product's history from when he was the owner.

Link to this function

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

View Source

Describes a self-service action.

Link to this function

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

View Source

Finds the default parameters for a specific self-service action on a specific provisioned product and returns a map of the results to the user.

Link to this function

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

View Source

Gets information about the specified TagOption.

Link to this function

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

View Source

Disable portfolio sharing through AWS Organizations feature.

This feature will not delete your current shares but it will prevent you from creating new shares throughout your organization. Current shares will not be in sync with your organization structure if it changes after calling this API. This API can only be called by the management account in the organization.

This API can't be invoked if there are active delegated administrators in the organization.

Note that a delegated administrator is not authorized to invoke DisableAWSOrganizationsAccess.

Link to this function

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

View Source

Disassociates the specified budget from the specified resource.

Link to this function

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

View Source

Disassociates a previously associated principal ARN from a specified portfolio.

Link to this function

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

View Source

Disassociates the specified product from the specified portfolio.

A delegated admin is authorized to invoke this command.

Link to this function

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

View Source

Disassociates the specified self-service action association from the specified provisioning artifact.

Link to this function

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

View Source

Disassociates the specified TagOption from the specified resource.

Link to this function

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

View Source

Enable portfolio sharing feature through AWS Organizations.

This API will allow Service Catalog to receive updates on your organization in order to sync your shares with the current structure. This API can only be called by the management account in the organization.

By calling this API Service Catalog will make a call to organizations:EnableAWSServiceAccess on your behalf so that your shares can be in sync with any changes in your AWS Organizations structure.

Note that a delegated administrator is not authorized to invoke EnableAWSOrganizationsAccess.

Link to this function

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

View Source

Provisions or modifies a product based on the resource changes for the specified plan.

Link to this function

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

View Source

Executes a self-service action against a provisioned product.

Link to this function

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

View Source

Get the Access Status for AWS Organization portfolio share feature.

This API can only be called by the management account in the organization or by a delegated admin.

Link to this function

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

View Source

This API takes either a ProvisonedProductId or a ProvisionedProductName, along with a list of one or more output keys, and responds with the key/value pairs of those outputs.

Link to this function

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

View Source

Requests the import of a resource as a Service Catalog provisioned product that is associated to a Service Catalog product and provisioning artifact.

Once imported, all supported Service Catalog governance actions are supported on the provisioned product.

Resource import only supports CloudFormation stack ARNs. CloudFormation StackSets and non-root nested stacks are not supported.

The CloudFormation stack must have one of the following statuses to be imported: CREATE_COMPLETE, UPDATE_COMPLETE, UPDATE_ROLLBACK_COMPLETE, IMPORT_COMPLETE, IMPORT_ROLLBACK_COMPLETE.

Import of the resource requires that the CloudFormation stack template matches the associated Service Catalog product provisioning artifact.

The user or role that performs this operation must have the cloudformation:GetTemplate and cloudformation:DescribeStacks IAM policy permissions.

Link to this function

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

View Source

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

Link to this function

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

View Source

Lists all the budgets associated to the specified resource.

Link to this function

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

View Source

Lists the constraints for the specified portfolio and product.

Link to this function

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

View Source

Lists the paths to the 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_organization_portfolio_access(client, input, options \\ [])

View Source

Lists the organization nodes that have access to the specified portfolio.

This API can only be called by the management account in the organization or by a delegated admin.

If a delegated admin is de-registered, they can no longer perform this operation.

Link to this function

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

View Source

Lists the account IDs that have access to the specified portfolio.

A delegated admin can list the accounts that have access to the shared portfolio. Note that if a delegated admin is de-registered, they can no longer perform this operation.

Link to this function

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

View Source

Lists all portfolios in the catalog.

Link to this function

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

View Source

Lists all portfolios that the specified product is associated with.

Link to this function

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

View Source

Lists all principal ARNs associated with the specified portfolio.

Link to this function

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

View Source

Lists the plans for the specified provisioned product or all plans to which the user has access.

Link to this function

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

View Source

Lists all provisioning artifacts (also known as versions) for the specified product.

Link to this function

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

View Source

Lists all provisioning artifacts (also known as versions) for the specified self-service action.

Link to this function

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

View Source

Lists the specified requests or all performed requests.

Link to this function

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

View Source

Lists the resources associated with the specified TagOption.

Link to this function

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

View Source

Lists all self-service actions.

Link to this function

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

View Source

Returns a paginated list of self-service actions associated with the specified Product ID and Provisioning Artifact ID.

Link to this function

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

View Source

Returns summary information about stack instances that are associated with the specified CFN_STACKSET type provisioned product.

You can filter for stack instances that are associated with a specific AWS account name or region.

Link to this function

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

View Source

Lists the specified TagOptions or all TagOptions.

Link to this function

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

View Source

Provisions the specified product.

A provisioned product is a resourced instance of a product. For example, provisioning a product based on a CloudFormation template launches a CloudFormation stack and its underlying resources. You can check the status of this request using DescribeRecord.

If the request contains a tag key with an empty list of values, there is a tag conflict for that key. Do not include conflicted keys as tags, or this causes the error "Parameter validation failed: Missing required parameter in Tags[N]:Value".

Link to this function

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

View Source

Rejects an offer to share the specified portfolio.

Link to this function

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

View Source

Lists the provisioned products that are available (not terminated).

To use additional filtering, see SearchProvisionedProducts.

Link to this function

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

View Source

Gets information about the products to which the caller has access.

Link to this function

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

View Source

Gets information about the products for the specified portfolio or all products.

Link to this function

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

View Source

Gets information about the provisioned products that meet the specified criteria.

Link to this function

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

View Source

Terminates the specified provisioned product.

This operation does not delete any records associated with the provisioned product.

You can check the status of this request using DescribeRecord.

Link to this function

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

View Source

Updates the specified constraint.

Link to this function

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

View Source

Updates the specified portfolio.

You cannot update a product that was shared with you.

Link to this function

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

View Source

Updates the specified portfolio share.

You can use this API to enable or disable TagOptions sharing for an existing portfolio share.

The portfolio share cannot be updated if the CreatePortfolioShare operation is IN_PROGRESS, as the share is not available to recipient entities. In this case, you must wait for the portfolio share to be COMPLETED.

You must provide the accountId or organization node in the input, but not both.

If the portfolio is shared to both an external account and an organization node, and both shares need to be updated, you must invoke UpdatePortfolioShare separately for each share type.

This API cannot be used for removing the portfolio share. You must use DeletePortfolioShare API for that action.

Link to this function

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

View Source

Updates the specified product.

Link to this function

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

View Source

Requests updates to the configuration of the specified provisioned product.

If there are tags associated with the object, they cannot be updated or added. Depending on the specific updates requested, this operation can update with no interruption, with some interruption, or replace the provisioned product entirely.

You can check the status of this request using DescribeRecord.

Link to this function

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

View Source

Requests updates to the properties of the specified provisioned product.

Link to this function

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

View Source

Updates the specified provisioning artifact (also known as a version) for the specified product.

You cannot update a provisioning artifact for a product that was shared with you.

Link to this function

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

View Source

Updates a self-service action.

Link to this function

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

View Source

Updates the specified TagOption.