aws-elixir v0.1.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

Retrieves information about a specified product

Retrieves information about a specified product

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)

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

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

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

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

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

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

Functions

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_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_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).

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_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.

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.

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_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.