@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSServiceCatalog
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSServiceCatalog instead.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
AcceptPortfolioShareResult |
acceptPortfolioShare(AcceptPortfolioShareRequest acceptPortfolioShareRequest)
Accepts an offer to share the specified portfolio.
|
AssociateBudgetWithResourceResult |
associateBudgetWithResource(AssociateBudgetWithResourceRequest associateBudgetWithResourceRequest)
Associates the specified budget with the specified resource.
|
AssociatePrincipalWithPortfolioResult |
associatePrincipalWithPortfolio(AssociatePrincipalWithPortfolioRequest associatePrincipalWithPortfolioRequest)
Associates the specified principal ARN with the specified portfolio.
|
AssociateProductWithPortfolioResult |
associateProductWithPortfolio(AssociateProductWithPortfolioRequest associateProductWithPortfolioRequest)
Associates the specified product with the specified portfolio.
|
AssociateServiceActionWithProvisioningArtifactResult |
associateServiceActionWithProvisioningArtifact(AssociateServiceActionWithProvisioningArtifactRequest associateServiceActionWithProvisioningArtifactRequest)
Associates a self-service action with a provisioning artifact.
|
AssociateTagOptionWithResourceResult |
associateTagOptionWithResource(AssociateTagOptionWithResourceRequest associateTagOptionWithResourceRequest)
Associate the specified TagOption with the specified portfolio or product.
|
BatchAssociateServiceActionWithProvisioningArtifactResult |
batchAssociateServiceActionWithProvisioningArtifact(BatchAssociateServiceActionWithProvisioningArtifactRequest batchAssociateServiceActionWithProvisioningArtifactRequest)
Associates multiple self-service actions with provisioning artifacts.
|
BatchDisassociateServiceActionFromProvisioningArtifactResult |
batchDisassociateServiceActionFromProvisioningArtifact(BatchDisassociateServiceActionFromProvisioningArtifactRequest batchDisassociateServiceActionFromProvisioningArtifactRequest)
Disassociates a batch of self-service actions from the specified provisioning artifact.
|
CopyProductResult |
copyProduct(CopyProductRequest copyProductRequest)
Copies the specified source product to the specified target product or a new product.
|
CreateConstraintResult |
createConstraint(CreateConstraintRequest createConstraintRequest)
Creates a constraint.
|
CreatePortfolioResult |
createPortfolio(CreatePortfolioRequest createPortfolioRequest)
Creates a portfolio.
|
CreatePortfolioShareResult |
createPortfolioShare(CreatePortfolioShareRequest createPortfolioShareRequest)
Shares the specified portfolio with the specified account or organization node.
|
CreateProductResult |
createProduct(CreateProductRequest createProductRequest)
Creates a product.
|
CreateProvisionedProductPlanResult |
createProvisionedProductPlan(CreateProvisionedProductPlanRequest createProvisionedProductPlanRequest)
Creates a plan.
|
CreateProvisioningArtifactResult |
createProvisioningArtifact(CreateProvisioningArtifactRequest createProvisioningArtifactRequest)
Creates a provisioning artifact (also known as a version) for the specified product.
|
CreateServiceActionResult |
createServiceAction(CreateServiceActionRequest createServiceActionRequest)
Creates a self-service action.
|
CreateTagOptionResult |
createTagOption(CreateTagOptionRequest createTagOptionRequest)
Creates a TagOption.
|
DeleteConstraintResult |
deleteConstraint(DeleteConstraintRequest deleteConstraintRequest)
Deletes the specified constraint.
|
DeletePortfolioResult |
deletePortfolio(DeletePortfolioRequest deletePortfolioRequest)
Deletes the specified portfolio.
|
DeletePortfolioShareResult |
deletePortfolioShare(DeletePortfolioShareRequest deletePortfolioShareRequest)
Stops sharing the specified portfolio with the specified account or organization node.
|
DeleteProductResult |
deleteProduct(DeleteProductRequest deleteProductRequest)
Deletes the specified product.
|
DeleteProvisionedProductPlanResult |
deleteProvisionedProductPlan(DeleteProvisionedProductPlanRequest deleteProvisionedProductPlanRequest)
Deletes the specified plan.
|
DeleteProvisioningArtifactResult |
deleteProvisioningArtifact(DeleteProvisioningArtifactRequest deleteProvisioningArtifactRequest)
Deletes the specified provisioning artifact (also known as a version) for the specified product.
|
DeleteServiceActionResult |
deleteServiceAction(DeleteServiceActionRequest deleteServiceActionRequest)
Deletes a self-service action.
|
DeleteTagOptionResult |
deleteTagOption(DeleteTagOptionRequest deleteTagOptionRequest)
Deletes the specified TagOption.
|
DescribeConstraintResult |
describeConstraint(DescribeConstraintRequest describeConstraintRequest)
Gets information about the specified constraint.
|
DescribeCopyProductStatusResult |
describeCopyProductStatus(DescribeCopyProductStatusRequest describeCopyProductStatusRequest)
Gets the status of the specified copy product operation.
|
DescribePortfolioResult |
describePortfolio(DescribePortfolioRequest describePortfolioRequest)
Gets information about the specified portfolio.
|
DescribePortfolioSharesResult |
describePortfolioShares(DescribePortfolioSharesRequest describePortfolioSharesRequest)
Returns a summary of each of the portfolio shares that were created for the specified portfolio.
|
DescribePortfolioShareStatusResult |
describePortfolioShareStatus(DescribePortfolioShareStatusRequest describePortfolioShareStatusRequest)
Gets the status of the specified portfolio share operation.
|
DescribeProductResult |
describeProduct(DescribeProductRequest describeProductRequest)
Gets information about the specified product.
|
DescribeProductAsAdminResult |
describeProductAsAdmin(DescribeProductAsAdminRequest describeProductAsAdminRequest)
Gets information about the specified product.
|
DescribeProductViewResult |
describeProductView(DescribeProductViewRequest describeProductViewRequest)
Gets information about the specified product.
|
DescribeProvisionedProductResult |
describeProvisionedProduct(DescribeProvisionedProductRequest describeProvisionedProductRequest)
Gets information about the specified provisioned product.
|
DescribeProvisionedProductPlanResult |
describeProvisionedProductPlan(DescribeProvisionedProductPlanRequest describeProvisionedProductPlanRequest)
Gets information about the resource changes for the specified plan.
|
DescribeProvisioningArtifactResult |
describeProvisioningArtifact(DescribeProvisioningArtifactRequest describeProvisioningArtifactRequest)
Gets information about the specified provisioning artifact (also known as a version) for the specified product.
|
DescribeProvisioningParametersResult |
describeProvisioningParameters(DescribeProvisioningParametersRequest describeProvisioningParametersRequest)
Gets information about the configuration required to provision the specified product using the specified
provisioning artifact.
|
DescribeRecordResult |
describeRecord(DescribeRecordRequest describeRecordRequest)
Gets information about the specified request operation.
|
DescribeServiceActionResult |
describeServiceAction(DescribeServiceActionRequest describeServiceActionRequest)
Describes a self-service action.
|
DescribeServiceActionExecutionParametersResult |
describeServiceActionExecutionParameters(DescribeServiceActionExecutionParametersRequest describeServiceActionExecutionParametersRequest)
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.
|
DescribeTagOptionResult |
describeTagOption(DescribeTagOptionRequest describeTagOptionRequest)
Gets information about the specified TagOption.
|
DisableAWSOrganizationsAccessResult |
disableAWSOrganizationsAccess(DisableAWSOrganizationsAccessRequest disableAWSOrganizationsAccessRequest)
Disable portfolio sharing through AWS Organizations feature.
|
DisassociateBudgetFromResourceResult |
disassociateBudgetFromResource(DisassociateBudgetFromResourceRequest disassociateBudgetFromResourceRequest)
Disassociates the specified budget from the specified resource.
|
DisassociatePrincipalFromPortfolioResult |
disassociatePrincipalFromPortfolio(DisassociatePrincipalFromPortfolioRequest disassociatePrincipalFromPortfolioRequest)
Disassociates a previously associated principal ARN from a specified portfolio.
|
DisassociateProductFromPortfolioResult |
disassociateProductFromPortfolio(DisassociateProductFromPortfolioRequest disassociateProductFromPortfolioRequest)
Disassociates the specified product from the specified portfolio.
|
DisassociateServiceActionFromProvisioningArtifactResult |
disassociateServiceActionFromProvisioningArtifact(DisassociateServiceActionFromProvisioningArtifactRequest disassociateServiceActionFromProvisioningArtifactRequest)
Disassociates the specified self-service action association from the specified provisioning artifact.
|
DisassociateTagOptionFromResourceResult |
disassociateTagOptionFromResource(DisassociateTagOptionFromResourceRequest disassociateTagOptionFromResourceRequest)
Disassociates the specified TagOption from the specified resource.
|
EnableAWSOrganizationsAccessResult |
enableAWSOrganizationsAccess(EnableAWSOrganizationsAccessRequest enableAWSOrganizationsAccessRequest)
Enable portfolio sharing feature through AWS Organizations.
|
ExecuteProvisionedProductPlanResult |
executeProvisionedProductPlan(ExecuteProvisionedProductPlanRequest executeProvisionedProductPlanRequest)
Provisions or modifies a product based on the resource changes for the specified plan.
|
ExecuteProvisionedProductServiceActionResult |
executeProvisionedProductServiceAction(ExecuteProvisionedProductServiceActionRequest executeProvisionedProductServiceActionRequest)
Executes a self-service action against a provisioned product.
|
GetAWSOrganizationsAccessStatusResult |
getAWSOrganizationsAccessStatus(GetAWSOrganizationsAccessStatusRequest getAWSOrganizationsAccessStatusRequest)
Get the Access Status for AWS Organization portfolio share feature.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetProvisionedProductOutputsResult |
getProvisionedProductOutputs(GetProvisionedProductOutputsRequest getProvisionedProductOutputsRequest)
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. |
ImportAsProvisionedProductResult |
importAsProvisionedProduct(ImportAsProvisionedProductRequest importAsProvisionedProductRequest)
Requests the import of a resource as a Service Catalog provisioned product that is associated to a Service
Catalog product and provisioning artifact.
|
ListAcceptedPortfolioSharesResult |
listAcceptedPortfolioShares(ListAcceptedPortfolioSharesRequest listAcceptedPortfolioSharesRequest)
Lists all imported portfolios for which account-to-account shares were accepted by this account.
|
ListBudgetsForResourceResult |
listBudgetsForResource(ListBudgetsForResourceRequest listBudgetsForResourceRequest)
Lists all the budgets associated to the specified resource.
|
ListConstraintsForPortfolioResult |
listConstraintsForPortfolio(ListConstraintsForPortfolioRequest listConstraintsForPortfolioRequest)
Lists the constraints for the specified portfolio and product.
|
ListLaunchPathsResult |
listLaunchPaths(ListLaunchPathsRequest listLaunchPathsRequest)
Lists the paths to the specified product.
|
ListOrganizationPortfolioAccessResult |
listOrganizationPortfolioAccess(ListOrganizationPortfolioAccessRequest listOrganizationPortfolioAccessRequest)
Lists the organization nodes that have access to the specified portfolio.
|
ListPortfolioAccessResult |
listPortfolioAccess(ListPortfolioAccessRequest listPortfolioAccessRequest)
Lists the account IDs that have access to the specified portfolio.
|
ListPortfoliosResult |
listPortfolios(ListPortfoliosRequest listPortfoliosRequest)
Lists all portfolios in the catalog.
|
ListPortfoliosForProductResult |
listPortfoliosForProduct(ListPortfoliosForProductRequest listPortfoliosForProductRequest)
Lists all portfolios that the specified product is associated with.
|
ListPrincipalsForPortfolioResult |
listPrincipalsForPortfolio(ListPrincipalsForPortfolioRequest listPrincipalsForPortfolioRequest)
Lists all principal ARNs associated with the specified portfolio.
|
ListProvisionedProductPlansResult |
listProvisionedProductPlans(ListProvisionedProductPlansRequest listProvisionedProductPlansRequest)
Lists the plans for the specified provisioned product or all plans to which the user has access.
|
ListProvisioningArtifactsResult |
listProvisioningArtifacts(ListProvisioningArtifactsRequest listProvisioningArtifactsRequest)
Lists all provisioning artifacts (also known as versions) for the specified product.
|
ListProvisioningArtifactsForServiceActionResult |
listProvisioningArtifactsForServiceAction(ListProvisioningArtifactsForServiceActionRequest listProvisioningArtifactsForServiceActionRequest)
Lists all provisioning artifacts (also known as versions) for the specified self-service action.
|
ListRecordHistoryResult |
listRecordHistory(ListRecordHistoryRequest listRecordHistoryRequest)
Lists the specified requests or all performed requests.
|
ListResourcesForTagOptionResult |
listResourcesForTagOption(ListResourcesForTagOptionRequest listResourcesForTagOptionRequest)
Lists the resources associated with the specified TagOption.
|
ListServiceActionsResult |
listServiceActions(ListServiceActionsRequest listServiceActionsRequest)
Lists all self-service actions.
|
ListServiceActionsForProvisioningArtifactResult |
listServiceActionsForProvisioningArtifact(ListServiceActionsForProvisioningArtifactRequest listServiceActionsForProvisioningArtifactRequest)
Returns a paginated list of self-service actions associated with the specified Product ID and Provisioning
Artifact ID.
|
ListStackInstancesForProvisionedProductResult |
listStackInstancesForProvisionedProduct(ListStackInstancesForProvisionedProductRequest listStackInstancesForProvisionedProductRequest)
Returns summary information about stack instances that are associated with the specified
CFN_STACKSET type provisioned product. |
ListTagOptionsResult |
listTagOptions(ListTagOptionsRequest listTagOptionsRequest)
Lists the specified TagOptions or all TagOptions.
|
ProvisionProductResult |
provisionProduct(ProvisionProductRequest provisionProductRequest)
Provisions the specified product.
|
RejectPortfolioShareResult |
rejectPortfolioShare(RejectPortfolioShareRequest rejectPortfolioShareRequest)
Rejects an offer to share the specified portfolio.
|
ScanProvisionedProductsResult |
scanProvisionedProducts(ScanProvisionedProductsRequest scanProvisionedProductsRequest)
Lists the provisioned products that are available (not terminated).
|
SearchProductsResult |
searchProducts(SearchProductsRequest searchProductsRequest)
Gets information about the products to which the caller has access.
|
SearchProductsAsAdminResult |
searchProductsAsAdmin(SearchProductsAsAdminRequest searchProductsAsAdminRequest)
Gets information about the products for the specified portfolio or all products.
|
SearchProvisionedProductsResult |
searchProvisionedProducts(SearchProvisionedProductsRequest searchProvisionedProductsRequest)
Gets information about the provisioned products that meet the specified criteria.
|
void |
setEndpoint(String endpoint)
Deprecated.
use
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion)); |
void |
setRegion(Region region)
Deprecated.
use
AwsClientBuilder#setRegion(String) |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TerminateProvisionedProductResult |
terminateProvisionedProduct(TerminateProvisionedProductRequest terminateProvisionedProductRequest)
Terminates the specified provisioned product.
|
UpdateConstraintResult |
updateConstraint(UpdateConstraintRequest updateConstraintRequest)
Updates the specified constraint.
|
UpdatePortfolioResult |
updatePortfolio(UpdatePortfolioRequest updatePortfolioRequest)
Updates the specified portfolio.
|
UpdatePortfolioShareResult |
updatePortfolioShare(UpdatePortfolioShareRequest updatePortfolioShareRequest)
Updates the specified portfolio share.
|
UpdateProductResult |
updateProduct(UpdateProductRequest updateProductRequest)
Updates the specified product.
|
UpdateProvisionedProductResult |
updateProvisionedProduct(UpdateProvisionedProductRequest updateProvisionedProductRequest)
Requests updates to the configuration of the specified provisioned product.
|
UpdateProvisionedProductPropertiesResult |
updateProvisionedProductProperties(UpdateProvisionedProductPropertiesRequest updateProvisionedProductPropertiesRequest)
Requests updates to the properties of the specified provisioned product.
|
UpdateProvisioningArtifactResult |
updateProvisioningArtifact(UpdateProvisioningArtifactRequest updateProvisioningArtifactRequest)
Updates the specified provisioning artifact (also known as a version) for the specified product.
|
UpdateServiceActionResult |
updateServiceAction(UpdateServiceActionRequest updateServiceActionRequest)
Updates a self-service action.
|
UpdateTagOptionResult |
updateTagOption(UpdateTagOptionRequest updateTagOptionRequest)
Updates the specified TagOption.
|
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
Callers can pass in just the endpoint (ex: "servicecatalog.us-east-1.amazonaws.com") or a full URL, including the
protocol (ex: "servicecatalog.us-east-1.amazonaws.com"). If the protocol is not specified here, the default
protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
endpoint - The endpoint (ex: "servicecatalog.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"servicecatalog.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate
with.@Deprecated void setRegion(Region region)
AwsClientBuilder#setRegion(String)setEndpoint(String), sets the regional endpoint for this client's
service calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)AcceptPortfolioShareResult acceptPortfolioShare(AcceptPortfolioShareRequest acceptPortfolioShareRequest)
Accepts an offer to share the specified portfolio.
acceptPortfolioShareRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.LimitExceededException - The current limits of the service would have been exceeded by this operation. Decrease your resource use
or increase your service limits and retry the operation.AssociateBudgetWithResourceResult associateBudgetWithResource(AssociateBudgetWithResourceRequest associateBudgetWithResourceRequest)
Associates the specified budget with the specified resource.
associateBudgetWithResourceRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.DuplicateResourceException - The specified resource is a duplicate.LimitExceededException - The current limits of the service would have been exceeded by this operation. Decrease your resource use
or increase your service limits and retry the operation.ResourceNotFoundException - The specified resource was not found.AssociatePrincipalWithPortfolioResult associatePrincipalWithPortfolio(AssociatePrincipalWithPortfolioRequest associatePrincipalWithPortfolioRequest)
Associates the specified principal ARN with the specified portfolio.
associatePrincipalWithPortfolioRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.LimitExceededException - The current limits of the service would have been exceeded by this operation. Decrease your resource use
or increase your service limits and retry the operation.AssociateProductWithPortfolioResult associateProductWithPortfolio(AssociateProductWithPortfolioRequest associateProductWithPortfolioRequest)
Associates the specified product with the specified portfolio.
A delegated admin is authorized to invoke this command.
associateProductWithPortfolioRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.LimitExceededException - The current limits of the service would have been exceeded by this operation. Decrease your resource use
or increase your service limits and retry the operation.AssociateServiceActionWithProvisioningArtifactResult associateServiceActionWithProvisioningArtifact(AssociateServiceActionWithProvisioningArtifactRequest associateServiceActionWithProvisioningArtifactRequest)
Associates a self-service action with a provisioning artifact.
associateServiceActionWithProvisioningArtifactRequest - ResourceNotFoundException - The specified resource was not found.DuplicateResourceException - The specified resource is a duplicate.LimitExceededException - The current limits of the service would have been exceeded by this operation. Decrease your resource use
or increase your service limits and retry the operation.AssociateTagOptionWithResourceResult associateTagOptionWithResource(AssociateTagOptionWithResourceRequest associateTagOptionWithResourceRequest)
Associate the specified TagOption with the specified portfolio or product.
associateTagOptionWithResourceRequest - TagOptionNotMigratedException - An operation requiring TagOptions failed because the TagOptions migration process has not been performed
for this account. Please use the AWS console to perform the migration process before retrying the
operation.ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.LimitExceededException - The current limits of the service would have been exceeded by this operation. Decrease your resource use
or increase your service limits and retry the operation.DuplicateResourceException - The specified resource is a duplicate.InvalidStateException - An attempt was made to modify a resource that is in a state that is not valid. Check your resources to
ensure that they are in valid states before retrying the operation.BatchAssociateServiceActionWithProvisioningArtifactResult batchAssociateServiceActionWithProvisioningArtifact(BatchAssociateServiceActionWithProvisioningArtifactRequest batchAssociateServiceActionWithProvisioningArtifactRequest)
Associates multiple self-service actions with provisioning artifacts.
batchAssociateServiceActionWithProvisioningArtifactRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.BatchDisassociateServiceActionFromProvisioningArtifactResult batchDisassociateServiceActionFromProvisioningArtifact(BatchDisassociateServiceActionFromProvisioningArtifactRequest batchDisassociateServiceActionFromProvisioningArtifactRequest)
Disassociates a batch of self-service actions from the specified provisioning artifact.
batchDisassociateServiceActionFromProvisioningArtifactRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.CopyProductResult copyProduct(CopyProductRequest copyProductRequest)
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.
copyProductRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.CreateConstraintResult createConstraint(CreateConstraintRequest createConstraintRequest)
Creates a constraint.
A delegated admin is authorized to invoke this command.
createConstraintRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.LimitExceededException - The current limits of the service would have been exceeded by this operation. Decrease your resource use
or increase your service limits and retry the operation.DuplicateResourceException - The specified resource is a duplicate.CreatePortfolioResult createPortfolio(CreatePortfolioRequest createPortfolioRequest)
Creates a portfolio.
A delegated admin is authorized to invoke this command.
createPortfolioRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.LimitExceededException - The current limits of the service would have been exceeded by this operation. Decrease your resource use
or increase your service limits and retry the operation.TagOptionNotMigratedException - An operation requiring TagOptions failed because the TagOptions migration process has not been performed
for this account. Please use the AWS console to perform the migration process before retrying the
operation.CreatePortfolioShareResult createPortfolioShare(CreatePortfolioShareRequest createPortfolioShareRequest)
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.
createPortfolioShareRequest - ResourceNotFoundException - The specified resource was not found.LimitExceededException - The current limits of the service would have been exceeded by this operation. Decrease your resource use
or increase your service limits and retry the operation.InvalidParametersException - One or more parameters provided to the operation are not valid.OperationNotSupportedException - The operation is not supported.InvalidStateException - An attempt was made to modify a resource that is in a state that is not valid. Check your resources to
ensure that they are in valid states before retrying the operation.CreateProductResult createProduct(CreateProductRequest createProductRequest)
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.
createProductRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.LimitExceededException - The current limits of the service would have been exceeded by this operation. Decrease your resource use
or increase your service limits and retry the operation.TagOptionNotMigratedException - An operation requiring TagOptions failed because the TagOptions migration process has not been performed
for this account. Please use the AWS console to perform the migration process before retrying the
operation.CreateProvisionedProductPlanResult createProvisionedProductPlan(CreateProvisionedProductPlanRequest createProvisionedProductPlanRequest)
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.
createProvisionedProductPlanRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.InvalidStateException - An attempt was made to modify a resource that is in a state that is not valid. Check your resources to
ensure that they are in valid states before retrying the operation.CreateProvisioningArtifactResult createProvisioningArtifact(CreateProvisioningArtifactRequest createProvisioningArtifactRequest)
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.
createProvisioningArtifactRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.LimitExceededException - The current limits of the service would have been exceeded by this operation. Decrease your resource use
or increase your service limits and retry the operation.CreateServiceActionResult createServiceAction(CreateServiceActionRequest createServiceActionRequest)
Creates a self-service action.
createServiceActionRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.LimitExceededException - The current limits of the service would have been exceeded by this operation. Decrease your resource use
or increase your service limits and retry the operation.CreateTagOptionResult createTagOption(CreateTagOptionRequest createTagOptionRequest)
Creates a TagOption.
createTagOptionRequest - TagOptionNotMigratedException - An operation requiring TagOptions failed because the TagOptions migration process has not been performed
for this account. Please use the AWS console to perform the migration process before retrying the
operation.DuplicateResourceException - The specified resource is a duplicate.LimitExceededException - The current limits of the service would have been exceeded by this operation. Decrease your resource use
or increase your service limits and retry the operation.DeleteConstraintResult deleteConstraint(DeleteConstraintRequest deleteConstraintRequest)
Deletes the specified constraint.
A delegated admin is authorized to invoke this command.
deleteConstraintRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.DeletePortfolioResult deletePortfolio(DeletePortfolioRequest deletePortfolioRequest)
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.
deletePortfolioRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.ResourceInUseException - A resource that is currently in use. Ensure that the resource is not in use and retry the operation.TagOptionNotMigratedException - An operation requiring TagOptions failed because the TagOptions migration process has not been performed
for this account. Please use the AWS console to perform the migration process before retrying the
operation.DeletePortfolioShareResult deletePortfolioShare(DeletePortfolioShareRequest deletePortfolioShareRequest)
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.
deletePortfolioShareRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.OperationNotSupportedException - The operation is not supported.InvalidStateException - An attempt was made to modify a resource that is in a state that is not valid. Check your resources to
ensure that they are in valid states before retrying the operation.DeleteProductResult deleteProduct(DeleteProductRequest deleteProductRequest)
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.
deleteProductRequest - ResourceNotFoundException - The specified resource was not found.ResourceInUseException - A resource that is currently in use. Ensure that the resource is not in use and retry the operation.InvalidParametersException - One or more parameters provided to the operation are not valid.TagOptionNotMigratedException - An operation requiring TagOptions failed because the TagOptions migration process has not been performed
for this account. Please use the AWS console to perform the migration process before retrying the
operation.DeleteProvisionedProductPlanResult deleteProvisionedProductPlan(DeleteProvisionedProductPlanRequest deleteProvisionedProductPlanRequest)
Deletes the specified plan.
deleteProvisionedProductPlanRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.DeleteProvisioningArtifactResult deleteProvisioningArtifact(DeleteProvisioningArtifactRequest deleteProvisioningArtifactRequest)
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.
deleteProvisioningArtifactRequest - ResourceNotFoundException - The specified resource was not found.ResourceInUseException - A resource that is currently in use. Ensure that the resource is not in use and retry the operation.InvalidParametersException - One or more parameters provided to the operation are not valid.DeleteServiceActionResult deleteServiceAction(DeleteServiceActionRequest deleteServiceActionRequest)
Deletes a self-service action.
deleteServiceActionRequest - ResourceNotFoundException - The specified resource was not found.ResourceInUseException - A resource that is currently in use. Ensure that the resource is not in use and retry the operation.DeleteTagOptionResult deleteTagOption(DeleteTagOptionRequest deleteTagOptionRequest)
Deletes the specified TagOption.
You cannot delete a TagOption if it is associated with a product or portfolio.
deleteTagOptionRequest - TagOptionNotMigratedException - An operation requiring TagOptions failed because the TagOptions migration process has not been performed
for this account. Please use the AWS console to perform the migration process before retrying the
operation.ResourceInUseException - A resource that is currently in use. Ensure that the resource is not in use and retry the operation.ResourceNotFoundException - The specified resource was not found.DescribeConstraintResult describeConstraint(DescribeConstraintRequest describeConstraintRequest)
Gets information about the specified constraint.
describeConstraintRequest - ResourceNotFoundException - The specified resource was not found.DescribeCopyProductStatusResult describeCopyProductStatus(DescribeCopyProductStatusRequest describeCopyProductStatusRequest)
Gets the status of the specified copy product operation.
describeCopyProductStatusRequest - ResourceNotFoundException - The specified resource was not found.DescribePortfolioResult describePortfolio(DescribePortfolioRequest describePortfolioRequest)
Gets information about the specified portfolio.
A delegated admin is authorized to invoke this command.
describePortfolioRequest - ResourceNotFoundException - The specified resource was not found.DescribePortfolioShareStatusResult describePortfolioShareStatus(DescribePortfolioShareStatusRequest describePortfolioShareStatusRequest)
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.
describePortfolioShareStatusRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.OperationNotSupportedException - The operation is not supported.DescribePortfolioSharesResult describePortfolioShares(DescribePortfolioSharesRequest describePortfolioSharesRequest)
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.
describePortfolioSharesRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.DescribeProductResult describeProduct(DescribeProductRequest describeProductRequest)
Gets information about the specified product.
describeProductRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.DescribeProductAsAdminResult describeProductAsAdmin(DescribeProductAsAdminRequest describeProductAsAdminRequest)
Gets information about the specified product. This operation is run with administrator access.
describeProductAsAdminRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.DescribeProductViewResult describeProductView(DescribeProductViewRequest describeProductViewRequest)
Gets information about the specified product.
describeProductViewRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.DescribeProvisionedProductResult describeProvisionedProduct(DescribeProvisionedProductRequest describeProvisionedProductRequest)
Gets information about the specified provisioned product.
describeProvisionedProductRequest - DescribeProvisionedProductAPI input structure. AcceptLanguage - [Optional] The language code for
localization. Id - [Optional] The provisioned product identifier. Name - [Optional] Another provisioned
product identifier. Customers must provide either Id or Name.ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.DescribeProvisionedProductPlanResult describeProvisionedProductPlan(DescribeProvisionedProductPlanRequest describeProvisionedProductPlanRequest)
Gets information about the resource changes for the specified plan.
describeProvisionedProductPlanRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.DescribeProvisioningArtifactResult describeProvisioningArtifact(DescribeProvisioningArtifactRequest describeProvisioningArtifactRequest)
Gets information about the specified provisioning artifact (also known as a version) for the specified product.
describeProvisioningArtifactRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.DescribeProvisioningParametersResult describeProvisioningParameters(DescribeProvisioningParametersRequest describeProvisioningParametersRequest)
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.
describeProvisioningParametersRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.DescribeRecordResult describeRecord(DescribeRecordRequest describeRecordRequest)
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.
describeRecordRequest - ResourceNotFoundException - The specified resource was not found.DescribeServiceActionResult describeServiceAction(DescribeServiceActionRequest describeServiceActionRequest)
Describes a self-service action.
describeServiceActionRequest - ResourceNotFoundException - The specified resource was not found.DescribeServiceActionExecutionParametersResult describeServiceActionExecutionParameters(DescribeServiceActionExecutionParametersRequest describeServiceActionExecutionParametersRequest)
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.
describeServiceActionExecutionParametersRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.DescribeTagOptionResult describeTagOption(DescribeTagOptionRequest describeTagOptionRequest)
Gets information about the specified TagOption.
describeTagOptionRequest - TagOptionNotMigratedException - An operation requiring TagOptions failed because the TagOptions migration process has not been performed
for this account. Please use the AWS console to perform the migration process before retrying the
operation.ResourceNotFoundException - The specified resource was not found.DisableAWSOrganizationsAccessResult disableAWSOrganizationsAccess(DisableAWSOrganizationsAccessRequest disableAWSOrganizationsAccessRequest)
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.
disableAWSOrganizationsAccessRequest - ResourceNotFoundException - The specified resource was not found.InvalidStateException - An attempt was made to modify a resource that is in a state that is not valid. Check your resources to
ensure that they are in valid states before retrying the operation.OperationNotSupportedException - The operation is not supported.DisassociateBudgetFromResourceResult disassociateBudgetFromResource(DisassociateBudgetFromResourceRequest disassociateBudgetFromResourceRequest)
Disassociates the specified budget from the specified resource.
disassociateBudgetFromResourceRequest - ResourceNotFoundException - The specified resource was not found.DisassociatePrincipalFromPortfolioResult disassociatePrincipalFromPortfolio(DisassociatePrincipalFromPortfolioRequest disassociatePrincipalFromPortfolioRequest)
Disassociates a previously associated principal ARN from a specified portfolio.
disassociatePrincipalFromPortfolioRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.DisassociateProductFromPortfolioResult disassociateProductFromPortfolio(DisassociateProductFromPortfolioRequest disassociateProductFromPortfolioRequest)
Disassociates the specified product from the specified portfolio.
A delegated admin is authorized to invoke this command.
disassociateProductFromPortfolioRequest - ResourceNotFoundException - The specified resource was not found.ResourceInUseException - A resource that is currently in use. Ensure that the resource is not in use and retry the operation.InvalidParametersException - One or more parameters provided to the operation are not valid.DisassociateServiceActionFromProvisioningArtifactResult disassociateServiceActionFromProvisioningArtifact(DisassociateServiceActionFromProvisioningArtifactRequest disassociateServiceActionFromProvisioningArtifactRequest)
Disassociates the specified self-service action association from the specified provisioning artifact.
disassociateServiceActionFromProvisioningArtifactRequest - ResourceNotFoundException - The specified resource was not found.DisassociateTagOptionFromResourceResult disassociateTagOptionFromResource(DisassociateTagOptionFromResourceRequest disassociateTagOptionFromResourceRequest)
Disassociates the specified TagOption from the specified resource.
disassociateTagOptionFromResourceRequest - TagOptionNotMigratedException - An operation requiring TagOptions failed because the TagOptions migration process has not been performed
for this account. Please use the AWS console to perform the migration process before retrying the
operation.ResourceNotFoundException - The specified resource was not found.EnableAWSOrganizationsAccessResult enableAWSOrganizationsAccess(EnableAWSOrganizationsAccessRequest enableAWSOrganizationsAccessRequest)
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.
enableAWSOrganizationsAccessRequest - ResourceNotFoundException - The specified resource was not found.InvalidStateException - An attempt was made to modify a resource that is in a state that is not valid. Check your resources to
ensure that they are in valid states before retrying the operation.OperationNotSupportedException - The operation is not supported.ExecuteProvisionedProductPlanResult executeProvisionedProductPlan(ExecuteProvisionedProductPlanRequest executeProvisionedProductPlanRequest)
Provisions or modifies a product based on the resource changes for the specified plan.
executeProvisionedProductPlanRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.InvalidStateException - An attempt was made to modify a resource that is in a state that is not valid. Check your resources to
ensure that they are in valid states before retrying the operation.ExecuteProvisionedProductServiceActionResult executeProvisionedProductServiceAction(ExecuteProvisionedProductServiceActionRequest executeProvisionedProductServiceActionRequest)
Executes a self-service action against a provisioned product.
executeProvisionedProductServiceActionRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.InvalidStateException - An attempt was made to modify a resource that is in a state that is not valid. Check your resources to
ensure that they are in valid states before retrying the operation.GetAWSOrganizationsAccessStatusResult getAWSOrganizationsAccessStatus(GetAWSOrganizationsAccessStatusRequest getAWSOrganizationsAccessStatusRequest)
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.
getAWSOrganizationsAccessStatusRequest - ResourceNotFoundException - The specified resource was not found.OperationNotSupportedException - The operation is not supported.GetProvisionedProductOutputsResult getProvisionedProductOutputs(GetProvisionedProductOutputsRequest getProvisionedProductOutputsRequest)
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.
getProvisionedProductOutputsRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.ImportAsProvisionedProductResult importAsProvisionedProduct(ImportAsProvisionedProductRequest importAsProvisionedProductRequest)
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.
importAsProvisionedProductRequest - DuplicateResourceException - The specified resource is a duplicate.InvalidStateException - An attempt was made to modify a resource that is in a state that is not valid. Check your resources to
ensure that they are in valid states before retrying the operation.ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.ListAcceptedPortfolioSharesResult listAcceptedPortfolioShares(ListAcceptedPortfolioSharesRequest listAcceptedPortfolioSharesRequest)
Lists all imported portfolios for which account-to-account shares were accepted by this account. By specifying
the PortfolioShareType, you can list portfolios for which organizational shares were accepted by
this account.
listAcceptedPortfolioSharesRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.OperationNotSupportedException - The operation is not supported.ListBudgetsForResourceResult listBudgetsForResource(ListBudgetsForResourceRequest listBudgetsForResourceRequest)
Lists all the budgets associated to the specified resource.
listBudgetsForResourceRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.ListConstraintsForPortfolioResult listConstraintsForPortfolio(ListConstraintsForPortfolioRequest listConstraintsForPortfolioRequest)
Lists the constraints for the specified portfolio and product.
listConstraintsForPortfolioRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.ListLaunchPathsResult listLaunchPaths(ListLaunchPathsRequest listLaunchPathsRequest)
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.
listLaunchPathsRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.ListOrganizationPortfolioAccessResult listOrganizationPortfolioAccess(ListOrganizationPortfolioAccessRequest listOrganizationPortfolioAccessRequest)
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.
listOrganizationPortfolioAccessRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.OperationNotSupportedException - The operation is not supported.ListPortfolioAccessResult listPortfolioAccess(ListPortfolioAccessRequest listPortfolioAccessRequest)
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.
listPortfolioAccessRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.ListPortfoliosResult listPortfolios(ListPortfoliosRequest listPortfoliosRequest)
Lists all portfolios in the catalog.
listPortfoliosRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.ListPortfoliosForProductResult listPortfoliosForProduct(ListPortfoliosForProductRequest listPortfoliosForProductRequest)
Lists all portfolios that the specified product is associated with.
listPortfoliosForProductRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.ListPrincipalsForPortfolioResult listPrincipalsForPortfolio(ListPrincipalsForPortfolioRequest listPrincipalsForPortfolioRequest)
Lists all principal ARNs associated with the specified portfolio.
listPrincipalsForPortfolioRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.ListProvisionedProductPlansResult listProvisionedProductPlans(ListProvisionedProductPlansRequest listProvisionedProductPlansRequest)
Lists the plans for the specified provisioned product or all plans to which the user has access.
listProvisionedProductPlansRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.ListProvisioningArtifactsResult listProvisioningArtifacts(ListProvisioningArtifactsRequest listProvisioningArtifactsRequest)
Lists all provisioning artifacts (also known as versions) for the specified product.
listProvisioningArtifactsRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.ListProvisioningArtifactsForServiceActionResult listProvisioningArtifactsForServiceAction(ListProvisioningArtifactsForServiceActionRequest listProvisioningArtifactsForServiceActionRequest)
Lists all provisioning artifacts (also known as versions) for the specified self-service action.
listProvisioningArtifactsForServiceActionRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.ListRecordHistoryResult listRecordHistory(ListRecordHistoryRequest listRecordHistoryRequest)
Lists the specified requests or all performed requests.
listRecordHistoryRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.ListResourcesForTagOptionResult listResourcesForTagOption(ListResourcesForTagOptionRequest listResourcesForTagOptionRequest)
Lists the resources associated with the specified TagOption.
listResourcesForTagOptionRequest - TagOptionNotMigratedException - An operation requiring TagOptions failed because the TagOptions migration process has not been performed
for this account. Please use the AWS console to perform the migration process before retrying the
operation.ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.ListServiceActionsResult listServiceActions(ListServiceActionsRequest listServiceActionsRequest)
Lists all self-service actions.
listServiceActionsRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.ListServiceActionsForProvisioningArtifactResult listServiceActionsForProvisioningArtifact(ListServiceActionsForProvisioningArtifactRequest listServiceActionsForProvisioningArtifactRequest)
Returns a paginated list of self-service actions associated with the specified Product ID and Provisioning Artifact ID.
listServiceActionsForProvisioningArtifactRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.ListStackInstancesForProvisionedProductResult listStackInstancesForProvisionedProduct(ListStackInstancesForProvisionedProductRequest listStackInstancesForProvisionedProductRequest)
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.
listStackInstancesForProvisionedProductRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.ListTagOptionsResult listTagOptions(ListTagOptionsRequest listTagOptionsRequest)
Lists the specified TagOptions or all TagOptions.
listTagOptionsRequest - TagOptionNotMigratedException - An operation requiring TagOptions failed because the TagOptions migration process has not been performed
for this account. Please use the AWS console to perform the migration process before retrying the
operation.InvalidParametersException - One or more parameters provided to the operation are not valid.ProvisionProductResult provisionProduct(ProvisionProductRequest provisionProductRequest)
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".
provisionProductRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.DuplicateResourceException - The specified resource is a duplicate.RejectPortfolioShareResult rejectPortfolioShare(RejectPortfolioShareRequest rejectPortfolioShareRequest)
Rejects an offer to share the specified portfolio.
rejectPortfolioShareRequest - ResourceNotFoundException - The specified resource was not found.ScanProvisionedProductsResult scanProvisionedProducts(ScanProvisionedProductsRequest scanProvisionedProductsRequest)
Lists the provisioned products that are available (not terminated).
To use additional filtering, see SearchProvisionedProducts.
scanProvisionedProductsRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.SearchProductsResult searchProducts(SearchProductsRequest searchProductsRequest)
Gets information about the products to which the caller has access.
searchProductsRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.SearchProductsAsAdminResult searchProductsAsAdmin(SearchProductsAsAdminRequest searchProductsAsAdminRequest)
Gets information about the products for the specified portfolio or all products.
searchProductsAsAdminRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.SearchProvisionedProductsResult searchProvisionedProducts(SearchProvisionedProductsRequest searchProvisionedProductsRequest)
Gets information about the provisioned products that meet the specified criteria.
searchProvisionedProductsRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.TerminateProvisionedProductResult terminateProvisionedProduct(TerminateProvisionedProductRequest terminateProvisionedProductRequest)
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.
terminateProvisionedProductRequest - ResourceNotFoundException - The specified resource was not found.UpdateConstraintResult updateConstraint(UpdateConstraintRequest updateConstraintRequest)
Updates the specified constraint.
updateConstraintRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.UpdatePortfolioResult updatePortfolio(UpdatePortfolioRequest updatePortfolioRequest)
Updates the specified portfolio.
You cannot update a product that was shared with you.
updatePortfolioRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.LimitExceededException - The current limits of the service would have been exceeded by this operation. Decrease your resource use
or increase your service limits and retry the operation.TagOptionNotMigratedException - An operation requiring TagOptions failed because the TagOptions migration process has not been performed
for this account. Please use the AWS console to perform the migration process before retrying the
operation.UpdatePortfolioShareResult updatePortfolioShare(UpdatePortfolioShareRequest updatePortfolioShareRequest)
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.
updatePortfolioShareRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.OperationNotSupportedException - The operation is not supported.InvalidStateException - An attempt was made to modify a resource that is in a state that is not valid. Check your resources to
ensure that they are in valid states before retrying the operation.UpdateProductResult updateProduct(UpdateProductRequest updateProductRequest)
Updates the specified product.
updateProductRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.TagOptionNotMigratedException - An operation requiring TagOptions failed because the TagOptions migration process has not been performed
for this account. Please use the AWS console to perform the migration process before retrying the
operation.UpdateProvisionedProductResult updateProvisionedProduct(UpdateProvisionedProductRequest updateProvisionedProductRequest)
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.
updateProvisionedProductRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.UpdateProvisionedProductPropertiesResult updateProvisionedProductProperties(UpdateProvisionedProductPropertiesRequest updateProvisionedProductPropertiesRequest)
Requests updates to the properties of the specified provisioned product.
updateProvisionedProductPropertiesRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.InvalidStateException - An attempt was made to modify a resource that is in a state that is not valid. Check your resources to
ensure that they are in valid states before retrying the operation.UpdateProvisioningArtifactResult updateProvisioningArtifact(UpdateProvisioningArtifactRequest updateProvisioningArtifactRequest)
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.
updateProvisioningArtifactRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.UpdateServiceActionResult updateServiceAction(UpdateServiceActionRequest updateServiceActionRequest)
Updates a self-service action.
updateServiceActionRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.UpdateTagOptionResult updateTagOption(UpdateTagOptionRequest updateTagOptionRequest)
Updates the specified TagOption.
updateTagOptionRequest - TagOptionNotMigratedException - An operation requiring TagOptions failed because the TagOptions migration process has not been performed
for this account. Please use the AWS console to perform the migration process before retrying the
operation.ResourceNotFoundException - The specified resource was not found.DuplicateResourceException - The specified resource is a duplicate.InvalidParametersException - One or more parameters provided to the operation are not valid.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request - The originally executed request.