com.amazonaws.services.servicecatalog

Class AWSServiceCatalogClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.servicecatalog.AWSServiceCatalogClient

All Implemented Interfaces:

AWSServiceCatalog

Direct Known Subclasses:

AWSServiceCatalogAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSServiceCatalogClient
extends AmazonWebServiceClient
implements AWSServiceCatalog

Client for accessing AWS Service Catalog. All service calls made using this client are blocking, and will not return until the service call completes.

AWS Service Catalog

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.

Field Summary

Fields

Modifier and Type	Field and Description
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.servicecatalog.AWSServiceCatalog

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AWSServiceCatalogClient() Deprecated. use AWSServiceCatalogClientBuilder.defaultClient()
AWSServiceCatalogClient(AWSCredentials awsCredentials) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AWSServiceCatalogClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
AWSServiceCatalogClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AWSServiceCatalogClient(AWSCredentialsProvider awsCredentialsProvider) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
AWSServiceCatalogClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AWSServiceCatalogClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
AWSServiceCatalogClient(ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Method Summary

Modifier and Type	Method and Description
AcceptPortfolioShareResult	acceptPortfolioShare(AcceptPortfolioShareRequest request) Accepts an offer to share the specified portfolio.
AssociatePrincipalWithPortfolioResult	associatePrincipalWithPortfolio(AssociatePrincipalWithPortfolioRequest request) Associates the specified principal ARN with the specified portfolio.
AssociateProductWithPortfolioResult	associateProductWithPortfolio(AssociateProductWithPortfolioRequest request) Associates the specified product with the specified portfolio.
AssociateTagOptionWithResourceResult	associateTagOptionWithResource(AssociateTagOptionWithResourceRequest request) Associate the specified TagOption with the specified portfolio or product.
static AWSServiceCatalogClientBuilder	builder()
CopyProductResult	copyProduct(CopyProductRequest request) Copies the specified source product to the specified target product or a new product.
CreateConstraintResult	createConstraint(CreateConstraintRequest request) Creates a constraint.
CreatePortfolioResult	createPortfolio(CreatePortfolioRequest request) Creates a portfolio.
CreatePortfolioShareResult	createPortfolioShare(CreatePortfolioShareRequest request) Shares the specified portfolio with the specified account.
CreateProductResult	createProduct(CreateProductRequest request) Creates a product.
CreateProvisionedProductPlanResult	createProvisionedProductPlan(CreateProvisionedProductPlanRequest request) Creates a plan.
CreateProvisioningArtifactResult	createProvisioningArtifact(CreateProvisioningArtifactRequest request) Creates a provisioning artifact (also known as a version) for the specified product.
CreateTagOptionResult	createTagOption(CreateTagOptionRequest request) Creates a TagOption.
DeleteConstraintResult	deleteConstraint(DeleteConstraintRequest request) Deletes the specified constraint.
DeletePortfolioResult	deletePortfolio(DeletePortfolioRequest request) Deletes the specified portfolio.
DeletePortfolioShareResult	deletePortfolioShare(DeletePortfolioShareRequest request) Stops sharing the specified portfolio with the specified account.
DeleteProductResult	deleteProduct(DeleteProductRequest request) Deletes the specified product.
DeleteProvisionedProductPlanResult	deleteProvisionedProductPlan(DeleteProvisionedProductPlanRequest request) Deletes the specified plan.
DeleteProvisioningArtifactResult	deleteProvisioningArtifact(DeleteProvisioningArtifactRequest request) Deletes the specified provisioning artifact (also known as a version) for the specified product.
DeleteTagOptionResult	deleteTagOption(DeleteTagOptionRequest request) Deletes the specified TagOption.
DescribeConstraintResult	describeConstraint(DescribeConstraintRequest request) Gets information about the specified constraint.
DescribeCopyProductStatusResult	describeCopyProductStatus(DescribeCopyProductStatusRequest request) Gets the status of the specified copy product operation.
DescribePortfolioResult	describePortfolio(DescribePortfolioRequest request) Gets information about the specified portfolio.
DescribeProductResult	describeProduct(DescribeProductRequest request) Gets information about the specified product.
DescribeProductAsAdminResult	describeProductAsAdmin(DescribeProductAsAdminRequest request) Gets information about the specified product.
DescribeProductViewResult	describeProductView(DescribeProductViewRequest request) Gets information about the specified product.
DescribeProvisionedProductResult	describeProvisionedProduct(DescribeProvisionedProductRequest request) Gets information about the specified provisioned product.
DescribeProvisionedProductPlanResult	describeProvisionedProductPlan(DescribeProvisionedProductPlanRequest request) Gets information about the resource changes for the specified plan.
DescribeProvisioningArtifactResult	describeProvisioningArtifact(DescribeProvisioningArtifactRequest request) Gets information about the specified provisioning artifact (also known as a version) for the specified product.
DescribeProvisioningParametersResult	describeProvisioningParameters(DescribeProvisioningParametersRequest request) Gets information about the configuration required to provision the specified product using the specified provisioning artifact.
DescribeRecordResult	describeRecord(DescribeRecordRequest request) Gets information about the specified request operation.
DescribeTagOptionResult	describeTagOption(DescribeTagOptionRequest request) Gets information about the specified TagOption.
DisassociatePrincipalFromPortfolioResult	disassociatePrincipalFromPortfolio(DisassociatePrincipalFromPortfolioRequest request) Disassociates a previously associated principal ARN from a specified portfolio.
DisassociateProductFromPortfolioResult	disassociateProductFromPortfolio(DisassociateProductFromPortfolioRequest request) Disassociates the specified product from the specified portfolio.
DisassociateTagOptionFromResourceResult	disassociateTagOptionFromResource(DisassociateTagOptionFromResourceRequest request) Disassociates the specified TagOption from the specified resource.
ExecuteProvisionedProductPlanResult	executeProvisionedProductPlan(ExecuteProvisionedProductPlanRequest request) Provisions or modifies a product based on the resource changes for the specified plan.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
ListAcceptedPortfolioSharesResult	listAcceptedPortfolioShares(ListAcceptedPortfolioSharesRequest request) Lists all portfolios for which sharing was accepted by this account.
ListConstraintsForPortfolioResult	listConstraintsForPortfolio(ListConstraintsForPortfolioRequest request) Lists the constraints for the specified portfolio and product.
ListLaunchPathsResult	listLaunchPaths(ListLaunchPathsRequest request) Lists the paths to the specified product.
ListPortfolioAccessResult	listPortfolioAccess(ListPortfolioAccessRequest request) Lists the account IDs that have access to the specified portfolio.
ListPortfoliosResult	listPortfolios(ListPortfoliosRequest request) Lists all portfolios in the catalog.
ListPortfoliosForProductResult	listPortfoliosForProduct(ListPortfoliosForProductRequest request) Lists all portfolios that the specified product is associated with.
ListPrincipalsForPortfolioResult	listPrincipalsForPortfolio(ListPrincipalsForPortfolioRequest request) Lists all principal ARNs associated with the specified portfolio.
ListProvisionedProductPlansResult	listProvisionedProductPlans(ListProvisionedProductPlansRequest request) Lists the plans for the specified provisioned product or all plans to which the user has access.
ListProvisioningArtifactsResult	listProvisioningArtifacts(ListProvisioningArtifactsRequest request) Lists all provisioning artifacts (also known as versions) for the specified product.
ListRecordHistoryResult	listRecordHistory(ListRecordHistoryRequest request) Lists the specified requests or all performed requests.
ListResourcesForTagOptionResult	listResourcesForTagOption(ListResourcesForTagOptionRequest request) Lists the resources associated with the specified TagOption.
ListTagOptionsResult	listTagOptions(ListTagOptionsRequest request) Lists the specified TagOptions or all TagOptions.
ProvisionProductResult	provisionProduct(ProvisionProductRequest request) Provisions the specified product.
RejectPortfolioShareResult	rejectPortfolioShare(RejectPortfolioShareRequest request) Rejects an offer to share the specified portfolio.
ScanProvisionedProductsResult	scanProvisionedProducts(ScanProvisionedProductsRequest request) Lists the provisioned products that are available (not terminated).
SearchProductsResult	searchProducts(SearchProductsRequest request) Gets information about the products to which the caller has access.
SearchProductsAsAdminResult	searchProductsAsAdmin(SearchProductsAsAdminRequest request) Gets information about the products for the specified portfolio or all products.
SearchProvisionedProductsResult	searchProvisionedProducts(SearchProvisionedProductsRequest request) Gets information about the provisioned products that meet the specified criteria.
TerminateProvisionedProductResult	terminateProvisionedProduct(TerminateProvisionedProductRequest request) Terminates the specified provisioned product.
UpdateConstraintResult	updateConstraint(UpdateConstraintRequest request) Updates the specified constraint.
UpdatePortfolioResult	updatePortfolio(UpdatePortfolioRequest request) Updates the specified portfolio.
UpdateProductResult	updateProduct(UpdateProductRequest request) Updates the specified product.
UpdateProvisionedProductResult	updateProvisionedProduct(UpdateProvisionedProductRequest request) Requests updates to the configuration of the specified provisioned product.
UpdateProvisioningArtifactResult	updateProvisioningArtifact(UpdateProvisioningArtifactRequest request) Updates the specified provisioning artifact (also known as a version) for the specified product.
UpdateTagOptionResult	updateTagOption(UpdateTagOptionRequest request) Updates the specified TagOption.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, shutdown, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.servicecatalog.AWSServiceCatalog

setEndpoint, setRegion, shutdown

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Constructor Detail

AWSServiceCatalogClient

@Deprecated
public AWSServiceCatalogClient()

Deprecated. use AWSServiceCatalogClientBuilder.defaultClient()

Constructs a new client to invoke service methods on AWS Service Catalog. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AWSServiceCatalogClient

@Deprecated
public AWSServiceCatalogClient(ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on AWS Service Catalog. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AWS Service Catalog (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AWSServiceCatalogClient

@Deprecated
public AWSServiceCatalogClient(AWSCredentials awsCredentials)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AWSServiceCatalogClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();

Constructs a new client to invoke service methods on AWS Service Catalog using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AWSServiceCatalogClient

@Deprecated
public AWSServiceCatalogClient(AWSCredentials awsCredentials,
                                           ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on AWS Service Catalog using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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.).

AWSServiceCatalogClient

@Deprecated
public AWSServiceCatalogClient(AWSCredentialsProvider awsCredentialsProvider)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)

Constructs a new client to invoke service methods on AWS Service Catalog using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AWSServiceCatalogClient

@Deprecated
public AWSServiceCatalogClient(AWSCredentialsProvider awsCredentialsProvider,
                                           ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on AWS Service Catalog using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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.).

AWSServiceCatalogClient

@Deprecated
public AWSServiceCatalogClient(AWSCredentialsProvider awsCredentialsProvider,
                                           ClientConfiguration clientConfiguration,
                                           RequestMetricCollector requestMetricCollector)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)

Constructs a new client to invoke service methods on AWS Service Catalog using the specified AWS account credentials provider, client configuration options, and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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 collector

Method Detail

builder

public static AWSServiceCatalogClientBuilder builder()

acceptPortfolioShare

public AcceptPortfolioShareResult acceptPortfolioShare(AcceptPortfolioShareRequest request)

Accepts an offer to share the specified portfolio.

Specified by:

acceptPortfolioShare in interface AWSServiceCatalog

Parameters:

acceptPortfolioShareRequest -

Returns:

Result of the AcceptPortfolioShare operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

associatePrincipalWithPortfolio

public AssociatePrincipalWithPortfolioResult associatePrincipalWithPortfolio(AssociatePrincipalWithPortfolioRequest request)

Associates the specified principal ARN with the specified portfolio.

Specified by:

associatePrincipalWithPortfolio in interface AWSServiceCatalog

Parameters:

associatePrincipalWithPortfolioRequest -

Returns:

Result of the AssociatePrincipalWithPortfolio operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

associateProductWithPortfolio

public AssociateProductWithPortfolioResult associateProductWithPortfolio(AssociateProductWithPortfolioRequest request)

Associates the specified product with the specified portfolio.

Specified by:

associateProductWithPortfolio in interface AWSServiceCatalog

Parameters:

associateProductWithPortfolioRequest -

Returns:

Result of the AssociateProductWithPortfolio operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

associateTagOptionWithResource

public AssociateTagOptionWithResourceResult associateTagOptionWithResource(AssociateTagOptionWithResourceRequest request)

Associate the specified TagOption with the specified portfolio or product.

Specified by:

associateTagOptionWithResource in interface AWSServiceCatalog

Parameters:

associateTagOptionWithResourceRequest -

Returns:

Result of the AssociateTagOptionWithResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

copyProduct

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.

Specified by:

copyProduct in interface AWSServiceCatalog

Parameters:

copyProductRequest -

Returns:

Result of the CopyProduct operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InvalidParametersException - One or more parameters provided to the operation are not valid.

See Also:

AWS API Documentation

createConstraint

public CreateConstraintResult createConstraint(CreateConstraintRequest request)

Creates a constraint.

Specified by:

createConstraint in interface AWSServiceCatalog

Parameters:

createConstraintRequest -

Returns:

Result of the CreateConstraint operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createPortfolio

public CreatePortfolioResult createPortfolio(CreatePortfolioRequest request)

Creates a portfolio.

Specified by:

createPortfolio in interface AWSServiceCatalog

Parameters:

createPortfolioRequest -

Returns:

Result of the CreatePortfolio operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createPortfolioShare

public CreatePortfolioShareResult createPortfolioShare(CreatePortfolioShareRequest request)

Shares the specified portfolio with the specified account.

Specified by:

createPortfolioShare in interface AWSServiceCatalog

Parameters:

createPortfolioShareRequest -

Returns:

Result of the CreatePortfolioShare operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createProduct

public CreateProductResult createProduct(CreateProductRequest request)

Creates a product.

Specified by:

createProduct in interface AWSServiceCatalog

Parameters:

createProductRequest -

Returns:

Result of the CreateProduct operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createProvisionedProductPlan

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.

Specified by:

createProvisionedProductPlan in interface AWSServiceCatalog

Parameters:

createProvisionedProductPlanRequest -

Returns:

Result of the CreateProvisionedProductPlan operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createProvisioningArtifact

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.

Specified by:

createProvisioningArtifact in interface AWSServiceCatalog

Parameters:

createProvisioningArtifactRequest -

Returns:

Result of the CreateProvisioningArtifact operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createTagOption

public CreateTagOptionResult createTagOption(CreateTagOptionRequest request)

Creates a TagOption.

Specified by:

createTagOption in interface AWSServiceCatalog

Parameters:

createTagOptionRequest -

Returns:

Result of the CreateTagOption operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteConstraint

public DeleteConstraintResult deleteConstraint(DeleteConstraintRequest request)

Deletes the specified constraint.

Specified by:

deleteConstraint in interface AWSServiceCatalog

Parameters:

deleteConstraintRequest -

Returns:

Result of the DeleteConstraint operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InvalidParametersException - One or more parameters provided to the operation are not valid.

See Also:

AWS API Documentation

deletePortfolio

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.

Specified by:

deletePortfolio in interface AWSServiceCatalog

Parameters:

deletePortfolioRequest -

Returns:

Result of the DeletePortfolio operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deletePortfolioShare

public DeletePortfolioShareResult deletePortfolioShare(DeletePortfolioShareRequest request)

Stops sharing the specified portfolio with the specified account.

Specified by:

deletePortfolioShare in interface AWSServiceCatalog

Parameters:

deletePortfolioShareRequest -

Returns:

Result of the DeletePortfolioShare operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

deleteProduct

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.

Specified by:

deleteProduct in interface AWSServiceCatalog

Parameters:

deleteProductRequest -

Returns:

Result of the DeleteProduct operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteProvisionedProductPlan

public DeleteProvisionedProductPlanResult deleteProvisionedProductPlan(DeleteProvisionedProductPlanRequest request)

Deletes the specified plan.

Specified by:

deleteProvisionedProductPlan in interface AWSServiceCatalog

Parameters:

deleteProvisionedProductPlanRequest -

Returns:

Result of the DeleteProvisionedProductPlan operation returned by the service.

Throws:

InvalidParametersException - One or more parameters provided to the operation are not valid.

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

deleteProvisioningArtifact

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.

Specified by:

deleteProvisioningArtifact in interface AWSServiceCatalog

Parameters:

deleteProvisioningArtifactRequest -

Returns:

Result of the DeleteProvisioningArtifact operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteTagOption

public DeleteTagOptionResult deleteTagOption(DeleteTagOptionRequest request)

Deletes the specified TagOption.

You cannot delete a TagOption if it is associated with a product or portfolio.

Specified by:

deleteTagOption in interface AWSServiceCatalog

Parameters:

deleteTagOptionRequest -

Returns:

Result of the DeleteTagOption operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeConstraint

public DescribeConstraintResult describeConstraint(DescribeConstraintRequest request)

Gets information about the specified constraint.

Specified by:

describeConstraint in interface AWSServiceCatalog

Parameters:

describeConstraintRequest -

Returns:

Result of the DescribeConstraint operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

describeCopyProductStatus

public DescribeCopyProductStatusResult describeCopyProductStatus(DescribeCopyProductStatusRequest request)

Gets the status of the specified copy product operation.

Specified by:

describeCopyProductStatus in interface AWSServiceCatalog

Parameters:

describeCopyProductStatusRequest -

Returns:

Result of the DescribeCopyProductStatus operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

describePortfolio

public DescribePortfolioResult describePortfolio(DescribePortfolioRequest request)

Gets information about the specified portfolio.

Specified by:

describePortfolio in interface AWSServiceCatalog

Parameters:

describePortfolioRequest -

Returns:

Result of the DescribePortfolio operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

describeProduct

public DescribeProductResult describeProduct(DescribeProductRequest request)

Gets information about the specified product.

Specified by:

describeProduct in interface AWSServiceCatalog

Parameters:

describeProductRequest -

Returns:

Result of the DescribeProduct operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InvalidParametersException - One or more parameters provided to the operation are not valid.

See Also:

AWS API Documentation

describeProductAsAdmin

public DescribeProductAsAdminResult describeProductAsAdmin(DescribeProductAsAdminRequest request)

Gets information about the specified product. This operation is run with administrator access.

Specified by:

describeProductAsAdmin in interface AWSServiceCatalog

Parameters:

describeProductAsAdminRequest -

Returns:

Result of the DescribeProductAsAdmin operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

describeProductView

public DescribeProductViewResult describeProductView(DescribeProductViewRequest request)

Gets information about the specified product.

Specified by:

describeProductView in interface AWSServiceCatalog

Parameters:

describeProductViewRequest -

Returns:

Result of the DescribeProductView operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InvalidParametersException - One or more parameters provided to the operation are not valid.

See Also:

AWS API Documentation

describeProvisionedProduct

public DescribeProvisionedProductResult describeProvisionedProduct(DescribeProvisionedProductRequest request)

Gets information about the specified provisioned product.

Specified by:

describeProvisionedProduct in interface AWSServiceCatalog

Parameters:

describeProvisionedProductRequest -

Returns:

Result of the DescribeProvisionedProduct operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

describeProvisionedProductPlan

public DescribeProvisionedProductPlanResult describeProvisionedProductPlan(DescribeProvisionedProductPlanRequest request)

Gets information about the resource changes for the specified plan.

Specified by:

describeProvisionedProductPlan in interface AWSServiceCatalog

Parameters:

describeProvisionedProductPlanRequest -

Returns:

Result of the DescribeProvisionedProductPlan operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InvalidParametersException - One or more parameters provided to the operation are not valid.

See Also:

AWS API Documentation

describeProvisioningArtifact

public DescribeProvisioningArtifactResult describeProvisioningArtifact(DescribeProvisioningArtifactRequest request)

Gets information about the specified provisioning artifact (also known as a version) for the specified product.

Specified by:

describeProvisioningArtifact in interface AWSServiceCatalog

Parameters:

describeProvisioningArtifactRequest -

Returns:

Result of the DescribeProvisioningArtifact operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

describeProvisioningParameters

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.

Specified by:

describeProvisioningParameters in interface AWSServiceCatalog

Parameters:

describeProvisioningParametersRequest -

Returns:

Result of the DescribeProvisioningParameters operation returned by the service.

Throws:

InvalidParametersException - One or more parameters provided to the operation are not valid.

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

describeRecord

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).

