com.amazonaws.services.servicecatalog

Interface AWSServiceCatalog

All Known Subinterfaces:

AWSServiceCatalogAsync

All Known Implementing Classes:

AbstractAWSServiceCatalog, AbstractAWSServiceCatalogAsync, AWSServiceCatalogAsyncClient, AWSServiceCatalogClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSServiceCatalog

Interface for accessing AWS Service Catalog.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSServiceCatalog instead.

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
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
AcceptPortfolioShareResult	acceptPortfolioShare(AcceptPortfolioShareRequest acceptPortfolioShareRequest) Accepts an offer to share the specified portfolio.
AssociatePrincipalWithPortfolioResult	associatePrincipalWithPortfolio(AssociatePrincipalWithPortfolioRequest associatePrincipalWithPortfolioRequest) Associates the specified principal ARN with the specified portfolio.
AssociateProductWithPortfolioResult	associateProductWithPortfolio(AssociateProductWithPortfolioRequest associateProductWithPortfolioRequest) Associates the specified product with the specified portfolio.
AssociateTagOptionWithResourceResult	associateTagOptionWithResource(AssociateTagOptionWithResourceRequest associateTagOptionWithResourceRequest) Associate the specified TagOption with the specified portfolio or product.
CopyProductResult	copyProduct(CopyProductRequest copyProductRequest) Copies the specified source product to the specified target product or a new product.
CreateConstraintResult	createConstraint(CreateConstraintRequest createConstraintRequest) Creates a constraint.
CreatePortfolioResult	createPortfolio(CreatePortfolioRequest createPortfolioRequest) Creates a portfolio.
CreatePortfolioShareResult	createPortfolioShare(CreatePortfolioShareRequest createPortfolioShareRequest) Shares the specified portfolio with the specified account.
CreateProductResult	createProduct(CreateProductRequest createProductRequest) Creates a product.
CreateProvisionedProductPlanResult	createProvisionedProductPlan(CreateProvisionedProductPlanRequest createProvisionedProductPlanRequest) Creates a plan.
CreateProvisioningArtifactResult	createProvisioningArtifact(CreateProvisioningArtifactRequest createProvisioningArtifactRequest) Creates a provisioning artifact (also known as a version) for the specified product.
CreateTagOptionResult	createTagOption(CreateTagOptionRequest createTagOptionRequest) Creates a TagOption.
DeleteConstraintResult	deleteConstraint(DeleteConstraintRequest deleteConstraintRequest) Deletes the specified constraint.
DeletePortfolioResult	deletePortfolio(DeletePortfolioRequest deletePortfolioRequest) Deletes the specified portfolio.
DeletePortfolioShareResult	deletePortfolioShare(DeletePortfolioShareRequest deletePortfolioShareRequest) Stops sharing the specified portfolio with the specified account.
DeleteProductResult	deleteProduct(DeleteProductRequest deleteProductRequest) Deletes the specified product.
DeleteProvisionedProductPlanResult	deleteProvisionedProductPlan(DeleteProvisionedProductPlanRequest deleteProvisionedProductPlanRequest) Deletes the specified plan.
DeleteProvisioningArtifactResult	deleteProvisioningArtifact(DeleteProvisioningArtifactRequest deleteProvisioningArtifactRequest) Deletes the specified provisioning artifact (also known as a version) for the specified product.
DeleteTagOptionResult	deleteTagOption(DeleteTagOptionRequest deleteTagOptionRequest) Deletes the specified TagOption.
DescribeConstraintResult	describeConstraint(DescribeConstraintRequest describeConstraintRequest) Gets information about the specified constraint.
DescribeCopyProductStatusResult	describeCopyProductStatus(DescribeCopyProductStatusRequest describeCopyProductStatusRequest) Gets the status of the specified copy product operation.
DescribePortfolioResult	describePortfolio(DescribePortfolioRequest describePortfolioRequest) Gets information about the specified portfolio.
DescribeProductResult	describeProduct(DescribeProductRequest describeProductRequest) Gets information about the specified product.
DescribeProductAsAdminResult	describeProductAsAdmin(DescribeProductAsAdminRequest describeProductAsAdminRequest) Gets information about the specified product.
DescribeProductViewResult	describeProductView(DescribeProductViewRequest describeProductViewRequest) Gets information about the specified product.
DescribeProvisionedProductResult	describeProvisionedProduct(DescribeProvisionedProductRequest describeProvisionedProductRequest) Gets information about the specified provisioned product.
DescribeProvisionedProductPlanResult	describeProvisionedProductPlan(DescribeProvisionedProductPlanRequest describeProvisionedProductPlanRequest) Gets information about the resource changes for the specified plan.
DescribeProvisioningArtifactResult	describeProvisioningArtifact(DescribeProvisioningArtifactRequest describeProvisioningArtifactRequest) Gets information about the specified provisioning artifact (also known as a version) for the specified product.
DescribeProvisioningParametersResult	describeProvisioningParameters(DescribeProvisioningParametersRequest describeProvisioningParametersRequest) Gets information about the configuration required to provision the specified product using the specified provisioning artifact.
DescribeRecordResult	describeRecord(DescribeRecordRequest describeRecordRequest) Gets information about the specified request operation.
DescribeTagOptionResult	describeTagOption(DescribeTagOptionRequest describeTagOptionRequest) Gets information about the specified TagOption.
DisassociatePrincipalFromPortfolioResult	disassociatePrincipalFromPortfolio(DisassociatePrincipalFromPortfolioRequest disassociatePrincipalFromPortfolioRequest) Disassociates a previously associated principal ARN from a specified portfolio.
DisassociateProductFromPortfolioResult	disassociateProductFromPortfolio(DisassociateProductFromPortfolioRequest disassociateProductFromPortfolioRequest) Disassociates the specified product from the specified portfolio.
DisassociateTagOptionFromResourceResult	disassociateTagOptionFromResource(DisassociateTagOptionFromResourceRequest disassociateTagOptionFromResourceRequest) Disassociates the specified TagOption from the specified resource.
ExecuteProvisionedProductPlanResult	executeProvisionedProductPlan(ExecuteProvisionedProductPlanRequest executeProvisionedProductPlanRequest) 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 listAcceptedPortfolioSharesRequest) Lists all portfolios for which sharing was accepted by this account.
ListConstraintsForPortfolioResult	listConstraintsForPortfolio(ListConstraintsForPortfolioRequest listConstraintsForPortfolioRequest) Lists the constraints for the specified portfolio and product.
ListLaunchPathsResult	listLaunchPaths(ListLaunchPathsRequest listLaunchPathsRequest) Lists the paths to the specified product.
ListPortfolioAccessResult	listPortfolioAccess(ListPortfolioAccessRequest listPortfolioAccessRequest) Lists the account IDs that have access to the specified portfolio.
ListPortfoliosResult	listPortfolios(ListPortfoliosRequest listPortfoliosRequest) Lists all portfolios in the catalog.
ListPortfoliosForProductResult	listPortfoliosForProduct(ListPortfoliosForProductRequest listPortfoliosForProductRequest) Lists all portfolios that the specified product is associated with.
ListPrincipalsForPortfolioResult	listPrincipalsForPortfolio(ListPrincipalsForPortfolioRequest listPrincipalsForPortfolioRequest) Lists all principal ARNs associated with the specified portfolio.
ListProvisionedProductPlansResult	listProvisionedProductPlans(ListProvisionedProductPlansRequest listProvisionedProductPlansRequest) Lists the plans for the specified provisioned product or all plans to which the user has access.
ListProvisioningArtifactsResult	listProvisioningArtifacts(ListProvisioningArtifactsRequest listProvisioningArtifactsRequest) Lists all provisioning artifacts (also known as versions) for the specified product.
ListRecordHistoryResult	listRecordHistory(ListRecordHistoryRequest listRecordHistoryRequest) Lists the specified requests or all performed requests.
ListResourcesForTagOptionResult	listResourcesForTagOption(ListResourcesForTagOptionRequest listResourcesForTagOptionRequest) Lists the resources associated with the specified TagOption.
ListTagOptionsResult	listTagOptions(ListTagOptionsRequest listTagOptionsRequest) Lists the specified TagOptions or all TagOptions.
ProvisionProductResult	provisionProduct(ProvisionProductRequest provisionProductRequest) Provisions the specified product.
RejectPortfolioShareResult	rejectPortfolioShare(RejectPortfolioShareRequest rejectPortfolioShareRequest) Rejects an offer to share the specified portfolio.
ScanProvisionedProductsResult	scanProvisionedProducts(ScanProvisionedProductsRequest scanProvisionedProductsRequest) Lists the provisioned products that are available (not terminated).
SearchProductsResult	searchProducts(SearchProductsRequest searchProductsRequest) Gets information about the products to which the caller has access.
SearchProductsAsAdminResult	searchProductsAsAdmin(SearchProductsAsAdminRequest searchProductsAsAdminRequest) Gets information about the products for the specified portfolio or all products.
SearchProvisionedProductsResult	searchProvisionedProducts(SearchProvisionedProductsRequest searchProvisionedProductsRequest) Gets information about the provisioned products that meet the specified criteria.
void	setEndpoint(String endpoint) Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
void	setRegion(Region region) Deprecated. use AwsClientBuilder#setRegion(String)
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TerminateProvisionedProductResult	terminateProvisionedProduct(TerminateProvisionedProductRequest terminateProvisionedProductRequest) Terminates the specified provisioned product.
UpdateConstraintResult	updateConstraint(UpdateConstraintRequest updateConstraintRequest) Updates the specified constraint.
UpdatePortfolioResult	updatePortfolio(UpdatePortfolioRequest updatePortfolioRequest) Updates the specified portfolio.
UpdateProductResult	updateProduct(UpdateProductRequest updateProductRequest) Updates the specified product.
UpdateProvisionedProductResult	updateProvisionedProduct(UpdateProvisionedProductRequest updateProvisionedProductRequest) Requests updates to the configuration of the specified provisioned product.
UpdateProvisioningArtifactResult	updateProvisioningArtifact(UpdateProvisioningArtifactRequest updateProvisioningArtifactRequest) Updates the specified provisioning artifact (also known as a version) for the specified product.
UpdateTagOptionResult	updateTagOption(UpdateTagOptionRequest updateTagOptionRequest) Updates the specified TagOption.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

