@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSServiceCatalog extends Object implements AWSServiceCatalog
AWSServiceCatalog. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIXpublic void setEndpoint(String endpoint)
AWSServiceCatalog
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.
setEndpoint in interface AWSServiceCatalogendpoint - 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.public void setRegion(Region region)
AWSServiceCatalogAWSServiceCatalog.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.
setRegion in interface AWSServiceCatalogregion - 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)public AcceptPortfolioShareResult acceptPortfolioShare(AcceptPortfolioShareRequest request)
AWSServiceCatalogAccepts an offer to share the specified portfolio.
acceptPortfolioShare in interface AWSServiceCatalogpublic AssociateBudgetWithResourceResult associateBudgetWithResource(AssociateBudgetWithResourceRequest request)
AWSServiceCatalogAssociates the specified budget with the specified resource.
associateBudgetWithResource in interface AWSServiceCatalogpublic AssociatePrincipalWithPortfolioResult associatePrincipalWithPortfolio(AssociatePrincipalWithPortfolioRequest request)
AWSServiceCatalogAssociates the specified principal ARN with the specified portfolio.
If you share the portfolio with principal name sharing enabled, the PrincipalARN association is
included in the share.
The PortfolioID, PrincipalARN, and PrincipalType parameters are required.
You can associate a maximum of 10 Principals with a portfolio using PrincipalType as
IAM_PATTERN.
When you associate a principal with portfolio, a potential privilege escalation path may occur when that
portfolio is then shared with other accounts. For a user in a recipient account who is not an Service
Catalog Admin, but still has the ability to create Principals (Users/Groups/Roles), that user could create a role
that matches a principal name association for the portfolio. Although this user may not know which principal
names are associated through Service Catalog, they may be able to guess the user. If this potential escalation
path is a concern, then Service Catalog recommends using PrincipalType as IAM. With
this configuration, the PrincipalARN must already exist in the recipient account before it can be
associated.
associatePrincipalWithPortfolio in interface AWSServiceCatalogpublic AssociateProductWithPortfolioResult associateProductWithPortfolio(AssociateProductWithPortfolioRequest request)
AWSServiceCatalogAssociates the specified product with the specified portfolio.
A delegated admin is authorized to invoke this command.
associateProductWithPortfolio in interface AWSServiceCatalogpublic AssociateServiceActionWithProvisioningArtifactResult associateServiceActionWithProvisioningArtifact(AssociateServiceActionWithProvisioningArtifactRequest request)
AWSServiceCatalogAssociates a self-service action with a provisioning artifact.
associateServiceActionWithProvisioningArtifact in interface AWSServiceCatalogpublic AssociateTagOptionWithResourceResult associateTagOptionWithResource(AssociateTagOptionWithResourceRequest request)
AWSServiceCatalogAssociate the specified TagOption with the specified portfolio or product.
associateTagOptionWithResource in interface AWSServiceCatalogpublic BatchAssociateServiceActionWithProvisioningArtifactResult batchAssociateServiceActionWithProvisioningArtifact(BatchAssociateServiceActionWithProvisioningArtifactRequest request)
AWSServiceCatalogAssociates multiple self-service actions with provisioning artifacts.
batchAssociateServiceActionWithProvisioningArtifact in interface AWSServiceCatalogpublic BatchDisassociateServiceActionFromProvisioningArtifactResult batchDisassociateServiceActionFromProvisioningArtifact(BatchDisassociateServiceActionFromProvisioningArtifactRequest request)
AWSServiceCatalogDisassociates a batch of self-service actions from the specified provisioning artifact.
batchDisassociateServiceActionFromProvisioningArtifact in interface AWSServiceCatalogpublic CopyProductResult copyProduct(CopyProductRequest request)
AWSServiceCatalogCopies 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. If you copy a product to another account, you must first share the product in a portfolio using CreatePortfolioShare.
This operation is performed asynchronously. To track the progress of the operation, use DescribeCopyProductStatus.
copyProduct in interface AWSServiceCatalogpublic CreateConstraintResult createConstraint(CreateConstraintRequest request)
AWSServiceCatalogCreates a constraint.
A delegated admin is authorized to invoke this command.
createConstraint in interface AWSServiceCatalogpublic CreatePortfolioResult createPortfolio(CreatePortfolioRequest request)
AWSServiceCatalogCreates a portfolio.
A delegated admin is authorized to invoke this command.
createPortfolio in interface AWSServiceCatalogpublic CreatePortfolioShareResult createPortfolioShare(CreatePortfolioShareRequest request)
AWSServiceCatalogShares 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.
When you associate a principal with portfolio, a potential privilege escalation path may occur when that
portfolio is then shared with other accounts. For a user in a recipient account who is not an Service
Catalog Admin, but still has the ability to create Principals (Users/Groups/Roles), that user could create a role
that matches a principal name association for the portfolio. Although this user may not know which principal
names are associated through Service Catalog, they may be able to guess the user. If this potential escalation
path is a concern, then Service Catalog recommends using PrincipalType as IAM. With
this configuration, the PrincipalARN must already exist in the recipient account before it can be
associated.
createPortfolioShare in interface AWSServiceCatalogpublic CreateProductResult createProduct(CreateProductRequest request)
AWSServiceCatalogCreates 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.
createProduct in interface AWSServiceCatalogpublic CreateProvisionedProductPlanResult createProvisionedProductPlan(CreateProvisionedProductPlanRequest request)
AWSServiceCatalogCreates 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 for each provisioned product. To create a plan for an existing provisioned product, the product status must be AVAILABLE or TAINTED.
To view the resource changes in the change set, use DescribeProvisionedProductPlan. To create or modify the provisioned product, use ExecuteProvisionedProductPlan.
createProvisionedProductPlan in interface AWSServiceCatalogpublic CreateProvisioningArtifactResult createProvisioningArtifact(CreateProvisioningArtifactRequest request)
AWSServiceCatalogCreates 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.
createProvisioningArtifact in interface AWSServiceCatalogpublic CreateServiceActionResult createServiceAction(CreateServiceActionRequest request)
AWSServiceCatalogCreates a self-service action.
createServiceAction in interface AWSServiceCatalogpublic CreateTagOptionResult createTagOption(CreateTagOptionRequest request)
AWSServiceCatalogCreates a TagOption.
createTagOption in interface AWSServiceCatalogpublic DeleteConstraintResult deleteConstraint(DeleteConstraintRequest request)
AWSServiceCatalogDeletes the specified constraint.
A delegated admin is authorized to invoke this command.
deleteConstraint in interface AWSServiceCatalogpublic DeletePortfolioResult deletePortfolio(DeletePortfolioRequest request)
AWSServiceCatalogDeletes 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.
deletePortfolio in interface AWSServiceCatalogpublic DeletePortfolioShareResult deletePortfolioShare(DeletePortfolioShareRequest request)
AWSServiceCatalogStops 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.
deletePortfolioShare in interface AWSServiceCatalogpublic DeleteProductResult deleteProduct(DeleteProductRequest request)
AWSServiceCatalogDeletes 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.
deleteProduct in interface AWSServiceCatalogpublic DeleteProvisionedProductPlanResult deleteProvisionedProductPlan(DeleteProvisionedProductPlanRequest request)
AWSServiceCatalogDeletes the specified plan.
deleteProvisionedProductPlan in interface AWSServiceCatalogpublic DeleteProvisioningArtifactResult deleteProvisioningArtifact(DeleteProvisioningArtifactRequest request)
AWSServiceCatalogDeletes 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.
deleteProvisioningArtifact in interface AWSServiceCatalogpublic DeleteServiceActionResult deleteServiceAction(DeleteServiceActionRequest request)
AWSServiceCatalogDeletes a self-service action.
deleteServiceAction in interface AWSServiceCatalogpublic DeleteTagOptionResult deleteTagOption(DeleteTagOptionRequest request)
AWSServiceCatalogDeletes the specified TagOption.
You cannot delete a TagOption if it is associated with a product or portfolio.
deleteTagOption in interface AWSServiceCatalogpublic DescribeConstraintResult describeConstraint(DescribeConstraintRequest request)
AWSServiceCatalogGets information about the specified constraint.
describeConstraint in interface AWSServiceCatalogpublic DescribeCopyProductStatusResult describeCopyProductStatus(DescribeCopyProductStatusRequest request)
AWSServiceCatalogGets the status of the specified copy product operation.
describeCopyProductStatus in interface AWSServiceCatalogpublic DescribePortfolioResult describePortfolio(DescribePortfolioRequest request)
AWSServiceCatalogGets information about the specified portfolio.
A delegated admin is authorized to invoke this command.
describePortfolio in interface AWSServiceCatalogpublic DescribePortfolioShareStatusResult describePortfolioShareStatus(DescribePortfolioShareStatusRequest request)
AWSServiceCatalogGets 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.
describePortfolioShareStatus in interface AWSServiceCatalogpublic DescribePortfolioSharesResult describePortfolioShares(DescribePortfolioSharesRequest request)
AWSServiceCatalogReturns 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.
describePortfolioShares in interface AWSServiceCatalogpublic DescribeProductResult describeProduct(DescribeProductRequest request)
AWSServiceCatalogGets information about the specified product.
Running this operation with administrator access results in a failure. DescribeProductAsAdmin should be used instead.
describeProduct in interface AWSServiceCatalogpublic DescribeProductAsAdminResult describeProductAsAdmin(DescribeProductAsAdminRequest request)
AWSServiceCatalogGets information about the specified product. This operation is run with administrator access.
describeProductAsAdmin in interface AWSServiceCatalogpublic DescribeProductViewResult describeProductView(DescribeProductViewRequest request)
AWSServiceCatalogGets information about the specified product.
describeProductView in interface AWSServiceCatalogpublic DescribeProvisionedProductResult describeProvisionedProduct(DescribeProvisionedProductRequest request)
AWSServiceCatalogGets information about the specified provisioned product.
describeProvisionedProduct in interface AWSServiceCatalogrequest - 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.public DescribeProvisionedProductPlanResult describeProvisionedProductPlan(DescribeProvisionedProductPlanRequest request)
AWSServiceCatalogGets information about the resource changes for the specified plan.
describeProvisionedProductPlan in interface AWSServiceCatalogpublic DescribeProvisioningArtifactResult describeProvisioningArtifact(DescribeProvisioningArtifactRequest request)
AWSServiceCatalogGets information about the specified provisioning artifact (also known as a version) for the specified product.
describeProvisioningArtifact in interface AWSServiceCatalogpublic DescribeProvisioningParametersResult describeProvisioningParameters(DescribeProvisioningParametersRequest request)
AWSServiceCatalogGets 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.
describeProvisioningParameters in interface AWSServiceCatalogpublic DescribeRecordResult describeRecord(DescribeRecordRequest request)
AWSServiceCatalogGets 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.
describeRecord in interface AWSServiceCatalogpublic DescribeServiceActionResult describeServiceAction(DescribeServiceActionRequest request)
AWSServiceCatalogDescribes a self-service action.
describeServiceAction in interface AWSServiceCatalogpublic DescribeServiceActionExecutionParametersResult describeServiceActionExecutionParameters(DescribeServiceActionExecutionParametersRequest request)
AWSServiceCatalogFinds the default parameters for a specific self-service action on a specific provisioned product and returns a map of the results to the user.
describeServiceActionExecutionParameters in interface AWSServiceCatalogpublic DescribeTagOptionResult describeTagOption(DescribeTagOptionRequest request)
AWSServiceCatalogGets information about the specified TagOption.
describeTagOption in interface AWSServiceCatalogpublic DisableAWSOrganizationsAccessResult disableAWSOrganizationsAccess(DisableAWSOrganizationsAccessRequest request)
AWSServiceCatalogDisable portfolio sharing through the Organizations service. This command will not delete your current shares, but prevents you from creating new shares throughout your organization. Current shares are not kept in sync with your organization structure if the structure changes after calling this API. Only the management account in the organization can call this API.
You cannot call this API if there are active delegated administrators in the organization.
Note that a delegated administrator is not authorized to invoke DisableAWSOrganizationsAccess.
If you share an Service Catalog portfolio in an organization within Organizations, and then disable Organizations access for Service Catalog, the portfolio access permissions will not sync with the latest changes to the organization structure. Specifically, accounts that you removed from the organization after disabling Service Catalog access will retain access to the previously shared portfolio.
disableAWSOrganizationsAccess in interface AWSServiceCatalogpublic DisassociateBudgetFromResourceResult disassociateBudgetFromResource(DisassociateBudgetFromResourceRequest request)
AWSServiceCatalogDisassociates the specified budget from the specified resource.
disassociateBudgetFromResource in interface AWSServiceCatalogpublic DisassociatePrincipalFromPortfolioResult disassociatePrincipalFromPortfolio(DisassociatePrincipalFromPortfolioRequest request)
AWSServiceCatalogDisassociates a previously associated principal ARN from a specified portfolio.
The PrincipalType and PrincipalARN must match the
AssociatePrincipalWithPortfolio call request details. For example, to disassociate an association
created with a PrincipalARN of PrincipalType IAM you must use the
PrincipalType IAM when calling DisassociatePrincipalFromPortfolio.
For portfolios that have been shared with principal name sharing enabled: after disassociating a principal, share recipient accounts will no longer be able to provision products in this portfolio using a role matching the name of the associated principal.
For more information, review associate-principal-with-portfolio in the Amazon Web Services CLI Command Reference.
If you disassociate a principal from a portfolio, with PrincipalType as IAM, the same principal will
still have access to the portfolio if it matches one of the associated principals of type
IAM_PATTERN. To fully remove access for a principal, verify all the associated Principals of type
IAM_PATTERN, and then ensure you disassociate any IAM_PATTERN principals that match the
principal whose access you are removing.
disassociatePrincipalFromPortfolio in interface AWSServiceCatalogpublic DisassociateProductFromPortfolioResult disassociateProductFromPortfolio(DisassociateProductFromPortfolioRequest request)
AWSServiceCatalogDisassociates the specified product from the specified portfolio.
A delegated admin is authorized to invoke this command.
disassociateProductFromPortfolio in interface AWSServiceCatalogpublic DisassociateServiceActionFromProvisioningArtifactResult disassociateServiceActionFromProvisioningArtifact(DisassociateServiceActionFromProvisioningArtifactRequest request)
AWSServiceCatalogDisassociates the specified self-service action association from the specified provisioning artifact.
disassociateServiceActionFromProvisioningArtifact in interface AWSServiceCatalogpublic DisassociateTagOptionFromResourceResult disassociateTagOptionFromResource(DisassociateTagOptionFromResourceRequest request)
AWSServiceCatalogDisassociates the specified TagOption from the specified resource.
disassociateTagOptionFromResource in interface AWSServiceCatalogpublic EnableAWSOrganizationsAccessResult enableAWSOrganizationsAccess(EnableAWSOrganizationsAccessRequest request)
AWSServiceCatalogEnable portfolio sharing feature through 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.
When you call this API, Service Catalog calls organizations:EnableAWSServiceAccess on your behalf so
that your shares stay in sync with any changes in your Organizations structure.
Note that a delegated administrator is not authorized to invoke EnableAWSOrganizationsAccess.
If you have previously disabled Organizations access for Service Catalog, and then enable access again, the portfolio access permissions might not sync with the latest changes to the organization structure. Specifically, accounts that you removed from the organization after disabling Service Catalog access, and before you enabled access again, can retain access to the previously shared portfolio. As a result, an account that has been removed from the organization might still be able to create or manage Amazon Web Services resources when it is no longer authorized to do so. Amazon Web Services is working to resolve this issue.
enableAWSOrganizationsAccess in interface AWSServiceCatalogpublic ExecuteProvisionedProductPlanResult executeProvisionedProductPlan(ExecuteProvisionedProductPlanRequest request)
AWSServiceCatalogProvisions or modifies a product based on the resource changes for the specified plan.
executeProvisionedProductPlan in interface AWSServiceCatalogpublic ExecuteProvisionedProductServiceActionResult executeProvisionedProductServiceAction(ExecuteProvisionedProductServiceActionRequest request)
AWSServiceCatalogExecutes a self-service action against a provisioned product.
executeProvisionedProductServiceAction in interface AWSServiceCatalogpublic GetAWSOrganizationsAccessStatusResult getAWSOrganizationsAccessStatus(GetAWSOrganizationsAccessStatusRequest request)
AWSServiceCatalogGet the Access Status for Organizations portfolio share feature. This API can only be called by the management account in the organization or by a delegated admin.
getAWSOrganizationsAccessStatus in interface AWSServiceCatalogpublic GetProvisionedProductOutputsResult getProvisionedProductOutputs(GetProvisionedProductOutputsRequest request)
AWSServiceCatalog
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.
getProvisionedProductOutputs in interface AWSServiceCatalogpublic ImportAsProvisionedProductResult importAsProvisionedProduct(ImportAsProvisionedProductRequest request)
AWSServiceCatalogRequests the import of a resource as an Service Catalog provisioned product that is associated to an Service Catalog product and provisioning artifact. Once imported, all supported 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, and
IMPORT_ROLLBACK_COMPLETE.
Import of the resource requires that the CloudFormation stack template matches the associated Service Catalog product provisioning artifact.
When you import an existing CloudFormation stack into a portfolio, Service Catalog does not apply the product's
associated constraints during the import process. Service Catalog applies the constraints after you call
UpdateProvisionedProduct for the provisioned product.
The user or role that performs this operation must have the cloudformation:GetTemplate and
cloudformation:DescribeStacks IAM policy permissions.
You can only import one provisioned product at a time. The product's CloudFormation stack must have the
IMPORT_COMPLETE status before you import another.
importAsProvisionedProduct in interface AWSServiceCatalogpublic ListAcceptedPortfolioSharesResult listAcceptedPortfolioShares(ListAcceptedPortfolioSharesRequest request)
AWSServiceCatalog
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.
listAcceptedPortfolioShares in interface AWSServiceCatalogpublic ListBudgetsForResourceResult listBudgetsForResource(ListBudgetsForResourceRequest request)
AWSServiceCatalogLists all the budgets associated to the specified resource.
listBudgetsForResource in interface AWSServiceCatalogpublic ListConstraintsForPortfolioResult listConstraintsForPortfolio(ListConstraintsForPortfolioRequest request)
AWSServiceCatalogLists the constraints for the specified portfolio and product.
listConstraintsForPortfolio in interface AWSServiceCatalogpublic ListLaunchPathsResult listLaunchPaths(ListLaunchPathsRequest request)
AWSServiceCatalogLists the paths to the specified product. A path describes how the user gets access to a specified product and is necessary when provisioning a product. A path also determines the constraints that are put on a product. A path is dependent on a specific product, porfolio, and principal.
When provisioning a product that's been added to a portfolio, you must grant your user, group, or role access to the portfolio. For more information, see Granting users access in the Service Catalog User Guide.
listLaunchPaths in interface AWSServiceCatalogpublic ListOrganizationPortfolioAccessResult listOrganizationPortfolioAccess(ListOrganizationPortfolioAccessRequest request)
AWSServiceCatalogLists 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.
listOrganizationPortfolioAccess in interface AWSServiceCatalogpublic ListPortfolioAccessResult listPortfolioAccess(ListPortfolioAccessRequest request)
AWSServiceCatalogLists 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.
listPortfolioAccess in interface AWSServiceCatalogpublic ListPortfoliosResult listPortfolios(ListPortfoliosRequest request)
AWSServiceCatalogLists all portfolios in the catalog.
listPortfolios in interface AWSServiceCatalogpublic ListPortfoliosForProductResult listPortfoliosForProduct(ListPortfoliosForProductRequest request)
AWSServiceCatalogLists all portfolios that the specified product is associated with.
listPortfoliosForProduct in interface AWSServiceCatalogpublic ListPrincipalsForPortfolioResult listPrincipalsForPortfolio(ListPrincipalsForPortfolioRequest request)
AWSServiceCatalog
Lists all PrincipalARNs and corresponding PrincipalTypes associated with the specified
portfolio.
listPrincipalsForPortfolio in interface AWSServiceCatalogpublic ListProvisionedProductPlansResult listProvisionedProductPlans(ListProvisionedProductPlansRequest request)
AWSServiceCatalogLists the plans for the specified provisioned product or all plans to which the user has access.
listProvisionedProductPlans in interface AWSServiceCatalogpublic ListProvisioningArtifactsResult listProvisioningArtifacts(ListProvisioningArtifactsRequest request)
AWSServiceCatalogLists all provisioning artifacts (also known as versions) for the specified product.
listProvisioningArtifacts in interface AWSServiceCatalogpublic ListProvisioningArtifactsForServiceActionResult listProvisioningArtifactsForServiceAction(ListProvisioningArtifactsForServiceActionRequest request)
AWSServiceCatalogLists all provisioning artifacts (also known as versions) for the specified self-service action.
listProvisioningArtifactsForServiceAction in interface AWSServiceCatalogpublic ListRecordHistoryResult listRecordHistory(ListRecordHistoryRequest request)
AWSServiceCatalogLists the specified requests or all performed requests.
listRecordHistory in interface AWSServiceCatalogpublic ListResourcesForTagOptionResult listResourcesForTagOption(ListResourcesForTagOptionRequest request)
AWSServiceCatalogLists the resources associated with the specified TagOption.
listResourcesForTagOption in interface AWSServiceCatalogpublic ListServiceActionsResult listServiceActions(ListServiceActionsRequest request)
AWSServiceCatalogLists all self-service actions.
listServiceActions in interface AWSServiceCatalogpublic ListServiceActionsForProvisioningArtifactResult listServiceActionsForProvisioningArtifact(ListServiceActionsForProvisioningArtifactRequest request)
AWSServiceCatalogReturns a paginated list of self-service actions associated with the specified Product ID and Provisioning Artifact ID.
listServiceActionsForProvisioningArtifact in interface AWSServiceCatalogpublic ListStackInstancesForProvisionedProductResult listStackInstancesForProvisionedProduct(ListStackInstancesForProvisionedProductRequest request)
AWSServiceCatalog
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 Amazon Web Services account name or Region.
listStackInstancesForProvisionedProduct in interface AWSServiceCatalogpublic ListTagOptionsResult listTagOptions(ListTagOptionsRequest request)
AWSServiceCatalogLists the specified TagOptions or all TagOptions.
listTagOptions in interface AWSServiceCatalogpublic NotifyProvisionProductEngineWorkflowResultResult notifyProvisionProductEngineWorkflowResult(NotifyProvisionProductEngineWorkflowResultRequest request)
AWSServiceCatalogNotifies the result of the provisioning engine execution.
notifyProvisionProductEngineWorkflowResult in interface AWSServiceCatalogpublic NotifyTerminateProvisionedProductEngineWorkflowResultResult notifyTerminateProvisionedProductEngineWorkflowResult(NotifyTerminateProvisionedProductEngineWorkflowResultRequest request)
AWSServiceCatalogNotifies the result of the terminate engine execution.
notifyTerminateProvisionedProductEngineWorkflowResult in interface AWSServiceCatalogpublic NotifyUpdateProvisionedProductEngineWorkflowResultResult notifyUpdateProvisionedProductEngineWorkflowResult(NotifyUpdateProvisionedProductEngineWorkflowResultRequest request)
AWSServiceCatalogNotifies the result of the update engine execution.
notifyUpdateProvisionedProductEngineWorkflowResult in interface AWSServiceCatalogpublic ProvisionProductResult provisionProduct(ProvisionProductRequest request)
AWSServiceCatalogProvisions the specified product.
A provisioned product is a resourced instance of a product. For example, provisioning a product that's based on an CloudFormation template launches an 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's a tag conflict for that key. Don't include conflicted keys as tags, or this will cause the error "Parameter validation failed: Missing required parameter in Tags[N]:Value".
When provisioning a product that's been added to a portfolio, you must grant your user, group, or role access to the portfolio. For more information, see Granting users access in the Service Catalog User Guide.
provisionProduct in interface AWSServiceCatalogpublic RejectPortfolioShareResult rejectPortfolioShare(RejectPortfolioShareRequest request)
AWSServiceCatalogRejects an offer to share the specified portfolio.
rejectPortfolioShare in interface AWSServiceCatalogpublic ScanProvisionedProductsResult scanProvisionedProducts(ScanProvisionedProductsRequest request)
AWSServiceCatalogLists the provisioned products that are available (not terminated).
To use additional filtering, see SearchProvisionedProducts.
scanProvisionedProducts in interface AWSServiceCatalogpublic SearchProductsResult searchProducts(SearchProductsRequest request)
AWSServiceCatalogGets information about the products to which the caller has access.
searchProducts in interface AWSServiceCatalogpublic SearchProductsAsAdminResult searchProductsAsAdmin(SearchProductsAsAdminRequest request)
AWSServiceCatalogGets information about the products for the specified portfolio or all products.
searchProductsAsAdmin in interface AWSServiceCatalogpublic SearchProvisionedProductsResult searchProvisionedProducts(SearchProvisionedProductsRequest request)
AWSServiceCatalogGets information about the provisioned products that meet the specified criteria.
searchProvisionedProducts in interface AWSServiceCatalogpublic TerminateProvisionedProductResult terminateProvisionedProduct(TerminateProvisionedProductRequest request)
AWSServiceCatalogTerminates 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.
terminateProvisionedProduct in interface AWSServiceCatalogpublic UpdateConstraintResult updateConstraint(UpdateConstraintRequest request)
AWSServiceCatalogUpdates the specified constraint.
updateConstraint in interface AWSServiceCatalogpublic UpdatePortfolioResult updatePortfolio(UpdatePortfolioRequest request)
AWSServiceCatalogUpdates the specified portfolio.
You cannot update a product that was shared with you.
updatePortfolio in interface AWSServiceCatalogpublic UpdatePortfolioShareResult updatePortfolioShare(UpdatePortfolioShareRequest request)
AWSServiceCatalog
Updates the specified portfolio share. You can use this API to enable or disable TagOptions sharing
or Principal 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.
When you associate a principal with portfolio, a potential privilege escalation path may occur when that
portfolio is then shared with other accounts. For a user in a recipient account who is not an Service
Catalog Admin, but still has the ability to create Principals (Users/Groups/Roles), that user could create a role
that matches a principal name association for the portfolio. Although this user may not know which principal
names are associated through Service Catalog, they may be able to guess the user. If this potential escalation
path is a concern, then Service Catalog recommends using PrincipalType as IAM. With
this configuration, the PrincipalARN must already exist in the recipient account before it can be
associated.
updatePortfolioShare in interface AWSServiceCatalogpublic UpdateProductResult updateProduct(UpdateProductRequest request)
AWSServiceCatalogUpdates the specified product.
updateProduct in interface AWSServiceCatalogpublic UpdateProvisionedProductResult updateProvisionedProduct(UpdateProvisionedProductRequest request)
AWSServiceCatalogRequests 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.
updateProvisionedProduct in interface AWSServiceCatalogpublic UpdateProvisionedProductPropertiesResult updateProvisionedProductProperties(UpdateProvisionedProductPropertiesRequest request)
AWSServiceCatalogRequests updates to the properties of the specified provisioned product.
updateProvisionedProductProperties in interface AWSServiceCatalogpublic UpdateProvisioningArtifactResult updateProvisioningArtifact(UpdateProvisioningArtifactRequest request)
AWSServiceCatalogUpdates 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.
updateProvisioningArtifact in interface AWSServiceCatalogpublic UpdateServiceActionResult updateServiceAction(UpdateServiceActionRequest request)
AWSServiceCatalogUpdates a self-service action.
updateServiceAction in interface AWSServiceCatalogpublic UpdateTagOptionResult updateTagOption(UpdateTagOptionRequest request)
AWSServiceCatalogUpdates the specified TagOption.
updateTagOption in interface AWSServiceCatalogpublic void shutdown()
AWSServiceCatalogshutdown in interface AWSServiceCatalogpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSServiceCatalogResponse 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.
getCachedResponseMetadata in interface AWSServiceCatalogrequest - The originally executed request.