Specified by:

describeRecord in interface AWSServiceCatalog

Parameters:

describeRecordRequest -

Returns:

Result of the DescribeRecord operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

describeTagOption

public DescribeTagOptionResult describeTagOption(DescribeTagOptionRequest request)

Gets information about the specified TagOption.

Specified by:

describeTagOption in interface AWSServiceCatalog

Parameters:

describeTagOptionRequest -

Returns:

Result of the DescribeTagOption operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

disassociatePrincipalFromPortfolio

public DisassociatePrincipalFromPortfolioResult disassociatePrincipalFromPortfolio(DisassociatePrincipalFromPortfolioRequest request)

Disassociates a previously associated principal ARN from a specified portfolio.

Specified by:

disassociatePrincipalFromPortfolio in interface AWSServiceCatalog

Parameters:

disassociatePrincipalFromPortfolioRequest -

Returns:

Result of the DisassociatePrincipalFromPortfolio operation returned by the service.

Throws:

InvalidParametersException - One or more parameters provided to the operation are not valid.

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

disassociateProductFromPortfolio

public DisassociateProductFromPortfolioResult disassociateProductFromPortfolio(DisassociateProductFromPortfolioRequest request)

Disassociates the specified product from the specified portfolio.

Specified by:

disassociateProductFromPortfolio in interface AWSServiceCatalog