setEndpoint

@Deprecated
void setEndpoint(String endpoint)

Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));

Overrides the default endpoint for this client ("servicecatalog.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "servicecatalog.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "servicecatalog.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "servicecatalog.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "servicecatalog.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

setRegion

@Deprecated
void setRegion(Region region)

Deprecated. use AwsClientBuilder#setRegion(String)

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)

acceptPortfolioShare

AcceptPortfolioShareResult acceptPortfolioShare(AcceptPortfolioShareRequest acceptPortfolioShareRequest)

Accepts an offer to share the specified portfolio.

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

AssociatePrincipalWithPortfolioResult associatePrincipalWithPortfolio(AssociatePrincipalWithPortfolioRequest associatePrincipalWithPortfolioRequest)

Associates the specified principal ARN with the specified portfolio.

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

AssociateProductWithPortfolioResult associateProductWithPortfolio(AssociateProductWithPortfolioRequest associateProductWithPortfolioRequest)

Associates the specified product with the specified portfolio.

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

AssociateTagOptionWithResourceResult associateTagOptionWithResource(AssociateTagOptionWithResourceRequest associateTagOptionWithResourceRequest)

Associate the specified TagOption with the specified portfolio or product.

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

CopyProductResult copyProduct(CopyProductRequest copyProductRequest)

