@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSServiceCatalogClient extends AmazonWebServiceClient implements AWSServiceCatalog
AWS Service Catalog enables organizations to create and manage catalogs of IT services that are approved for use on AWS. To get the most out of this documentation, you should be familiar with the terminology discussed in AWS 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, shutdown, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion, shutdown@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.
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.
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.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. Please use the AWS console to perform the migration process before retrying the
operation.ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.LimitExceededException - The current limits of the service would have been exceeded by this operation. Decrease your resource use
or increase your service limits and retry the operation.DuplicateResourceException - The specified resource is a duplicate.InvalidStateException - An attempt was made to modify a resource that is in a state that is not valid. Check your resources to
ensure that they are in valid states before retrying the operation.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.
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.
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.
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. Please use the AWS 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 master account of an Organization. AWSOrganizationsAccess must be enabled in order to create a portfolio share to an organization node.
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.
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. Please use the AWS 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 per provisioned product. To create a plan for an existing provisioned product, the product status must be AVAILBLE or TAINTED.
To view the resource changes in the change set, use DescribeProvisionedProductPlan. To create or modify the provisioned product, use ExecuteProvisionedProductPlan.
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.
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. Please use the AWS console to perform the migration process before retrying the
operation.DuplicateResourceException - The specified resource is a duplicate.LimitExceededException - The current limits of the service would have been exceeded by this operation. Decrease your resource use
or increase your service limits and retry the operation.public DeleteConstraintResult deleteConstraint(DeleteConstraintRequest request)
Deletes the specified constraint.
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.
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. Please use the AWS 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 master account of an Organization.
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.
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. Please use the AWS 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. Please use the AWS console to perform the migration process before retrying the
operation.ResourceInUseException - A resource that is currently in use. Ensure that the resource is not in use and retry the operation.ResourceNotFoundException - The specified resource was not found.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.
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 master account in the organization.
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 DescribeProductResult describeProduct(DescribeProductRequest request)
Gets information about the specified product.
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.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 - ResourceNotFoundException - The specified resource was not found.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.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)
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. Please use the AWS 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 AWS Organizations feature. This feature will not delete your current shares but it will prevent you from creating new shares throughout your organization. Current shares will not be in sync with your organization structure if it changes after calling this API. This API can only be called by the master account in the organization.
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.
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.
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. Please use the AWS 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 AWS Organizations. This API will allow Service Catalog to receive updates on your organization in order to sync your shares with the current structure. This API can only be called by the master account in the organization.
By calling this API Service Catalog will make a call to organizations:EnableAWSServiceAccess on your behalf so that your shares can be in sync with any changes in your AWS Organizations structure.
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 AWS Organization portfolio share feature. This API can only be called by the master account in the organization.
getAWSOrganizationsAccessStatus in interface AWSServiceCataloggetAWSOrganizationsAccessStatusRequest - ResourceNotFoundException - The specified resource was not found.OperationNotSupportedException - The operation is not supported.public ListAcceptedPortfolioSharesResult listAcceptedPortfolioShares(ListAcceptedPortfolioSharesRequest request)
Lists all portfolios for which sharing was 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 is how the user has access to a specified product, and is necessary when provisioning a product. A path also determines the constraints put on the product.
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 master account in the organization.
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.
listPortfolioAccess in interface AWSServiceCataloglistPortfolioAccessRequest - ResourceNotFoundException - The specified resource was not found.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 principal ARNs 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. Please use the AWS console to perform the migration process before retrying the
operation.ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are not valid.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 AWS 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. Please use the AWS console to perform the migration process before retrying the
operation.InvalidParametersException - One or more parameters provided to the operation are not valid.public ProvisionProductResult provisionProduct(ProvisionProductRequest request)
Provisions the specified product.
A provisioned product is a resourced instance of a product. For example, provisioning a product based on a CloudFormation template launches a CloudFormation stack and its underlying resources. You can check the status of this request using DescribeRecord.
If the request contains a tag key with an empty list of values, there is a tag conflict for that key. Do not include conflicted keys as tags, or this causes the error "Parameter validation failed: Missing required parameter in Tags[N]:Value".
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. Please use the AWS console to perform the migration process 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. Please use the AWS 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. Please use the AWS console to perform the migration process before retrying the
operation.ResourceNotFoundException - The specified resource was not found.DuplicateResourceException - The specified resource is a duplicate.InvalidParametersException - One or more parameters provided to the operation are not valid.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 requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.