Parameters:

disassociateProductFromPortfolioRequest -

Returns:

Result of the DisassociateProductFromPortfolio operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

disassociateTagOptionFromResource

public DisassociateTagOptionFromResourceResult disassociateTagOptionFromResource(DisassociateTagOptionFromResourceRequest request)

Disassociates the specified TagOption from the specified resource.

Specified by:

disassociateTagOptionFromResource in interface AWSServiceCatalog

Parameters:

disassociateTagOptionFromResourceRequest -

Returns:

Result of the DisassociateTagOptionFromResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

executeProvisionedProductPlan

public ExecuteProvisionedProductPlanResult executeProvisionedProductPlan(ExecuteProvisionedProductPlanRequest request)

Provisions or modifies a product based on the resource changes for the specified plan.

Specified by:

executeProvisionedProductPlan in interface AWSServiceCatalog

Parameters:

executeProvisionedProductPlanRequest -

Returns:

Result of the ExecuteProvisionedProductPlan operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listAcceptedPortfolioShares

public ListAcceptedPortfolioSharesResult listAcceptedPortfolioShares(ListAcceptedPortfolioSharesRequest request)

Lists all portfolios for which sharing was accepted by this account.

Specified by:

listAcceptedPortfolioShares in interface AWSServiceCatalog