Copies the specified source product to the specified target product or a new product.

You can copy a product to the same account or another account. You can copy a product to the same region or another region.

This operation is performed asynchronously. To track the progress of the operation, use DescribeCopyProductStatus.

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

CreateConstraintResult createConstraint(CreateConstraintRequest createConstraintRequest)

Creates a constraint.

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

CreatePortfolioResult createPortfolio(CreatePortfolioRequest createPortfolioRequest)

Creates a portfolio.

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

CreatePortfolioShareResult createPortfolioShare(CreatePortfolioShareRequest createPortfolioShareRequest)

Shares the specified portfolio with the specified account.

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

CreateProductResult createProduct(CreateProductRequest createProductRequest)

Creates a product.

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

CreateProvisionedProductPlanResult createProvisionedProductPlan(CreateProvisionedProductPlanRequest createProvisionedProductPlanRequest)

Creates a plan. A plan includes the list of resources to be created (when provisioning a new product) or modified (when updating a provisioned product) when the plan is executed.

You can create one plan per provisioned product. To create a plan for an existing provisioned product, the product status must be AVAILBLE or TAINTED.

To view the resource changes in the change set, use DescribeProvisionedProductPlan. To create or modify the provisioned product, use ExecuteProvisionedProductPlan.

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

CreateProvisioningArtifactResult createProvisioningArtifact(CreateProvisioningArtifactRequest createProvisioningArtifactRequest)

Creates a provisioning artifact (also known as a version) for the specified product.

You cannot create a provisioning artifact for a product that was shared with you.

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

CreateTagOptionResult createTagOption(CreateTagOptionRequest createTagOptionRequest)

Creates a TagOption.

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

DeleteConstraintResult deleteConstraint(DeleteConstraintRequest deleteConstraintRequest)

Deletes the specified constraint.

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

DeletePortfolioResult deletePortfolio(DeletePortfolioRequest deletePortfolioRequest)

Deletes the specified portfolio.

You cannot delete a portfolio if it was shared with you or if it has associated products, users, constraints, or shared accounts.

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

