@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSServiceCatalogClient extends AmazonWebServiceClient implements AWSServiceCatalog
Service Catalog enables organizations to create and manage catalogs of IT services that are approved for Amazon Web Services. To get the most out of this documentation, you should be familiar with the terminology discussed in Service Catalog Concepts.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Constructor and Description |
|---|
AWSServiceCatalogClient()
Deprecated.
|
AWSServiceCatalogClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AWSServiceCatalogClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AWSServiceCatalogClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AWSServiceCatalogClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AWSServiceCatalogClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AWSServiceCatalogClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AWSServiceCatalogClient(ClientConfiguration clientConfiguration)
Deprecated.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion@Deprecated public AWSServiceCatalogClient()
AWSServiceCatalogClientBuilder.defaultClient()All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain@Deprecated public AWSServiceCatalogClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling how this client connects to AWS Service Catalog (ex: proxy
settings, retry counts, etc.).DefaultAWSCredentialsProviderChain@Deprecated public AWSServiceCatalogClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AWSServiceCatalogClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AWSServiceCatalogClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration - The client configuration options controlling how this client connects to AWS Service Catalog (ex: proxy
settings, retry counts, etc.).@Deprecated public AWSServiceCatalogClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AWSServiceCatalogClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to AWS Service Catalog (ex: proxy
settings, retry counts, etc.).@Deprecated public AWSServiceCatalogClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to AWS Service Catalog (ex: proxy
settings, retry counts, etc.).requestMetricCollector - optional request metric collectorpublic static AWSServiceCatalogClientBuilder builder()
public AcceptPortfolioShareResult acceptPortfolioShare(AcceptPortfolioShareRequest request)
Accepts an offer to share the specified portfolio.
acceptPortfolioShare in interface AWSServiceCatalogacceptPortfolioShareRequest - 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.public AssociateBudgetWithResourceResult associateBudgetWithResource(AssociateBudgetWithResourceRequest request)
Associates the specified budget with the specified resource.
associateBudgetWithResource in interface AWSServiceCatalogassociateBudgetWithResourceRequest - 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.public AssociatePrincipalWithPortfolioResult associatePrincipalWithPortfolio(AssociatePrincipalWithPortfolioRequest request)
Associates 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 AWSServiceCatalogassociatePrincipalWithPortfolioRequest - 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.public AssociateProductWithPortfolioResult associateProductWithPortfolio(AssociateProductWithPortfolioRequest request)
Associates the specified product with the specified portfolio.
A delegated admin is authorized to invoke this command.
associateProductWithPortfolio in interface AWSServiceCatalogassociateProductWithPortfolioRequest - 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.public AssociateServiceActionWithProvisioningArtifactResult associateServiceActionWithProvisioningArtifact(AssociateServiceActionWithProvisioningArtifactRequest request)
Associates a self-service action with a provisioning artifact.
associateServiceActionWithProvisioningArtifact in interface AWSServiceCatalogassociateServiceActionWithProvisioningArtifactRequest - 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.InvalidParametersException - One or more parameters provided to the operation are not valid.public AssociateTagOptionWithResourceResult associateTagOptionWithResource(AssociateTagOptionWithResourceRequest request)
Associate the specified TagOption with the specified portfolio or product.
associateTagOptionWithResource in interface AWSServiceCatalogassociateTagOptionWithResourceRequest - TagOptionNotMigratedException - An operation requiring TagOptions failed because the TagOptions migration process has not been performed
for this account. Use the Amazon Web Services Management 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.public BatchAssociateServiceActionWithProvisioningArtifactResult batchAssociateServiceActionWithProvisioningArtifact(BatchAssociateServiceActionWithProvisioningArtifactRequest request)
Associates multiple self-service actions with provisioning artifacts.
batchAssociateServiceActionWithProvisioningArtifact in interface AWSServiceCatalogbatchAssociateServiceActionWithProvisioningArtifactRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.public BatchDisassociateServiceActionFromProvisioningArtifactResult batchDisassociateServiceActionFromProvisioningArtifact(BatchDisassociateServiceActionFromProvisioningArtifactRequest request)
Disassociates a batch of self-service actions from the specified provisioning artifact.
batchDisassociateServiceActionFromProvisioningArtifact in interface AWSServiceCatalogbatchDisassociateServiceActionFromProvisioningArtifactRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.public CopyProductResult copyProduct(CopyProductRequest request)
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. 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 AWSServiceCatalogcopyProductRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.public CreateConstraintResult createConstraint(CreateConstraintRequest request)
Creates a constraint.
A delegated admin is authorized to invoke this command.
createConstraint in interface AWSServiceCatalogcreateConstraintRequest - 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.public CreatePortfolioResult createPortfolio(CreatePortfolioRequest request)
Creates a portfolio.
A delegated admin is authorized to invoke this command.
createPortfolio in interface AWSServiceCatalogcreatePortfolioRequest - 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. Use the Amazon Web Services Management Console to perform the migration process before
retrying the operation.public CreatePortfolioShareResult createPortfolioShare(CreatePortfolioShareRequest request)
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.
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 AWSServiceCatalogcreatePortfolioShareRequest - 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.public CreateProductResult createProduct(CreateProductRequest request)
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.
createProduct in interface AWSServiceCatalogcreateProductRequest - 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. Use the Amazon Web Services Management Console to perform the migration process before
retrying the operation.public CreateProvisionedProductPlanResult createProvisionedProductPlan(CreateProvisionedProductPlanRequest request)
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 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 AWSServiceCatalogcreateProvisionedProductPlanRequest - 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.public CreateProvisioningArtifactResult createProvisioningArtifact(CreateProvisioningArtifactRequest request)
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.
createProvisioningArtifact in interface AWSServiceCatalogcreateProvisioningArtifactRequest - 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.public CreateServiceActionResult createServiceAction(CreateServiceActionRequest request)
Creates a self-service action.
createServiceAction in interface AWSServiceCatalogcreateServiceActionRequest - 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.public CreateTagOptionResult createTagOption(CreateTagOptionRequest request)
Creates a TagOption.
createTagOption in interface AWSServiceCatalogcreateTagOptionRequest - TagOptionNotMigratedException - An operation requiring TagOptions failed because the TagOptions migration process has not been performed
for this account. Use the Amazon Web Services Management 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.public DeleteConstraintResult deleteConstraint(DeleteConstraintRequest request)
Deletes the specified constraint.
A delegated admin is authorized to invoke this command.
deleteConstraint in interface AWSServiceCatalogdeleteConstraintRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.public DeletePortfolioResult deletePortfolio(DeletePortfolioRequest request)
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.
deletePortfolio in interface AWSServiceCatalogdeletePortfolioRequest - 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. Use the Amazon Web Services Management Console to perform the migration process before
retrying the operation.public DeletePortfolioShareResult deletePortfolioShare(DeletePortfolioShareRequest request)
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.
deletePortfolioShare in interface AWSServiceCatalogdeletePortfolioShareRequest - 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.public DeleteProductResult deleteProduct(DeleteProductRequest request)
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.
deleteProduct in interface AWSServiceCatalogdeleteProductRequest - 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. Use the Amazon Web Services Management Console to perform the migration process before
retrying the operation.public DeleteProvisionedProductPlanResult deleteProvisionedProductPlan(DeleteProvisionedProductPlanRequest request)
Deletes the specified plan.
deleteProvisionedProductPlan in interface AWSServiceCatalogdeleteProvisionedProductPlanRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.public DeleteProvisioningArtifactResult deleteProvisioningArtifact(DeleteProvisioningArtifactRequest request)
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.
deleteProvisioningArtifact in interface AWSServiceCatalogdeleteProvisioningArtifactRequest - 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.public DeleteServiceActionResult deleteServiceAction(DeleteServiceActionRequest request)
Deletes a self-service action.
deleteServiceAction in interface AWSServiceCatalogdeleteServiceActionRequest - 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.public DeleteTagOptionResult deleteTagOption(DeleteTagOptionRequest request)
Deletes the specified TagOption.
You cannot delete a TagOption if it is associated with a product or portfolio.
deleteTagOption in interface AWSServiceCatalogdeleteTagOptionRequest - TagOptionNotMigratedException - An operation requiring TagOptions failed because the TagOptions migration process has not been performed
for this account. Use the Amazon Web Services Management 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.public DescribeConstraintResult describeConstraint(DescribeConstraintRequest request)
Gets information about the specified constraint.
describeConstraint in interface AWSServiceCatalogdescribeConstraintRequest - ResourceNotFoundException - The specified resource was not found.public DescribeCopyProductStatusResult describeCopyProductStatus(DescribeCopyProductStatusRequest request)
Gets the status of the specified copy product operation.
describeCopyProductStatus in interface AWSServiceCatalogdescribeCopyProductStatusRequest - ResourceNotFoundException - The specified resource was not found.public DescribePortfolioResult describePortfolio(DescribePortfolioRequest request)
Gets information about the specified portfolio.
A delegated admin is authorized to invoke this command.
describePortfolio in interface AWSServiceCatalogdescribePortfolioRequest - ResourceNotFoundException - The specified resource was not found.public DescribePortfolioShareStatusResult describePortfolioShareStatus(DescribePortfolioShareStatusRequest request)
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.
describePortfolioShareStatus in interface AWSServiceCatalogdescribePortfolioShareStatusRequest - 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.public DescribePortfolioSharesResult describePortfolioShares(DescribePortfolioSharesRequest request)
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.
describePortfolioShares in interface AWSServiceCatalogdescribePortfolioSharesRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.public DescribeProductResult describeProduct(DescribeProductRequest request)
Gets information about the specified product.
Running this operation with administrator access results in a failure. DescribeProductAsAdmin should be used instead.
describeProduct in interface AWSServiceCatalogdescribeProductRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.public DescribeProductAsAdminResult describeProductAsAdmin(DescribeProductAsAdminRequest request)
Gets information about the specified product. This operation is run with administrator access.
describeProductAsAdmin in interface AWSServiceCatalogdescribeProductAsAdminRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.public DescribeProductViewResult describeProductView(DescribeProductViewRequest request)
Gets information about the specified product.
describeProductView in interface AWSServiceCatalogdescribeProductViewRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.public DescribeProvisionedProductResult describeProvisionedProduct(DescribeProvisionedProductRequest request)
Gets information about the specified provisioned product.
describeProvisionedProduct in interface AWSServiceCatalogdescribeProvisionedProductRequest - 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.public DescribeProvisionedProductPlanResult describeProvisionedProductPlan(DescribeProvisionedProductPlanRequest request)
Gets information about the resource changes for the specified plan.
describeProvisionedProductPlan in interface AWSServiceCatalogdescribeProvisionedProductPlanRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.public DescribeProvisioningArtifactResult describeProvisioningArtifact(DescribeProvisioningArtifactRequest request)
Gets information about the specified provisioning artifact (also known as a version) for the specified product.
describeProvisioningArtifact in interface AWSServiceCatalogdescribeProvisioningArtifactRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.public DescribeProvisioningParametersResult describeProvisioningParameters(DescribeProvisioningParametersRequest request)
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.
describeProvisioningParameters in interface AWSServiceCatalogdescribeProvisioningParametersRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.public DescribeRecordResult describeRecord(DescribeRecordRequest request)
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.
describeRecord in interface AWSServiceCatalogdescribeRecordRequest - ResourceNotFoundException - The specified resource was not found.public DescribeServiceActionResult describeServiceAction(DescribeServiceActionRequest request)
Describes a self-service action.
describeServiceAction in interface AWSServiceCatalogdescribeServiceActionRequest - ResourceNotFoundException - The specified resource was not found.public DescribeServiceActionExecutionParametersResult describeServiceActionExecutionParameters(DescribeServiceActionExecutionParametersRequest request)
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.
describeServiceActionExecutionParameters in interface AWSServiceCatalogdescribeServiceActionExecutionParametersRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.public DescribeTagOptionResult describeTagOption(DescribeTagOptionRequest request)
Gets information about the specified TagOption.
describeTagOption in interface AWSServiceCatalogdescribeTagOptionRequest - TagOptionNotMigratedException - An operation requiring TagOptions failed because the TagOptions migration process has not been performed
for this account. Use the Amazon Web Services Management Console to perform the migration process before
retrying the operation.ResourceNotFoundException - The specified resource was not found.public DisableAWSOrganizationsAccessResult disableAWSOrganizationsAccess(DisableAWSOrganizationsAccessRequest request)
Disable 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 AWSServiceCatalogdisableAWSOrganizationsAccessRequest - 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.public DisassociateBudgetFromResourceResult disassociateBudgetFromResource(DisassociateBudgetFromResourceRequest request)
Disassociates the specified budget from the specified resource.
disassociateBudgetFromResource in interface AWSServiceCatalogdisassociateBudgetFromResourceRequest - ResourceNotFoundException - The specified resource was not found.public DisassociatePrincipalFromPortfolioResult disassociatePrincipalFromPortfolio(DisassociatePrincipalFromPortfolioRequest request)
Disassociates 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 AWSServiceCatalogdisassociatePrincipalFromPortfolioRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.public DisassociateProductFromPortfolioResult disassociateProductFromPortfolio(DisassociateProductFromPortfolioRequest request)
Disassociates the specified product from the specified portfolio.
A delegated admin is authorized to invoke this command.
disassociateProductFromPortfolio in interface AWSServiceCatalogdisassociateProductFromPortfolioRequest - 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.public DisassociateServiceActionFromProvisioningArtifactResult disassociateServiceActionFromProvisioningArtifact(DisassociateServiceActionFromProvisioningArtifactRequest request)
Disassociates the specified self-service action association from the specified provisioning artifact.
disassociateServiceActionFromProvisioningArtifact in interface AWSServiceCatalogdisassociateServiceActionFromProvisioningArtifactRequest - ResourceNotFoundException - The specified resource was not found.public DisassociateTagOptionFromResourceResult disassociateTagOptionFromResource(DisassociateTagOptionFromResourceRequest request)
Disassociates the specified TagOption from the specified resource.
disassociateTagOptionFromResource in interface AWSServiceCatalogdisassociateTagOptionFromResourceRequest - TagOptionNotMigratedException - An operation requiring TagOptions failed because the TagOptions migration process has not been performed
for this account. Use the Amazon Web Services Management Console to perform the migration process before
retrying the operation.ResourceNotFoundException - The specified resource was not found.public EnableAWSOrganizationsAccessResult enableAWSOrganizationsAccess(EnableAWSOrganizationsAccessRequest request)
Enable 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 AWSServiceCatalogenableAWSOrganizationsAccessRequest - 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.public ExecuteProvisionedProductPlanResult executeProvisionedProductPlan(ExecuteProvisionedProductPlanRequest request)
Provisions or modifies a product based on the resource changes for the specified plan.
executeProvisionedProductPlan in interface AWSServiceCatalogexecuteProvisionedProductPlanRequest - 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.public ExecuteProvisionedProductServiceActionResult executeProvisionedProductServiceAction(ExecuteProvisionedProductServiceActionRequest request)
Executes a self-service action against a provisioned product.
executeProvisionedProductServiceAction in interface AWSServiceCatalogexecuteProvisionedProductServiceActionRequest - 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.public GetAWSOrganizationsAccessStatusResult getAWSOrganizationsAccessStatus(GetAWSOrganizationsAccessStatusRequest request)
Get 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 AWSServiceCataloggetAWSOrganizationsAccessStatusRequest - ResourceNotFoundException - The specified resource was not found.OperationNotSupportedException - The operation is not supported.public GetProvisionedProductOutputsResult getProvisionedProductOutputs(GetProvisionedProductOutputsRequest request)
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 AWSServiceCataloggetProvisionedProductOutputsRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.public ImportAsProvisionedProductResult importAsProvisionedProduct(ImportAsProvisionedProductRequest request)
Requests 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 AWSServiceCatalogimportAsProvisionedProductRequest - 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.public ListAcceptedPortfolioSharesResult listAcceptedPortfolioShares(ListAcceptedPortfolioSharesRequest request)
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 AWSServiceCataloglistAcceptedPortfolioSharesRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.OperationNotSupportedException - The operation is not supported.public ListBudgetsForResourceResult listBudgetsForResource(ListBudgetsForResourceRequest request)
Lists all the budgets associated to the specified resource.
listBudgetsForResource in interface AWSServiceCataloglistBudgetsForResourceRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.public ListConstraintsForPortfolioResult listConstraintsForPortfolio(ListConstraintsForPortfolioRequest request)
Lists the constraints for the specified portfolio and product.
listConstraintsForPortfolio in interface AWSServiceCataloglistConstraintsForPortfolioRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.public ListLaunchPathsResult listLaunchPaths(ListLaunchPathsRequest request)
Lists 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 AWSServiceCataloglistLaunchPathsRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.public ListOrganizationPortfolioAccessResult listOrganizationPortfolioAccess(ListOrganizationPortfolioAccessRequest request)
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.
listOrganizationPortfolioAccess in interface AWSServiceCataloglistOrganizationPortfolioAccessRequest - 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.public ListPortfolioAccessResult listPortfolioAccess(ListPortfolioAccessRequest request)
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.
listPortfolioAccess in interface AWSServiceCataloglistPortfolioAccessRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.public ListPortfoliosResult listPortfolios(ListPortfoliosRequest request)
Lists all portfolios in the catalog.
listPortfolios in interface AWSServiceCataloglistPortfoliosRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.public ListPortfoliosForProductResult listPortfoliosForProduct(ListPortfoliosForProductRequest request)
Lists all portfolios that the specified product is associated with.
listPortfoliosForProduct in interface AWSServiceCataloglistPortfoliosForProductRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.public ListPrincipalsForPortfolioResult listPrincipalsForPortfolio(ListPrincipalsForPortfolioRequest request)
Lists all PrincipalARNs and corresponding PrincipalTypes associated with the specified
portfolio.
listPrincipalsForPortfolio in interface AWSServiceCataloglistPrincipalsForPortfolioRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.public ListProvisionedProductPlansResult listProvisionedProductPlans(ListProvisionedProductPlansRequest request)
Lists the plans for the specified provisioned product or all plans to which the user has access.
listProvisionedProductPlans in interface AWSServiceCataloglistProvisionedProductPlansRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.public ListProvisioningArtifactsResult listProvisioningArtifacts(ListProvisioningArtifactsRequest request)
Lists all provisioning artifacts (also known as versions) for the specified product.
listProvisioningArtifacts in interface AWSServiceCataloglistProvisioningArtifactsRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.public ListProvisioningArtifactsForServiceActionResult listProvisioningArtifactsForServiceAction(ListProvisioningArtifactsForServiceActionRequest request)
Lists all provisioning artifacts (also known as versions) for the specified self-service action.
listProvisioningArtifactsForServiceAction in interface AWSServiceCataloglistProvisioningArtifactsForServiceActionRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.public ListRecordHistoryResult listRecordHistory(ListRecordHistoryRequest request)
Lists the specified requests or all performed requests.
listRecordHistory in interface AWSServiceCataloglistRecordHistoryRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.public ListResourcesForTagOptionResult listResourcesForTagOption(ListResourcesForTagOptionRequest request)
Lists the resources associated with the specified TagOption.
listResourcesForTagOption in interface AWSServiceCataloglistResourcesForTagOptionRequest - TagOptionNotMigratedException - An operation requiring TagOptions failed because the TagOptions migration process has not been performed
for this account. Use the Amazon Web Services Management 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.public ListServiceActionsResult listServiceActions(ListServiceActionsRequest request)
Lists all self-service actions.
listServiceActions in interface AWSServiceCataloglistServiceActionsRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.public ListServiceActionsForProvisioningArtifactResult listServiceActionsForProvisioningArtifact(ListServiceActionsForProvisioningArtifactRequest request)
Returns a paginated list of self-service actions associated with the specified Product ID and Provisioning Artifact ID.
listServiceActionsForProvisioningArtifact in interface AWSServiceCataloglistServiceActionsForProvisioningArtifactRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.public ListStackInstancesForProvisionedProductResult listStackInstancesForProvisionedProduct(ListStackInstancesForProvisionedProductRequest request)
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 AWSServiceCataloglistStackInstancesForProvisionedProductRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.public ListTagOptionsResult listTagOptions(ListTagOptionsRequest request)
Lists the specified TagOptions or all TagOptions.
listTagOptions in interface AWSServiceCataloglistTagOptionsRequest - TagOptionNotMigratedException - An operation requiring TagOptions failed because the TagOptions migration process has not been performed
for this account. Use the Amazon Web Services Management Console to perform the migration process before
retrying the operation.InvalidParametersException - One or more parameters provided to the operation are not valid.public NotifyProvisionProductEngineWorkflowResultResult notifyProvisionProductEngineWorkflowResult(NotifyProvisionProductEngineWorkflowResultRequest request)
Notifies the result of the provisioning engine execution.
notifyProvisionProductEngineWorkflowResult in interface AWSServiceCatalognotifyProvisionProductEngineWorkflowResultRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.public NotifyTerminateProvisionedProductEngineWorkflowResultResult notifyTerminateProvisionedProductEngineWorkflowResult(NotifyTerminateProvisionedProductEngineWorkflowResultRequest request)
Notifies the result of the terminate engine execution.
notifyTerminateProvisionedProductEngineWorkflowResult in interface AWSServiceCatalognotifyTerminateProvisionedProductEngineWorkflowResultRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.public NotifyUpdateProvisionedProductEngineWorkflowResultResult notifyUpdateProvisionedProductEngineWorkflowResult(NotifyUpdateProvisionedProductEngineWorkflowResultRequest request)
Notifies the result of the update engine execution.
notifyUpdateProvisionedProductEngineWorkflowResult in interface AWSServiceCatalognotifyUpdateProvisionedProductEngineWorkflowResultRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.public ProvisionProductResult provisionProduct(ProvisionProductRequest request)
Provisions 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 AWSServiceCatalogprovisionProductRequest - 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.public RejectPortfolioShareResult rejectPortfolioShare(RejectPortfolioShareRequest request)
Rejects an offer to share the specified portfolio.
rejectPortfolioShare in interface AWSServiceCatalogrejectPortfolioShareRequest - ResourceNotFoundException - The specified resource was not found.public ScanProvisionedProductsResult scanProvisionedProducts(ScanProvisionedProductsRequest request)
Lists the provisioned products that are available (not terminated).
To use additional filtering, see SearchProvisionedProducts.
scanProvisionedProducts in interface AWSServiceCatalogscanProvisionedProductsRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.public SearchProductsResult searchProducts(SearchProductsRequest request)
Gets information about the products to which the caller has access.
searchProducts in interface AWSServiceCatalogsearchProductsRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.public SearchProductsAsAdminResult searchProductsAsAdmin(SearchProductsAsAdminRequest request)
Gets information about the products for the specified portfolio or all products.
searchProductsAsAdmin in interface AWSServiceCatalogsearchProductsAsAdminRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.public SearchProvisionedProductsResult searchProvisionedProducts(SearchProvisionedProductsRequest request)
Gets information about the provisioned products that meet the specified criteria.
searchProvisionedProducts in interface AWSServiceCatalogsearchProvisionedProductsRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.public TerminateProvisionedProductResult terminateProvisionedProduct(TerminateProvisionedProductRequest request)
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.
terminateProvisionedProduct in interface AWSServiceCatalogterminateProvisionedProductRequest - ResourceNotFoundException - The specified resource was not found.public UpdateConstraintResult updateConstraint(UpdateConstraintRequest request)
Updates the specified constraint.
updateConstraint in interface AWSServiceCatalogupdateConstraintRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.public UpdatePortfolioResult updatePortfolio(UpdatePortfolioRequest request)
Updates the specified portfolio.
You cannot update a product that was shared with you.
updatePortfolio in interface AWSServiceCatalogupdatePortfolioRequest - 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. Use the Amazon Web Services Management Console to perform the migration process before
retrying the operation.public UpdatePortfolioShareResult updatePortfolioShare(UpdatePortfolioShareRequest request)
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 AWSServiceCatalogupdatePortfolioShareRequest - 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.public UpdateProductResult updateProduct(UpdateProductRequest request)
Updates the specified product.
updateProduct in interface AWSServiceCatalogupdateProductRequest - 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. Use the Amazon Web Services Management Console to perform the migration process before
retrying the operation.public UpdateProvisionedProductResult updateProvisionedProduct(UpdateProvisionedProductRequest request)
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.
updateProvisionedProduct in interface AWSServiceCatalogupdateProvisionedProductRequest - InvalidParametersException - One or more parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.public UpdateProvisionedProductPropertiesResult updateProvisionedProductProperties(UpdateProvisionedProductPropertiesRequest request)
Requests updates to the properties of the specified provisioned product.
updateProvisionedProductProperties in interface AWSServiceCatalogupdateProvisionedProductPropertiesRequest - 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.public UpdateProvisioningArtifactResult updateProvisioningArtifact(UpdateProvisioningArtifactRequest request)
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.
updateProvisioningArtifact in interface AWSServiceCatalogupdateProvisioningArtifactRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.public UpdateServiceActionResult updateServiceAction(UpdateServiceActionRequest request)
Updates a self-service action.
updateServiceAction in interface AWSServiceCatalogupdateServiceActionRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.public UpdateTagOptionResult updateTagOption(UpdateTagOptionRequest request)
Updates the specified TagOption.
updateTagOption in interface AWSServiceCatalogupdateTagOptionRequest - TagOptionNotMigratedException - An operation requiring TagOptions failed because the TagOptions migration process has not been performed
for this account. Use the Amazon Web Services Management 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.public 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 the request.
getCachedResponseMetadata in interface AWSServiceCatalogrequest - The originally executed requestpublic void shutdown()
AmazonWebServiceClientshutdown in interface AWSServiceCatalogshutdown in class AmazonWebServiceClient