Parameters:

listAcceptedPortfolioSharesRequest -

Returns:

Result of the ListAcceptedPortfolioShares operation returned by the service.

Throws:

InvalidParametersException - One or more parameters provided to the operation are not valid.

See Also:

AWS API Documentation

listConstraintsForPortfolio

public ListConstraintsForPortfolioResult listConstraintsForPortfolio(ListConstraintsForPortfolioRequest request)

Lists the constraints for the specified portfolio and product.

Specified by:

listConstraintsForPortfolio in interface AWSServiceCatalog

Parameters:

listConstraintsForPortfolioRequest -

Returns:

Result of the ListConstraintsForPortfolio operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InvalidParametersException - One or more parameters provided to the operation are not valid.

See Also:

AWS API Documentation

listLaunchPaths

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.

Specified by:

listLaunchPaths in interface AWSServiceCatalog

Parameters:

listLaunchPathsRequest -

Returns:

Result of the ListLaunchPaths operation returned by the service.

Throws:

InvalidParametersException - One or more parameters provided to the operation are not valid.

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

listPortfolioAccess

public ListPortfolioAccessResult listPortfolioAccess(ListPortfolioAccessRequest request)

Lists the account IDs that have access to the specified portfolio.

Specified by:

listPortfolioAccess in interface AWSServiceCatalog