DeletePortfolioShareResult deletePortfolioShare(DeletePortfolioShareRequest deletePortfolioShareRequest)

Stops sharing the specified portfolio with the specified account.

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

DeleteProductResult deleteProduct(DeleteProductRequest deleteProductRequest)

Deletes the specified product.

You cannot delete a product if it was shared with you or is associated with a portfolio.

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

DeleteProvisionedProductPlanResult deleteProvisionedProductPlan(DeleteProvisionedProductPlanRequest deleteProvisionedProductPlanRequest)

Deletes the specified plan.

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

DeleteProvisioningArtifactResult deleteProvisioningArtifact(DeleteProvisioningArtifactRequest deleteProvisioningArtifactRequest)

Deletes the specified provisioning artifact (also known as a version) for the specified product.

You cannot delete a provisioning artifact associated with a product that was shared with you. You cannot delete the last provisioning artifact for a product, because a product must have at least one provisioning artifact.

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

DeleteTagOptionResult deleteTagOption(DeleteTagOptionRequest deleteTagOptionRequest)

Deletes the specified TagOption.

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

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

DescribeConstraintResult describeConstraint(DescribeConstraintRequest describeConstraintRequest)

Gets information about the specified constraint.

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

DescribeCopyProductStatusResult describeCopyProductStatus(DescribeCopyProductStatusRequest describeCopyProductStatusRequest)

Gets the status of the specified copy product operation.

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

DescribePortfolioResult describePortfolio(DescribePortfolioRequest describePortfolioRequest)

Gets information about the specified portfolio.

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

DescribeProductResult describeProduct(DescribeProductRequest describeProductRequest)

Gets information about the specified product.

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

DescribeProductAsAdminResult describeProductAsAdmin(DescribeProductAsAdminRequest describeProductAsAdminRequest)

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

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

DescribeProductViewResult describeProductView(DescribeProductViewRequest describeProductViewRequest)

Gets information about the specified product.

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

DescribeProvisionedProductResult describeProvisionedProduct(DescribeProvisionedProductRequest describeProvisionedProductRequest)

Gets information about the specified provisioned product.

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

DescribeProvisionedProductPlanResult describeProvisionedProductPlan(DescribeProvisionedProductPlanRequest describeProvisionedProductPlanRequest)

Gets information about the resource changes for the specified plan.

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

DescribeProvisioningArtifactResult describeProvisioningArtifact(DescribeProvisioningArtifactRequest describeProvisioningArtifactRequest)

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

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

DescribeProvisioningParametersResult describeProvisioningParameters(DescribeProvisioningParametersRequest describeProvisioningParametersRequest)

Gets information about the configuration required to provision the specified product using the specified provisioning artifact.

If the output contains a TagOption key with an empty list of values, there is a TagOption conflict for that key. The end user cannot take action to fix the conflict, and launch is not blocked. In subsequent calls to ProvisionProduct, do not include conflicted TagOption keys as tags, or this causes the error "Parameter validation failed: Missing required parameter in Tags[N]:Value". Tag the provisioned product with the value sc-tagoption-conflict-portfolioId-productId.

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

DescribeRecordResult describeRecord(DescribeRecordRequest describeRecordRequest)

Gets information about the specified request operation.

Use this operation after calling a request operation (for example, ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct).

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

DescribeTagOptionResult describeTagOption(DescribeTagOptionRequest describeTagOptionRequest)

Gets information about the specified TagOption.

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

DisassociatePrincipalFromPortfolioResult disassociatePrincipalFromPortfolio(DisassociatePrincipalFromPortfolioRequest disassociatePrincipalFromPortfolioRequest)

Disassociates a previously associated principal ARN from a specified portfolio.

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

DisassociateProductFromPortfolioResult disassociateProductFromPortfolio(DisassociateProductFromPortfolioRequest disassociateProductFromPortfolioRequest)

Disassociates the specified product from the specified portfolio.

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

DisassociateTagOptionFromResourceResult disassociateTagOptionFromResource(DisassociateTagOptionFromResourceRequest disassociateTagOptionFromResourceRequest)

Disassociates the specified TagOption from the specified resource.

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

ExecuteProvisionedProductPlanResult executeProvisionedProductPlan(ExecuteProvisionedProductPlanRequest executeProvisionedProductPlanRequest)

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

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

ListAcceptedPortfolioSharesResult listAcceptedPortfolioShares(ListAcceptedPortfolioSharesRequest listAcceptedPortfolioSharesRequest)

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

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

ListConstraintsForPortfolioResult listConstraintsForPortfolio(ListConstraintsForPortfolioRequest listConstraintsForPortfolioRequest)

