NAME

Paws::ServiceCatalog - Perl Interface to AWS AWS Service Catalog

SYNOPSIS

  use Paws;

  my $obj = Paws->service('ServiceCatalog');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

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

• AWS Service Catalog User Guide

METHODS

AcceptPortfolioShare(PortfolioId => Str, [AcceptLanguage => Str])

Each argument is described in detail in: Paws::ServiceCatalog::AcceptPortfolioShare

Returns: a Paws::ServiceCatalog::AcceptPortfolioShareOutput instance

  Accepts an offer to share a portfolio.

AssociatePrincipalWithPortfolio(PortfolioId => Str, PrincipalARN => Str, PrincipalType => Str, [AcceptLanguage => Str])

Each argument is described in detail in: Paws::ServiceCatalog::AssociatePrincipalWithPortfolio

Returns: a Paws::ServiceCatalog::AssociatePrincipalWithPortfolioOutput instance

  Associates the specified principal ARN with the specified portfolio.

AssociateProductWithPortfolio(PortfolioId => Str, ProductId => Str, [AcceptLanguage => Str, SourcePortfolioId => Str])

Each argument is described in detail in: Paws::ServiceCatalog::AssociateProductWithPortfolio

Returns: a Paws::ServiceCatalog::AssociateProductWithPortfolioOutput instance

  Associates a product with a portfolio.

CreateConstraint(IdempotencyToken => Str, Parameters => Str, PortfolioId => Str, ProductId => Str, Type => Str, [AcceptLanguage => Str, Description => Str])

Each argument is described in detail in: Paws::ServiceCatalog::CreateConstraint

Returns: a Paws::ServiceCatalog::CreateConstraintOutput instance

  Creates a new constraint.

CreatePortfolio(DisplayName => Str, IdempotencyToken => Str, ProviderName => Str, [AcceptLanguage => Str, Description => Str, Tags => ArrayRef[Paws::ServiceCatalog::Tag]])

Each argument is described in detail in: Paws::ServiceCatalog::CreatePortfolio

Returns: a Paws::ServiceCatalog::CreatePortfolioOutput instance

  Creates a new portfolio.

CreatePortfolioShare(AccountId => Str, PortfolioId => Str, [AcceptLanguage => Str])

Each argument is described in detail in: Paws::ServiceCatalog::CreatePortfolioShare

Returns: a Paws::ServiceCatalog::CreatePortfolioShareOutput instance

  Creates a new portfolio share.

CreateProduct(IdempotencyToken => Str, Name => Str, Owner => Str, ProductType => Str, ProvisioningArtifactParameters => Paws::ServiceCatalog::ProvisioningArtifactProperties, [AcceptLanguage => Str, Description => Str, Distributor => Str, SupportDescription => Str, SupportEmail => Str, SupportUrl => Str, Tags => ArrayRef[Paws::ServiceCatalog::Tag]])

Each argument is described in detail in: Paws::ServiceCatalog::CreateProduct

Returns: a Paws::ServiceCatalog::CreateProductOutput instance

  Creates a new product.

CreateProvisioningArtifact(IdempotencyToken => Str, Parameters => Paws::ServiceCatalog::ProvisioningArtifactProperties, ProductId => Str, [AcceptLanguage => Str])

Each argument is described in detail in: Paws::ServiceCatalog::CreateProvisioningArtifact

Returns: a Paws::ServiceCatalog::CreateProvisioningArtifactOutput instance

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

DeleteConstraint(Id => Str, [AcceptLanguage => Str])

Each argument is described in detail in: Paws::ServiceCatalog::DeleteConstraint

Returns: a Paws::ServiceCatalog::DeleteConstraintOutput instance

  Deletes the specified constraint.

DeletePortfolio(Id => Str, [AcceptLanguage => Str])

Each argument is described in detail in: Paws::ServiceCatalog::DeletePortfolio

Returns: a Paws::ServiceCatalog::DeletePortfolioOutput instance

  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.

