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
AWS Service Catalog (https://aws.amazon.com/servicecatalog/) 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 (http://docs.aws.amazon.com/servicecatalog/latest/adminguide/what-is_concepts.html).
For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10
METHODS
AcceptPortfolioShare
Each argument is described in detail in: Paws::ServiceCatalog::AcceptPortfolioShare
Returns: a Paws::ServiceCatalog::AcceptPortfolioShareOutput instance
Accepts an offer to share the specified portfolio.
AssociateBudgetWithResource
Each argument is described in detail in: Paws::ServiceCatalog::AssociateBudgetWithResource
Returns: a Paws::ServiceCatalog::AssociateBudgetWithResourceOutput instance
Associates the specified budget with the specified resource.
AssociatePrincipalWithPortfolio
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
Each argument is described in detail in: Paws::ServiceCatalog::AssociateProductWithPortfolio
Returns: a Paws::ServiceCatalog::AssociateProductWithPortfolioOutput instance
Associates the specified product with the specified portfolio.
A delegated admin is authorized to invoke this command.
AssociateServiceActionWithProvisioningArtifact
Each argument is described in detail in: Paws::ServiceCatalog::AssociateServiceActionWithProvisioningArtifact
Returns: a Paws::ServiceCatalog::AssociateServiceActionWithProvisioningArtifactOutput instance
Associates a self-service action with a provisioning artifact.
AssociateTagOptionWithResource
Each argument is described in detail in: Paws::ServiceCatalog::AssociateTagOptionWithResource
Returns: a Paws::ServiceCatalog::AssociateTagOptionWithResourceOutput instance
Associate the specified TagOption with the specified portfolio or product.
BatchAssociateServiceActionWithProvisioningArtifact
- ServiceActionAssociations => ArrayRef[Paws::ServiceCatalog::ServiceActionAssociation]
- [AcceptLanguage => Str]
Each argument is described in detail in: Paws::ServiceCatalog::BatchAssociateServiceActionWithProvisioningArtifact
Returns: a Paws::ServiceCatalog::BatchAssociateServiceActionWithProvisioningArtifactOutput instance
Associates multiple self-service actions with provisioning artifacts.
BatchDisassociateServiceActionFromProvisioningArtifact
- ServiceActionAssociations => ArrayRef[Paws::ServiceCatalog::ServiceActionAssociation]
- [AcceptLanguage => Str]
Each argument is described in detail in: Paws::ServiceCatalog::BatchDisassociateServiceActionFromProvisioningArtifact
Returns: a Paws::ServiceCatalog::BatchDisassociateServiceActionFromProvisioningArtifactOutput instance
Disassociates a batch of self-service actions from the specified provisioning artifact.
CopyProduct
- IdempotencyToken => Str
- SourceProductArn => Str
- [AcceptLanguage => Str]
- [CopyOptions => ArrayRef[Str|Undef]]
- [SourceProvisioningArtifactIdentifiers => ArrayRef[Paws::ServiceCatalog::SourceProvisioningArtifactPropertiesMap]]
- [TargetProductId => Str]
- [TargetProductName => Str]
Each argument is described in detail in: Paws::ServiceCatalog::CopyProduct
Returns: a Paws::ServiceCatalog::CopyProductOutput instance
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.
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 constraint.
A delegated admin is authorized to invoke this command.
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 portfolio.
A delegated admin is authorized to invoke this command.
CreatePortfolioShare
- PortfolioId => Str
- [AcceptLanguage => Str]
- [AccountId => Str]
- [OrganizationNode => Paws::ServiceCatalog::OrganizationNode]
Each argument is described in detail in: Paws::ServiceCatalog::CreatePortfolioShare
Returns: a Paws::ServiceCatalog::CreatePortfolioShareOutput instance
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.
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 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.
CreateProvisionedProductPlan
- IdempotencyToken => Str
- PlanName => Str
- PlanType => Str
- ProductId => Str
- ProvisionedProductName => Str
- ProvisioningArtifactId => Str
- [AcceptLanguage => Str]
- [NotificationArns => ArrayRef[Str|Undef]]
- [PathId => Str]
- [ProvisioningParameters => ArrayRef[Paws::ServiceCatalog::UpdateProvisioningParameter]]
- [Tags => ArrayRef[Paws::ServiceCatalog::Tag]]
Each argument is described in detail in: Paws::ServiceCatalog::CreateProvisionedProductPlan
Returns: a Paws::ServiceCatalog::CreateProvisionedProductPlanOutput instance
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.
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
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.
CreateServiceAction
- Definition => Paws::ServiceCatalog::ServiceActionDefinitionMap
- DefinitionType => Str
- IdempotencyToken => Str
- Name => Str
- [AcceptLanguage => Str]
- [Description => Str]
Each argument is described in detail in: Paws::ServiceCatalog::CreateServiceAction
Returns: a Paws::ServiceCatalog::CreateServiceActionOutput instance
Creates a self-service action.
CreateTagOption
Each argument is described in detail in: Paws::ServiceCatalog::CreateTagOption
Returns: a Paws::ServiceCatalog::CreateTagOptionOutput instance
Creates a TagOption.
DeleteConstraint
Each argument is described in detail in: Paws::ServiceCatalog::DeleteConstraint
Returns: a Paws::ServiceCatalog::DeleteConstraintOutput instance
Deletes the specified constraint.
A delegated admin is authorized to invoke this command.
DeletePortfolio
Each argument is described in detail in: Paws::ServiceCatalog::DeletePortfolio
Returns: a Paws::ServiceCatalog::DeletePortfolioOutput instance
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.
DeletePortfolioShare
- PortfolioId => Str
- [AcceptLanguage => Str]
- [AccountId => Str]
- [OrganizationNode => Paws::ServiceCatalog::OrganizationNode]
Each argument is described in detail in: Paws::ServiceCatalog::DeletePortfolioShare
Returns: a Paws::ServiceCatalog::DeletePortfolioShareOutput instance
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.
DeleteProduct
Each argument is described in detail in: Paws::ServiceCatalog::DeleteProduct
Returns: a Paws::ServiceCatalog::DeleteProductOutput instance
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.
DeleteProvisionedProductPlan
Each argument is described in detail in: Paws::ServiceCatalog::DeleteProvisionedProductPlan
Returns: a Paws::ServiceCatalog::DeleteProvisionedProductPlanOutput instance
Deletes the specified plan.
DeleteProvisioningArtifact
Each argument is described in detail in: Paws::ServiceCatalog::DeleteProvisioningArtifact
Returns: a Paws::ServiceCatalog::DeleteProvisioningArtifactOutput instance
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.
DeleteServiceAction
Each argument is described in detail in: Paws::ServiceCatalog::DeleteServiceAction
Returns: a Paws::ServiceCatalog::DeleteServiceActionOutput instance
Deletes a self-service action.
DeleteTagOption
Each argument is described in detail in: Paws::ServiceCatalog::DeleteTagOption
Returns: a Paws::ServiceCatalog::DeleteTagOptionOutput instance
Deletes the specified TagOption.
You cannot delete a TagOption if it is associated with a product or portfolio.
DescribeConstraint
Each argument is described in detail in: Paws::ServiceCatalog::DescribeConstraint
Returns: a Paws::ServiceCatalog::DescribeConstraintOutput instance
Gets information about the specified constraint.
DescribeCopyProductStatus
Each argument is described in detail in: Paws::ServiceCatalog::DescribeCopyProductStatus
Returns: a Paws::ServiceCatalog::DescribeCopyProductStatusOutput instance
Gets the status of the specified copy product operation.
DescribePortfolio
Each argument is described in detail in: Paws::ServiceCatalog::DescribePortfolio
Returns: a Paws::ServiceCatalog::DescribePortfolioOutput instance
Gets information about the specified portfolio.
A delegated admin is authorized to invoke this command.
DescribePortfolioShares
Each argument is described in detail in: Paws::ServiceCatalog::DescribePortfolioShares
Returns: a Paws::ServiceCatalog::DescribePortfolioSharesOutput instance
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.
DescribePortfolioShareStatus
Each argument is described in detail in: Paws::ServiceCatalog::DescribePortfolioShareStatus
Returns: a Paws::ServiceCatalog::DescribePortfolioShareStatusOutput instance
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.
DescribeProduct
Each argument is described in detail in: Paws::ServiceCatalog::DescribeProduct
Returns: a Paws::ServiceCatalog::DescribeProductOutput instance
Gets information about the specified product.
DescribeProductAsAdmin
Each argument is described in detail in: Paws::ServiceCatalog::DescribeProductAsAdmin
Returns: a Paws::ServiceCatalog::DescribeProductAsAdminOutput instance
Gets information about the specified product. This operation is run with administrator access.
DescribeProductView
Each argument is described in detail in: Paws::ServiceCatalog::DescribeProductView
Returns: a Paws::ServiceCatalog::DescribeProductViewOutput instance
Gets information about the specified product.
DescribeProvisionedProduct
Each argument is described in detail in: Paws::ServiceCatalog::DescribeProvisionedProduct
Returns: a Paws::ServiceCatalog::DescribeProvisionedProductOutput instance
Gets information about the specified provisioned product.
DescribeProvisionedProductPlan
Each argument is described in detail in: Paws::ServiceCatalog::DescribeProvisionedProductPlan
Returns: a Paws::ServiceCatalog::DescribeProvisionedProductPlanOutput instance
Gets information about the resource changes for the specified plan.
DescribeProvisioningArtifact
- [AcceptLanguage => Str]
- [ProductId => Str]
- [ProductName => Str]
- [ProvisioningArtifactId => Str]
- [ProvisioningArtifactName => Str]
- [Verbose => Bool]
Each argument is described in detail in: Paws::ServiceCatalog::DescribeProvisioningArtifact
Returns: a Paws::ServiceCatalog::DescribeProvisioningArtifactOutput instance
Gets information about the specified provisioning artifact (also known as a version) for the specified product.
DescribeProvisioningParameters
- [AcceptLanguage => Str]
- [PathId => Str]
- [PathName => Str]
- [ProductId => Str]
- [ProductName => Str]
- [ProvisioningArtifactId => Str]
- [ProvisioningArtifactName => Str]
Each argument is described in detail in: Paws::ServiceCatalog::DescribeProvisioningParameters
Returns: a Paws::ServiceCatalog::DescribeProvisioningParametersOutput instance
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
.
DescribeRecord
Each argument is described in detail in: Paws::ServiceCatalog::DescribeRecord
Returns: a Paws::ServiceCatalog::DescribeRecordOutput instance
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.
DescribeServiceAction
Each argument is described in detail in: Paws::ServiceCatalog::DescribeServiceAction
Returns: a Paws::ServiceCatalog::DescribeServiceActionOutput instance
Describes a self-service action.
DescribeServiceActionExecutionParameters
Each argument is described in detail in: Paws::ServiceCatalog::DescribeServiceActionExecutionParameters
Returns: a Paws::ServiceCatalog::DescribeServiceActionExecutionParametersOutput instance
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.
DescribeTagOption
Each argument is described in detail in: Paws::ServiceCatalog::DescribeTagOption
Returns: a Paws::ServiceCatalog::DescribeTagOptionOutput instance
Gets information about the specified TagOption.
DisableAWSOrganizationsAccess
Each argument is described in detail in: Paws::ServiceCatalog::DisableAWSOrganizationsAccess
Returns: a Paws::ServiceCatalog::DisableAWSOrganizationsAccessOutput instance
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
.
DisassociateBudgetFromResource
Each argument is described in detail in: Paws::ServiceCatalog::DisassociateBudgetFromResource
Returns: a Paws::ServiceCatalog::DisassociateBudgetFromResourceOutput instance
Disassociates the specified budget from the specified resource.
DisassociatePrincipalFromPortfolio
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
Each argument is described in detail in: Paws::ServiceCatalog::DisassociateProductFromPortfolio
Returns: a Paws::ServiceCatalog::DisassociateProductFromPortfolioOutput instance
Disassociates the specified product from the specified portfolio.
A delegated admin is authorized to invoke this command.
DisassociateServiceActionFromProvisioningArtifact
Each argument is described in detail in: Paws::ServiceCatalog::DisassociateServiceActionFromProvisioningArtifact
Returns: a Paws::ServiceCatalog::DisassociateServiceActionFromProvisioningArtifactOutput instance
Disassociates the specified self-service action association from the specified provisioning artifact.
DisassociateTagOptionFromResource
Each argument is described in detail in: Paws::ServiceCatalog::DisassociateTagOptionFromResource
Returns: a Paws::ServiceCatalog::DisassociateTagOptionFromResourceOutput instance
Disassociates the specified TagOption from the specified resource.
EnableAWSOrganizationsAccess
Each argument is described in detail in: Paws::ServiceCatalog::EnableAWSOrganizationsAccess
Returns: a Paws::ServiceCatalog::EnableAWSOrganizationsAccessOutput instance
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
.
ExecuteProvisionedProductPlan
Each argument is described in detail in: Paws::ServiceCatalog::ExecuteProvisionedProductPlan
Returns: a Paws::ServiceCatalog::ExecuteProvisionedProductPlanOutput instance
Provisions or modifies a product based on the resource changes for the specified plan.
ExecuteProvisionedProductServiceAction
- ExecuteToken => Str
- ProvisionedProductId => Str
- ServiceActionId => Str
- [AcceptLanguage => Str]
- [Parameters => Paws::ServiceCatalog::ExecutionParameterMap]
Each argument is described in detail in: Paws::ServiceCatalog::ExecuteProvisionedProductServiceAction
Returns: a Paws::ServiceCatalog::ExecuteProvisionedProductServiceActionOutput instance
Executes a self-service action against a provisioned product.
GetAWSOrganizationsAccessStatus
Each argument is described in detail in: Paws::ServiceCatalog::GetAWSOrganizationsAccessStatus
Returns: a Paws::ServiceCatalog::GetAWSOrganizationsAccessStatusOutput instance
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.
GetProvisionedProductOutputs
- [AcceptLanguage => Str]
- [OutputKeys => ArrayRef[Str|Undef]]
- [PageSize => Int]
- [PageToken => Str]
- [ProvisionedProductId => Str]
- [ProvisionedProductName => Str]
Each argument is described in detail in: Paws::ServiceCatalog::GetProvisionedProductOutputs
Returns: a Paws::ServiceCatalog::GetProvisionedProductOutputsOutput instance
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.
ImportAsProvisionedProduct
- IdempotencyToken => Str
- PhysicalId => Str
- ProductId => Str
- ProvisionedProductName => Str
- ProvisioningArtifactId => Str
- [AcceptLanguage => Str]
Each argument is described in detail in: Paws::ServiceCatalog::ImportAsProvisionedProduct
Returns: a Paws::ServiceCatalog::ImportAsProvisionedProductOutput instance
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.
ListAcceptedPortfolioShares
Each argument is described in detail in: Paws::ServiceCatalog::ListAcceptedPortfolioShares
Returns: a Paws::ServiceCatalog::ListAcceptedPortfolioSharesOutput instance
Lists all portfolios for which sharing was accepted by this account.
ListBudgetsForResource
Each argument is described in detail in: Paws::ServiceCatalog::ListBudgetsForResource
Returns: a Paws::ServiceCatalog::ListBudgetsForResourceOutput instance
Lists all the budgets associated to the specified resource.
ListConstraintsForPortfolio
Each argument is described in detail in: Paws::ServiceCatalog::ListConstraintsForPortfolio
Returns: a Paws::ServiceCatalog::ListConstraintsForPortfolioOutput instance
Lists the constraints for the specified portfolio and product.
ListLaunchPaths
Each argument is described in detail in: Paws::ServiceCatalog::ListLaunchPaths
Returns: a Paws::ServiceCatalog::ListLaunchPathsOutput instance
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.
ListOrganizationPortfolioAccess
- OrganizationNodeType => Str
- PortfolioId => Str
- [AcceptLanguage => Str]
- [PageSize => Int]
- [PageToken => Str]
Each argument is described in detail in: Paws::ServiceCatalog::ListOrganizationPortfolioAccess
Returns: a Paws::ServiceCatalog::ListOrganizationPortfolioAccessOutput instance
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.
ListPortfolioAccess
- PortfolioId => Str
- [AcceptLanguage => Str]
- [OrganizationParentId => Str]
- [PageSize => Int]
- [PageToken => Str]
Each argument is described in detail in: Paws::ServiceCatalog::ListPortfolioAccess
Returns: a Paws::ServiceCatalog::ListPortfolioAccessOutput instance
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.
ListPortfolios
Each argument is described in detail in: Paws::ServiceCatalog::ListPortfolios
Returns: a Paws::ServiceCatalog::ListPortfoliosOutput instance
Lists all portfolios in the catalog.
ListPortfoliosForProduct
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
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.
ListProvisionedProductPlans
- [AcceptLanguage => Str]
- [AccessLevelFilter => Paws::ServiceCatalog::AccessLevelFilter]
- [PageSize => Int]
- [PageToken => Str]
- [ProvisionProductId => Str]
Each argument is described in detail in: Paws::ServiceCatalog::ListProvisionedProductPlans
Returns: a Paws::ServiceCatalog::ListProvisionedProductPlansOutput instance
Lists the plans for the specified provisioned product or all plans to which the user has access.
ListProvisioningArtifacts
Each argument is described in detail in: Paws::ServiceCatalog::ListProvisioningArtifacts
Returns: a Paws::ServiceCatalog::ListProvisioningArtifactsOutput instance
Lists all provisioning artifacts (also known as versions) for the specified product.
ListProvisioningArtifactsForServiceAction
Each argument is described in detail in: Paws::ServiceCatalog::ListProvisioningArtifactsForServiceAction
Returns: a Paws::ServiceCatalog::ListProvisioningArtifactsForServiceActionOutput instance
Lists all provisioning artifacts (also known as versions) for the specified self-service action.
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
Lists the specified requests or all performed requests.
ListResourcesForTagOption
Each argument is described in detail in: Paws::ServiceCatalog::ListResourcesForTagOption
Returns: a Paws::ServiceCatalog::ListResourcesForTagOptionOutput instance
Lists the resources associated with the specified TagOption.
ListServiceActions
Each argument is described in detail in: Paws::ServiceCatalog::ListServiceActions
Returns: a Paws::ServiceCatalog::ListServiceActionsOutput instance
Lists all self-service actions.
ListServiceActionsForProvisioningArtifact
- ProductId => Str
- ProvisioningArtifactId => Str
- [AcceptLanguage => Str]
- [PageSize => Int]
- [PageToken => Str]
Each argument is described in detail in: Paws::ServiceCatalog::ListServiceActionsForProvisioningArtifact
Returns: a Paws::ServiceCatalog::ListServiceActionsForProvisioningArtifactOutput instance
Returns a paginated list of self-service actions associated with the specified Product ID and Provisioning Artifact ID.
ListStackInstancesForProvisionedProduct
Each argument is described in detail in: Paws::ServiceCatalog::ListStackInstancesForProvisionedProduct
Returns: a Paws::ServiceCatalog::ListStackInstancesForProvisionedProductOutput instance
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.
ListTagOptions
- [Filters => Paws::ServiceCatalog::ListTagOptionsFilters]
- [PageSize => Int]
- [PageToken => Str]
Each argument is described in detail in: Paws::ServiceCatalog::ListTagOptions
Returns: a Paws::ServiceCatalog::ListTagOptionsOutput instance
Lists the specified TagOptions or all TagOptions.
ProvisionProduct
- ProvisionedProductName => Str
- ProvisionToken => Str
- [AcceptLanguage => Str]
- [NotificationArns => ArrayRef[Str|Undef]]
- [PathId => Str]
- [PathName => Str]
- [ProductId => Str]
- [ProductName => Str]
- [ProvisioningArtifactId => Str]
- [ProvisioningArtifactName => Str]
- [ProvisioningParameters => ArrayRef[Paws::ServiceCatalog::ProvisioningParameter]]
- [ProvisioningPreferences => Paws::ServiceCatalog::ProvisioningPreferences]
- [Tags => ArrayRef[Paws::ServiceCatalog::Tag]]
Each argument is described in detail in: Paws::ServiceCatalog::ProvisionProduct
Returns: a Paws::ServiceCatalog::ProvisionProductOutput instance
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".
RejectPortfolioShare
Each argument is described in detail in: Paws::ServiceCatalog::RejectPortfolioShare
Returns: a Paws::ServiceCatalog::RejectPortfolioShareOutput instance
Rejects an offer to share the specified 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
Lists the provisioned products that are available (not terminated).
To use additional filtering, see SearchProvisionedProducts.
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
Gets information about the products to which the caller has access.
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
Gets information about the products for the specified portfolio or all products.
SearchProvisionedProducts
- [AcceptLanguage => Str]
- [AccessLevelFilter => Paws::ServiceCatalog::AccessLevelFilter]
- [Filters => Paws::ServiceCatalog::ProvisionedProductFilters]
- [PageSize => Int]
- [PageToken => Str]
- [SortBy => Str]
- [SortOrder => Str]
Each argument is described in detail in: Paws::ServiceCatalog::SearchProvisionedProducts
Returns: a Paws::ServiceCatalog::SearchProvisionedProductsOutput instance
Gets information about the provisioned products that meet the specified criteria.
TerminateProvisionedProduct
- TerminateToken => Str
- [AcceptLanguage => Str]
- [IgnoreErrors => Bool]
- [ProvisionedProductId => Str]
- [ProvisionedProductName => Str]
- [RetainPhysicalResources => Bool]
Each argument is described in detail in: Paws::ServiceCatalog::TerminateProvisionedProduct
Returns: a Paws::ServiceCatalog::TerminateProvisionedProductOutput instance
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.
UpdateConstraint
Each argument is described in detail in: Paws::ServiceCatalog::UpdateConstraint
Returns: a Paws::ServiceCatalog::UpdateConstraintOutput instance
Updates the specified 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.
You cannot update a product that was shared with you.
UpdatePortfolioShare
- PortfolioId => Str
- [AcceptLanguage => Str]
- [AccountId => Str]
- [OrganizationNode => Paws::ServiceCatalog::OrganizationNode]
Each argument is described in detail in: Paws::ServiceCatalog::UpdatePortfolioShare
Returns: a Paws::ServiceCatalog::UpdatePortfolioShareOutput instance
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.
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 the specified product.
UpdateProvisionedProduct
- UpdateToken => Str
- [AcceptLanguage => Str]
- [PathId => Str]
- [PathName => Str]
- [ProductId => Str]
- [ProductName => Str]
- [ProvisionedProductId => Str]
- [ProvisionedProductName => Str]
- [ProvisioningArtifactId => Str]
- [ProvisioningArtifactName => Str]
- [ProvisioningParameters => ArrayRef[Paws::ServiceCatalog::UpdateProvisioningParameter]]
- [ProvisioningPreferences => Paws::ServiceCatalog::UpdateProvisioningPreferences]
- [Tags => ArrayRef[Paws::ServiceCatalog::Tag]]
Each argument is described in detail in: Paws::ServiceCatalog::UpdateProvisionedProduct
Returns: a Paws::ServiceCatalog::UpdateProvisionedProductOutput instance
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.
UpdateProvisionedProductProperties
- IdempotencyToken => Str
- ProvisionedProductId => Str
- ProvisionedProductProperties => Paws::ServiceCatalog::ProvisionedProductProperties
- [AcceptLanguage => Str]
Each argument is described in detail in: Paws::ServiceCatalog::UpdateProvisionedProductProperties
Returns: a Paws::ServiceCatalog::UpdateProvisionedProductPropertiesOutput instance
Requests updates to the properties of the specified provisioned product.
UpdateProvisioningArtifact
- ProductId => Str
- ProvisioningArtifactId => Str
- [AcceptLanguage => Str]
- [Active => Bool]
- [Description => Str]
- [Guidance => Str]
- [Name => Str]
Each argument is described in detail in: Paws::ServiceCatalog::UpdateProvisioningArtifact
Returns: a Paws::ServiceCatalog::UpdateProvisioningArtifactOutput instance
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.
UpdateServiceAction
- Id => Str
- [AcceptLanguage => Str]
- [Definition => Paws::ServiceCatalog::ServiceActionDefinitionMap]
- [Description => Str]
- [Name => Str]
Each argument is described in detail in: Paws::ServiceCatalog::UpdateServiceAction
Returns: a Paws::ServiceCatalog::UpdateServiceActionOutput instance
Updates a self-service action.
UpdateTagOption
Each argument is described in detail in: Paws::ServiceCatalog::UpdateTagOption
Returns: a Paws::ServiceCatalog::UpdateTagOptionOutput instance
Updates the specified TagOption.
PAGINATORS
Paginator methods are helpers that repetively call methods that return partial results
ListAllAcceptedPortfolioShares(sub { },[AcceptLanguage => Str, PageSize => Int, PageToken => Str, PortfolioShareType => Str])
ListAllAcceptedPortfolioShares([AcceptLanguage => Str, PageSize => Int, PageToken => Str, PortfolioShareType => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- PortfolioDetails, passing the object as the first parameter, and the string 'PortfolioDetails' as the second parameter
If not, it will return a a Paws::ServiceCatalog::ListAcceptedPortfolioSharesOutput instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllConstraintsForPortfolio(sub { },PortfolioId => Str, [AcceptLanguage => Str, PageSize => Int, PageToken => Str, ProductId => Str])
ListAllConstraintsForPortfolio(PortfolioId => Str, [AcceptLanguage => Str, PageSize => Int, PageToken => Str, ProductId => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- ConstraintDetails, passing the object as the first parameter, and the string 'ConstraintDetails' as the second parameter
If not, it will return a a Paws::ServiceCatalog::ListConstraintsForPortfolioOutput instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllLaunchPaths(sub { },ProductId => Str, [AcceptLanguage => Str, PageSize => Int, PageToken => Str])
ListAllLaunchPaths(ProductId => Str, [AcceptLanguage => Str, PageSize => Int, PageToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- LaunchPathSummaries, passing the object as the first parameter, and the string 'LaunchPathSummaries' as the second parameter
If not, it will return a a Paws::ServiceCatalog::ListLaunchPathsOutput instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllOrganizationPortfolioAccess(sub { },OrganizationNodeType => Str, PortfolioId => Str, [AcceptLanguage => Str, PageSize => Int, PageToken => Str])
ListAllOrganizationPortfolioAccess(OrganizationNodeType => Str, PortfolioId => Str, [AcceptLanguage => Str, PageSize => Int, PageToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- OrganizationNodes, passing the object as the first parameter, and the string 'OrganizationNodes' as the second parameter
If not, it will return a a Paws::ServiceCatalog::ListOrganizationPortfolioAccessOutput instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllPortfolios(sub { },[AcceptLanguage => Str, PageSize => Int, PageToken => Str])
ListAllPortfolios([AcceptLanguage => Str, PageSize => Int, PageToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- PortfolioDetails, passing the object as the first parameter, and the string 'PortfolioDetails' as the second parameter
If not, it will return a a Paws::ServiceCatalog::ListPortfoliosOutput instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllPortfoliosForProduct(sub { },ProductId => Str, [AcceptLanguage => Str, PageSize => Int, PageToken => Str])
ListAllPortfoliosForProduct(ProductId => Str, [AcceptLanguage => Str, PageSize => Int, PageToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- PortfolioDetails, passing the object as the first parameter, and the string 'PortfolioDetails' as the second parameter
If not, it will return a a Paws::ServiceCatalog::ListPortfoliosForProductOutput instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllPrincipalsForPortfolio(sub { },PortfolioId => Str, [AcceptLanguage => Str, PageSize => Int, PageToken => Str])
ListAllPrincipalsForPortfolio(PortfolioId => Str, [AcceptLanguage => Str, PageSize => Int, PageToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- Principals, passing the object as the first parameter, and the string 'Principals' as the second parameter
If not, it will return a a Paws::ServiceCatalog::ListPrincipalsForPortfolioOutput instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllProvisionedProductPlans(sub { },[AcceptLanguage => Str, AccessLevelFilter => Paws::ServiceCatalog::AccessLevelFilter, PageSize => Int, PageToken => Str, ProvisionProductId => Str])
ListAllProvisionedProductPlans([AcceptLanguage => Str, AccessLevelFilter => Paws::ServiceCatalog::AccessLevelFilter, PageSize => Int, PageToken => Str, ProvisionProductId => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- ProvisionedProductPlans, passing the object as the first parameter, and the string 'ProvisionedProductPlans' as the second parameter
If not, it will return a a Paws::ServiceCatalog::ListProvisionedProductPlansOutput instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllProvisioningArtifactsForServiceAction(sub { },ServiceActionId => Str, [AcceptLanguage => Str, PageSize => Int, PageToken => Str])
ListAllProvisioningArtifactsForServiceAction(ServiceActionId => Str, [AcceptLanguage => Str, PageSize => Int, PageToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- ProvisioningArtifactViews, passing the object as the first parameter, and the string 'ProvisioningArtifactViews' as the second parameter
If not, it will return a a Paws::ServiceCatalog::ListProvisioningArtifactsForServiceActionOutput instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllRecordHistory(sub { },[AcceptLanguage => Str, AccessLevelFilter => Paws::ServiceCatalog::AccessLevelFilter, PageSize => Int, PageToken => Str, SearchFilter => Paws::ServiceCatalog::ListRecordHistorySearchFilter])
ListAllRecordHistory([AcceptLanguage => Str, AccessLevelFilter => Paws::ServiceCatalog::AccessLevelFilter, PageSize => Int, PageToken => Str, SearchFilter => Paws::ServiceCatalog::ListRecordHistorySearchFilter])
If passed a sub as first parameter, it will call the sub for each element found in :
- RecordDetails, passing the object as the first parameter, and the string 'RecordDetails' as the second parameter
If not, it will return a a Paws::ServiceCatalog::ListRecordHistoryOutput instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllResourcesForTagOption(sub { },TagOptionId => Str, [PageSize => Int, PageToken => Str, ResourceType => Str])
ListAllResourcesForTagOption(TagOptionId => Str, [PageSize => Int, PageToken => Str, ResourceType => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- ResourceDetails, passing the object as the first parameter, and the string 'ResourceDetails' as the second parameter
If not, it will return a a Paws::ServiceCatalog::ListResourcesForTagOptionOutput instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllServiceActions(sub { },[AcceptLanguage => Str, PageSize => Int, PageToken => Str])
ListAllServiceActions([AcceptLanguage => Str, PageSize => Int, PageToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- ServiceActionSummaries, passing the object as the first parameter, and the string 'ServiceActionSummaries' as the second parameter
If not, it will return a a Paws::ServiceCatalog::ListServiceActionsOutput instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllServiceActionsForProvisioningArtifact(sub { },ProductId => Str, ProvisioningArtifactId => Str, [AcceptLanguage => Str, PageSize => Int, PageToken => Str])
ListAllServiceActionsForProvisioningArtifact(ProductId => Str, ProvisioningArtifactId => Str, [AcceptLanguage => Str, PageSize => Int, PageToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- ServiceActionSummaries, passing the object as the first parameter, and the string 'ServiceActionSummaries' as the second parameter
If not, it will return a a Paws::ServiceCatalog::ListServiceActionsForProvisioningArtifactOutput instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllTagOptions(sub { },[Filters => Paws::ServiceCatalog::ListTagOptionsFilters, PageSize => Int, PageToken => Str])
ListAllTagOptions([Filters => Paws::ServiceCatalog::ListTagOptionsFilters, PageSize => Int, PageToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- TagOptionDetails, passing the object as the first parameter, and the string 'TagOptionDetails' as the second parameter
If not, it will return a a Paws::ServiceCatalog::ListTagOptionsOutput instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ScanAllProvisionedProducts(sub { },[AcceptLanguage => Str, AccessLevelFilter => Paws::ServiceCatalog::AccessLevelFilter, PageSize => Int, PageToken => Str])
ScanAllProvisionedProducts([AcceptLanguage => Str, AccessLevelFilter => Paws::ServiceCatalog::AccessLevelFilter, PageSize => Int, PageToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- ProvisionedProducts, passing the object as the first parameter, and the string 'ProvisionedProducts' as the second parameter
If not, it will return a a Paws::ServiceCatalog::ScanProvisionedProductsOutput instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
SearchAllProductsAsAdmin(sub { },[AcceptLanguage => Str, Filters => Paws::ServiceCatalog::ProductViewFilters, PageSize => Int, PageToken => Str, PortfolioId => Str, ProductSource => Str, SortBy => Str, SortOrder => Str])
SearchAllProductsAsAdmin([AcceptLanguage => Str, Filters => Paws::ServiceCatalog::ProductViewFilters, PageSize => Int, PageToken => Str, PortfolioId => Str, ProductSource => Str, SortBy => Str, SortOrder => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- ProductViewDetails, passing the object as the first parameter, and the string 'ProductViewDetails' as the second parameter
If not, it will return a a Paws::ServiceCatalog::SearchProductsAsAdminOutput instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
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