Lists the constraints for the specified portfolio and product.

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

ListLaunchPathsResult listLaunchPaths(ListLaunchPathsRequest listLaunchPathsRequest)

Lists the paths to the specified product. A path is how the user has access to a specified product, and is necessary when provisioning a product. A path also determines the constraints put on the product.

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

ListPortfolioAccessResult listPortfolioAccess(ListPortfolioAccessRequest listPortfolioAccessRequest)

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

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

ListPortfoliosResult listPortfolios(ListPortfoliosRequest listPortfoliosRequest)

Lists all portfolios in the catalog.

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

ListPortfoliosForProductResult listPortfoliosForProduct(ListPortfoliosForProductRequest listPortfoliosForProductRequest)

Lists all portfolios that the specified product is associated with.

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

ListPrincipalsForPortfolioResult listPrincipalsForPortfolio(ListPrincipalsForPortfolioRequest listPrincipalsForPortfolioRequest)

Lists all principal ARNs associated with the specified portfolio.

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

ListProvisionedProductPlansResult listProvisionedProductPlans(ListProvisionedProductPlansRequest listProvisionedProductPlansRequest)

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

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

ListProvisioningArtifactsResult listProvisioningArtifacts(ListProvisioningArtifactsRequest listProvisioningArtifactsRequest)

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

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

ListRecordHistoryResult listRecordHistory(ListRecordHistoryRequest listRecordHistoryRequest)

Lists the specified requests or all performed requests.

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

ListResourcesForTagOptionResult listResourcesForTagOption(ListResourcesForTagOptionRequest listResourcesForTagOptionRequest)

Lists the resources associated with the specified TagOption.

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

ListTagOptionsResult listTagOptions(ListTagOptionsRequest listTagOptionsRequest)

Lists the specified TagOptions or all TagOptions.

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

ProvisionProductResult provisionProduct(ProvisionProductRequest provisionProductRequest)

Provisions the specified product.

A provisioned product is a resourced instance of a product. For example, provisioning a product based on a CloudFormation template launches a CloudFormation stack and its underlying resources. You can check the status of this request using DescribeRecord.

If the request contains a tag key with an empty list of values, there is a tag conflict for that key. Do not include conflicted keys as tags, or this causes the error "Parameter validation failed: Missing required parameter in Tags[N]:Value".

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

RejectPortfolioShareResult rejectPortfolioShare(RejectPortfolioShareRequest rejectPortfolioShareRequest)

Rejects an offer to share the specified portfolio.

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

ScanProvisionedProductsResult scanProvisionedProducts(ScanProvisionedProductsRequest scanProvisionedProductsRequest)

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

To use additional filtering, see SearchProvisionedProducts.

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

SearchProductsResult searchProducts(SearchProductsRequest searchProductsRequest)

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

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

SearchProductsAsAdminResult searchProductsAsAdmin(SearchProductsAsAdminRequest searchProductsAsAdminRequest)

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

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

SearchProvisionedProductsResult searchProvisionedProducts(SearchProvisionedProductsRequest searchProvisionedProductsRequest)

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

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

TerminateProvisionedProductResult terminateProvisionedProduct(TerminateProvisionedProductRequest terminateProvisionedProductRequest)

Terminates the specified provisioned product.

This operation does not delete any records associated with the provisioned product.

You can check the status of this request using DescribeRecord.

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

UpdateConstraintResult updateConstraint(UpdateConstraintRequest updateConstraintRequest)

Updates the specified constraint.

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

UpdatePortfolioResult updatePortfolio(UpdatePortfolioRequest updatePortfolioRequest)

Updates the specified portfolio.

You cannot update a product that was shared with you.

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

UpdateProductResult updateProduct(UpdateProductRequest updateProductRequest)

Updates the specified product.

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

UpdateProvisionedProductResult updateProvisionedProduct(UpdateProvisionedProductRequest updateProvisionedProductRequest)

Requests updates to the configuration of the specified provisioned product.

If there are tags associated with the object, they cannot be updated or added. Depending on the specific updates requested, this operation can update with no interruption, with some interruption, or replace the provisioned product entirely.

You can check the status of this request using DescribeRecord.

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

UpdateProvisioningArtifactResult updateProvisioningArtifact(UpdateProvisioningArtifactRequest updateProvisioningArtifactRequest)

Updates the specified provisioning artifact (also known as a version) for the specified product.

You cannot update a provisioning artifact for a product that was shared with you.

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

UpdateTagOptionResult updateTagOption(UpdateTagOptionRequest updateTagOptionRequest)

Updates the specified TagOption.

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

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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