DeletePortfolioShare(AccountId => Str, PortfolioId => Str, [AcceptLanguage => Str])

Each argument is described in detail in: Paws::ServiceCatalog::DeletePortfolioShare

Returns: a Paws::ServiceCatalog::DeletePortfolioShareOutput instance

  Deletes the specified portfolio share.

DeleteProduct(Id => Str, [AcceptLanguage => Str])

Each argument is described in detail in: Paws::ServiceCatalog::DeleteProduct

Returns: a Paws::ServiceCatalog::DeleteProductOutput instance

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

DeleteProvisioningArtifact(ProductId => Str, ProvisioningArtifactId => Str, [AcceptLanguage => Str])

Each argument is described in detail in: Paws::ServiceCatalog::DeleteProvisioningArtifact

Returns: a Paws::ServiceCatalog::DeleteProvisioningArtifactOutput instance

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

DescribeConstraint(Id => Str, [AcceptLanguage => Str])

Each argument is described in detail in: Paws::ServiceCatalog::DescribeConstraint

Returns: a Paws::ServiceCatalog::DescribeConstraintOutput instance

  Retrieves detailed information for a specified constraint.

DescribePortfolio(Id => Str, [AcceptLanguage => Str])

Each argument is described in detail in: Paws::ServiceCatalog::DescribePortfolio

Returns: a Paws::ServiceCatalog::DescribePortfolioOutput instance

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

DescribeProduct(Id => Str, [AcceptLanguage => Str])

Each argument is described in detail in: Paws::ServiceCatalog::DescribeProduct

Returns: a Paws::ServiceCatalog::DescribeProductOutput instance

  Retrieves information about a specified product.

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

DescribeProductAsAdmin(Id => Str, [AcceptLanguage => Str])

Each argument is described in detail in: Paws::ServiceCatalog::DescribeProductAsAdmin

Returns: a Paws::ServiceCatalog::DescribeProductAsAdminOutput instance

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

DescribeProductView(Id => Str, [AcceptLanguage => Str])

Each argument is described in detail in: Paws::ServiceCatalog::DescribeProductView

Returns: a Paws::ServiceCatalog::DescribeProductViewOutput instance

  Retrieves information about a specified product.

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

DescribeProvisioningArtifact(ProductId => Str, ProvisioningArtifactId => Str, [AcceptLanguage => Str])

Each argument is described in detail in: Paws::ServiceCatalog::DescribeProvisioningArtifact

Returns: a Paws::ServiceCatalog::DescribeProvisioningArtifactOutput instance

  Retrieves detailed information about the specified provisioning
artifact.

DescribeProvisioningParameters(ProductId => Str, ProvisioningArtifactId => Str, [AcceptLanguage => Str, PathId => Str])

Each argument is described in detail in: Paws::ServiceCatalog::DescribeProvisioningParameters

Returns: a Paws::ServiceCatalog::DescribeProvisioningParametersOutput instance

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

DescribeRecord(Id => Str, [AcceptLanguage => Str, PageSize => Int, PageToken => Str])

Each argument is described in detail in: Paws::ServiceCatalog::DescribeRecord

Returns: a Paws::ServiceCatalog::DescribeRecordOutput instance

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

DisassociatePrincipalFromPortfolio(PortfolioId => Str, PrincipalARN => Str, [AcceptLanguage => Str])

Each argument is described in detail in: Paws::ServiceCatalog::DisassociatePrincipalFromPortfolio

Returns: a Paws::ServiceCatalog::DisassociatePrincipalFromPortfolioOutput instance

  Disassociates a previously associated principal ARN from a specified
portfolio.

DisassociateProductFromPortfolio(PortfolioId => Str, ProductId => Str, [AcceptLanguage => Str])

Each argument is described in detail in: Paws::ServiceCatalog::DisassociateProductFromPortfolio

Returns: a Paws::ServiceCatalog::DisassociateProductFromPortfolioOutput instance

  Disassociates the specified product from the specified portfolio.