Parameters:

listPortfolioAccessRequest -

Returns:

Result of the ListPortfolioAccess operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

listPortfolios

public ListPortfoliosResult listPortfolios(ListPortfoliosRequest request)

Lists all portfolios in the catalog.

Specified by:

listPortfolios in interface AWSServiceCatalog

Parameters:

listPortfoliosRequest -

Returns:

Result of the ListPortfolios operation returned by the service.

Throws:

InvalidParametersException - One or more parameters provided to the operation are not valid.

See Also:

AWS API Documentation

listPortfoliosForProduct

public ListPortfoliosForProductResult listPortfoliosForProduct(ListPortfoliosForProductRequest request)

Lists all portfolios that the specified product is associated with.

Specified by:

listPortfoliosForProduct in interface AWSServiceCatalog

Parameters:

listPortfoliosForProductRequest -

Returns:

Result of the ListPortfoliosForProduct operation returned by the service.

Throws:

InvalidParametersException - One or more parameters provided to the operation are not valid.

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

listPrincipalsForPortfolio

public ListPrincipalsForPortfolioResult listPrincipalsForPortfolio(ListPrincipalsForPortfolioRequest request)

Lists all principal ARNs associated with the specified portfolio.

Specified by:

listPrincipalsForPortfolio in interface AWSServiceCatalog

Parameters:

listPrincipalsForPortfolioRequest -

Returns:

Result of the ListPrincipalsForPortfolio operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InvalidParametersException - One or more parameters provided to the operation are not valid.

See Also:

AWS API Documentation

listProvisionedProductPlans

public ListProvisionedProductPlansResult listProvisionedProductPlans(ListProvisionedProductPlansRequest request)

Lists the plans for the specified provisioned product or all plans to which the user has access.

Specified by:

listProvisionedProductPlans in interface AWSServiceCatalog

Parameters:

listProvisionedProductPlansRequest -

Returns:

Result of the ListProvisionedProductPlans operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InvalidParametersException - One or more parameters provided to the operation are not valid.

See Also:

AWS API Documentation

listProvisioningArtifacts

public ListProvisioningArtifactsResult listProvisioningArtifacts(ListProvisioningArtifactsRequest request)

Lists all provisioning artifacts (also known as versions) for the specified product.

Specified by:

listProvisioningArtifacts in interface AWSServiceCatalog

Parameters:

listProvisioningArtifactsRequest -

Returns:

Result of the ListProvisioningArtifacts operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InvalidParametersException - One or more parameters provided to the operation are not valid.

See Also:

AWS API Documentation

listRecordHistory

public ListRecordHistoryResult listRecordHistory(ListRecordHistoryRequest request)