ListAcceptedPortfolioShares([AcceptLanguage => Str, PageSize => Int, PageToken => Str])

Each argument is described in detail in: Paws::ServiceCatalog::ListAcceptedPortfolioShares

Returns: a Paws::ServiceCatalog::ListAcceptedPortfolioSharesOutput instance

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

ListConstraintsForPortfolio(PortfolioId => Str, [AcceptLanguage => Str, PageSize => Int, PageToken => Str, ProductId => Str])

Each argument is described in detail in: Paws::ServiceCatalog::ListConstraintsForPortfolio

Returns: a Paws::ServiceCatalog::ListConstraintsForPortfolioOutput instance

  Retrieves detailed constraint information for the specified portfolio
and product.

ListLaunchPaths(ProductId => Str, [AcceptLanguage => Str, PageSize => Int, PageToken => Str])

Each argument is described in detail in: Paws::ServiceCatalog::ListLaunchPaths

Returns: a Paws::ServiceCatalog::ListLaunchPathsOutput instance

  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.

ListPortfolioAccess(PortfolioId => Str, [AcceptLanguage => Str])

Each argument is described in detail in: Paws::ServiceCatalog::ListPortfolioAccess

Returns: a Paws::ServiceCatalog::ListPortfolioAccessOutput instance

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

ListPortfolios([AcceptLanguage => Str, PageSize => Int, PageToken => Str])

Each argument is described in detail in: Paws::ServiceCatalog::ListPortfolios

Returns: a Paws::ServiceCatalog::ListPortfoliosOutput instance

  Lists all portfolios in the catalog.

ListPortfoliosForProduct(ProductId => Str, [AcceptLanguage => Str, PageSize => Int, PageToken => Str])

Each argument is described in detail in: Paws::ServiceCatalog::ListPortfoliosForProduct

Returns: a Paws::ServiceCatalog::ListPortfoliosForProductOutput instance

  Lists all portfolios that the specified product is associated with.

ListPrincipalsForPortfolio(PortfolioId => Str, [AcceptLanguage => Str, PageSize => Int, PageToken => Str])

Each argument is described in detail in: Paws::ServiceCatalog::ListPrincipalsForPortfolio

Returns: a Paws::ServiceCatalog::ListPrincipalsForPortfolioOutput instance

  Lists all principal ARNs associated with the specified portfolio.

ListProvisioningArtifacts(ProductId => Str, [AcceptLanguage => Str])

Each argument is described in detail in: Paws::ServiceCatalog::ListProvisioningArtifacts

Returns: a Paws::ServiceCatalog::ListProvisioningArtifactsOutput instance

  Lists all provisioning artifacts associated with the specified product.

ListRecordHistory([AcceptLanguage => Str, AccessLevelFilter => Paws::ServiceCatalog::AccessLevelFilter, PageSize => Int, PageToken => Str, SearchFilter => Paws::ServiceCatalog::ListRecordHistorySearchFilter])

Each argument is described in detail in: Paws::ServiceCatalog::ListRecordHistory

Returns: a Paws::ServiceCatalog::ListRecordHistoryOutput instance

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

ProvisionProduct(ProductId => Str, ProvisionedProductName => Str, ProvisioningArtifactId => Str, ProvisionToken => Str, [AcceptLanguage => Str, NotificationArns => ArrayRef[Str|Undef], PathId => Str, ProvisioningParameters => ArrayRef[Paws::ServiceCatalog::ProvisioningParameter], Tags => ArrayRef[Paws::ServiceCatalog::Tag]])

Each argument is described in detail in: Paws::ServiceCatalog::ProvisionProduct

Returns: a Paws::ServiceCatalog::ProvisionProductOutput instance

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

RejectPortfolioShare(PortfolioId => Str, [AcceptLanguage => Str])

Each argument is described in detail in: Paws::ServiceCatalog::RejectPortfolioShare