Lists the specified requests or all performed requests.

Specified by:

listRecordHistory in interface AWSServiceCatalog

Parameters:

listRecordHistoryRequest -

Returns:

Result of the ListRecordHistory operation returned by the service.

Throws:

InvalidParametersException - One or more parameters provided to the operation are not valid.

See Also:

AWS API Documentation

listResourcesForTagOption

public ListResourcesForTagOptionResult listResourcesForTagOption(ListResourcesForTagOptionRequest request)

Lists the resources associated with the specified TagOption.

Specified by:

listResourcesForTagOption in interface AWSServiceCatalog

Parameters:

listResourcesForTagOptionRequest -

Returns:

Result of the ListResourcesForTagOption operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listTagOptions

public ListTagOptionsResult listTagOptions(ListTagOptionsRequest request)

Lists the specified TagOptions or all TagOptions.

Specified by:

listTagOptions in interface AWSServiceCatalog

Parameters:

listTagOptionsRequest -

Returns:

Result of the ListTagOptions operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

provisionProduct

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".

Specified by:

provisionProduct in interface AWSServiceCatalog

Parameters:

provisionProductRequest -

Returns:

Result of the ProvisionProduct operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

rejectPortfolioShare

public RejectPortfolioShareResult rejectPortfolioShare(RejectPortfolioShareRequest request)

Rejects an offer to share the specified portfolio.

Specified by:

rejectPortfolioShare in interface AWSServiceCatalog

Parameters:

rejectPortfolioShareRequest -

Returns:

Result of the RejectPortfolioShare operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

scanProvisionedProducts