Returns: a Paws::ServiceCatalog::RejectPortfolioShareOutput instance

  Rejects an offer to share a portfolio.

ScanProvisionedProducts([AcceptLanguage => Str, AccessLevelFilter => Paws::ServiceCatalog::AccessLevelFilter, PageSize => Int, PageToken => Str])

Each argument is described in detail in: Paws::ServiceCatalog::ScanProvisionedProducts

Returns: a Paws::ServiceCatalog::ScanProvisionedProductsOutput instance

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

SearchProducts([AcceptLanguage => Str, Filters => Paws::ServiceCatalog::ProductViewFilters, PageSize => Int, PageToken => Str, SortBy => Str, SortOrder => Str])

Each argument is described in detail in: Paws::ServiceCatalog::SearchProducts

Returns: a Paws::ServiceCatalog::SearchProductsOutput instance

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

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

SearchProductsAsAdmin([AcceptLanguage => Str, Filters => Paws::ServiceCatalog::ProductViewFilters, PageSize => Int, PageToken => Str, PortfolioId => Str, ProductSource => Str, SortBy => Str, SortOrder => Str])

Each argument is described in detail in: Paws::ServiceCatalog::SearchProductsAsAdmin

Returns: a Paws::ServiceCatalog::SearchProductsAsAdminOutput instance

  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.

TerminateProvisionedProduct(TerminateToken => Str, [AcceptLanguage => Str, IgnoreErrors => Bool, ProvisionedProductId => Str, ProvisionedProductName => Str])

Each argument is described in detail in: Paws::ServiceCatalog::TerminateProvisionedProduct

Returns: a Paws::ServiceCatalog::TerminateProvisionedProductOutput instance

  Requests termination of an existing ProvisionedProduct object. If there
are C<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.

UpdateConstraint(Id => Str, [AcceptLanguage => Str, Description => Str])

Each argument is described in detail in: Paws::ServiceCatalog::UpdateConstraint

Returns: a Paws::ServiceCatalog::UpdateConstraintOutput instance

  Updates an existing constraint.

UpdatePortfolio(Id => Str, [AcceptLanguage => Str, AddTags => ArrayRef[Paws::ServiceCatalog::Tag], Description => Str, DisplayName => Str, ProviderName => Str, RemoveTags => ArrayRef[Str|Undef]])

Each argument is described in detail in: Paws::ServiceCatalog::UpdatePortfolio

Returns: a Paws::ServiceCatalog::UpdatePortfolioOutput instance

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

UpdateProduct(Id => Str, [AcceptLanguage => Str, AddTags => ArrayRef[Paws::ServiceCatalog::Tag], Description => Str, Distributor => Str, Name => Str, Owner => Str, RemoveTags => ArrayRef[Str|Undef], SupportDescription => Str, SupportEmail => Str, SupportUrl => Str])

Each argument is described in detail in: Paws::ServiceCatalog::UpdateProduct

Returns: a Paws::ServiceCatalog::UpdateProductOutput instance

  Updates an existing product.

UpdateProvisionedProduct(UpdateToken => Str, [AcceptLanguage => Str, PathId => Str, ProductId => Str, ProvisionedProductId => Str, ProvisionedProductName => Str, ProvisioningArtifactId => Str, ProvisioningParameters => ArrayRef[Paws::ServiceCatalog::UpdateProvisioningParameter]])

Each argument is described in detail in: Paws::ServiceCatalog::UpdateProvisionedProduct

Returns: a Paws::ServiceCatalog::UpdateProvisionedProductOutput instance

  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.

UpdateProvisioningArtifact(ProductId => Str, ProvisioningArtifactId => Str, [AcceptLanguage => Str, Description => Str, Name => Str])

Each argument is described in detail in: Paws::ServiceCatalog::UpdateProvisioningArtifact

Returns: a Paws::ServiceCatalog::UpdateProvisioningArtifactOutput instance

  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.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues

cpanm Paws::SDK::Config

perl -MCPAN -e shell
install Paws::SDK::Config