public ScanProvisionedProductsResult scanProvisionedProducts(ScanProvisionedProductsRequest request)

Lists the provisioned products that are available (not terminated).

To use additional filtering, see SearchProvisionedProducts.

Specified by:

scanProvisionedProducts in interface AWSServiceCatalog

Parameters:

scanProvisionedProductsRequest -

Returns:

Result of the ScanProvisionedProducts operation returned by the service.

Throws:

InvalidParametersException - One or more parameters provided to the operation are not valid.

See Also:

AWS API Documentation

searchProducts

public SearchProductsResult searchProducts(SearchProductsRequest request)

Gets information about the products to which the caller has access.

Specified by:

searchProducts in interface AWSServiceCatalog

Parameters:

searchProductsRequest -

Returns:

Result of the SearchProducts operation returned by the service.

Throws:

InvalidParametersException - One or more parameters provided to the operation are not valid.

See Also:

AWS API Documentation

searchProductsAsAdmin

public SearchProductsAsAdminResult searchProductsAsAdmin(SearchProductsAsAdminRequest request)

Gets information about the products for the specified portfolio or all products.

Specified by:

searchProductsAsAdmin in interface AWSServiceCatalog

Parameters:

searchProductsAsAdminRequest -

Returns:

Result of the SearchProductsAsAdmin operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InvalidParametersException - One or more parameters provided to the operation are not valid.

See Also:

AWS API Documentation

searchProvisionedProducts

public SearchProvisionedProductsResult searchProvisionedProducts(SearchProvisionedProductsRequest request)

Gets information about the provisioned products that meet the specified criteria.

Specified by:

searchProvisionedProducts in interface AWSServiceCatalog

Parameters:

searchProvisionedProductsRequest -

Returns:

Result of the SearchProvisionedProducts operation returned by the service.

Throws:

InvalidParametersException - One or more parameters provided to the operation are not valid.

See Also:

AWS API Documentation

terminateProvisionedProduct

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.

Specified by:

terminateProvisionedProduct in interface AWSServiceCatalog

Parameters:

terminateProvisionedProductRequest -

Returns:

Result of the TerminateProvisionedProduct operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

updateConstraint

public UpdateConstraintResult updateConstraint(UpdateConstraintRequest request)

Updates the specified constraint.

Specified by:

updateConstraint in interface AWSServiceCatalog

Parameters:

updateConstraintRequest -

Returns:

Result of the UpdateConstraint operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InvalidParametersException - One or more parameters provided to the operation are not valid.

See Also:

AWS API Documentation

updatePortfolio

public UpdatePortfolioResult updatePortfolio(UpdatePortfolioRequest request)

Updates the specified portfolio.

You cannot update a product that was shared with you.

Specified by:

updatePortfolio in interface AWSServiceCatalog

Parameters:

updatePortfolioRequest -

Returns:

Result of the UpdatePortfolio operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateProduct

public UpdateProductResult updateProduct(UpdateProductRequest request)

Updates the specified product.

Specified by:

updateProduct in interface AWSServiceCatalog

Parameters:

updateProductRequest -

Returns:

Result of the UpdateProduct operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateProvisionedProduct

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.

Specified by:

updateProvisionedProduct in interface AWSServiceCatalog

Parameters:

updateProvisionedProductRequest -

Returns:

Result of the UpdateProvisionedProduct operation returned by the service.

Throws:

InvalidParametersException - One or more parameters provided to the operation are not valid.

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

updateProvisioningArtifact

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.

Specified by:

updateProvisioningArtifact in interface AWSServiceCatalog

Parameters:

updateProvisioningArtifactRequest -

Returns:

Result of the UpdateProvisioningArtifact operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InvalidParametersException - One or more parameters provided to the operation are not valid.

See Also:

AWS API Documentation

updateTagOption

public UpdateTagOptionResult updateTagOption(UpdateTagOptionRequest request)

Updates the specified TagOption.

Specified by:

updateTagOption in interface AWSServiceCatalog

Parameters:

updateTagOptionRequest -

Returns:

Result of the UpdateTagOption operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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.

Specified by:

getCachedResponseMetadata in interface AWSServiceCatalog

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.