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

Overview

AWS Service Catalog allows organizations to create and manage catalogs of IT services that are approved for use on AWS. This documentation provides reference material for the AWS Service Catalog end user API. To get the most out of this documentation, be familiar with the terminology discussed in AWS Service Catalog Concepts.

Additional Resources

• AWS Service Catalog Administrator Guide

• AWS Service Catalog User Guide

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 a portfolio.
AssociatePrincipalWithPortfolioResult	associatePrincipalWithPortfolio(AssociatePrincipalWithPortfolioRequest associatePrincipalWithPortfolioRequest) Associates the specified principal ARN with the specified portfolio.
AssociateProductWithPortfolioResult	associateProductWithPortfolio(AssociateProductWithPortfolioRequest associateProductWithPortfolioRequest) Associates a product with a portfolio.
AssociateTagOptionWithResourceResult	associateTagOptionWithResource(AssociateTagOptionWithResourceRequest associateTagOptionWithResourceRequest) Associate a TagOption identifier with a resource identifier.
CopyProductResult	copyProduct(CopyProductRequest copyProductRequest) Copies the specified source product to the specified target product or a new product.
CreateConstraintResult	createConstraint(CreateConstraintRequest createConstraintRequest) Creates a new constraint.
CreatePortfolioResult	createPortfolio(CreatePortfolioRequest createPortfolioRequest) Creates a new portfolio.
CreatePortfolioShareResult	createPortfolioShare(CreatePortfolioShareRequest createPortfolioShareRequest) Creates a new portfolio share.
CreateProductResult	createProduct(CreateProductRequest createProductRequest) Creates a new product.
CreateProvisioningArtifactResult	createProvisioningArtifact(CreateProvisioningArtifactRequest createProvisioningArtifactRequest) Create a new provisioning artifact for the specified product.
CreateTagOptionResult	createTagOption(CreateTagOptionRequest createTagOptionRequest) Create a new TagOption.
DeleteConstraintResult	deleteConstraint(DeleteConstraintRequest deleteConstraintRequest) Deletes the specified constraint.
DeletePortfolioResult	deletePortfolio(DeletePortfolioRequest deletePortfolioRequest) Deletes the specified portfolio.
DeletePortfolioShareResult	deletePortfolioShare(DeletePortfolioShareRequest deletePortfolioShareRequest) Deletes the specified portfolio share.
DeleteProductResult	deleteProduct(DeleteProductRequest deleteProductRequest) Deletes the specified product.
DeleteProvisioningArtifactResult	deleteProvisioningArtifact(DeleteProvisioningArtifactRequest deleteProvisioningArtifactRequest) Deletes the specified provisioning artifact.
DescribeConstraintResult	describeConstraint(DescribeConstraintRequest describeConstraintRequest) Retrieves detailed information for a specified constraint.
DescribeCopyProductStatusResult	describeCopyProductStatus(DescribeCopyProductStatusRequest describeCopyProductStatusRequest) Describes the status of the specified copy product operation.
DescribePortfolioResult	describePortfolio(DescribePortfolioRequest describePortfolioRequest) Retrieves detailed information and any tags associated with the specified portfolio.
DescribeProductResult	describeProduct(DescribeProductRequest describeProductRequest) Retrieves information about a specified product.
DescribeProductAsAdminResult	describeProductAsAdmin(DescribeProductAsAdminRequest describeProductAsAdminRequest) Retrieves information about a specified product, run with administrator access.
DescribeProductViewResult	describeProductView(DescribeProductViewRequest describeProductViewRequest) Retrieves information about a specified product.
DescribeProvisionedProductResult	describeProvisionedProduct(DescribeProvisionedProductRequest describeProvisionedProductRequest) Retrieve detailed information about the provisioned product.
DescribeProvisioningArtifactResult	describeProvisioningArtifact(DescribeProvisioningArtifactRequest describeProvisioningArtifactRequest) Retrieves detailed information about the specified provisioning artifact.
DescribeProvisioningParametersResult	describeProvisioningParameters(DescribeProvisioningParametersRequest describeProvisioningParametersRequest) Provides information about parameters required to provision a specified product in a specified manner.
DescribeRecordResult	describeRecord(DescribeRecordRequest describeRecordRequest) Retrieves a paginated list of the full details of a specific request.
DescribeTagOptionResult	describeTagOption(DescribeTagOptionRequest describeTagOptionRequest) Describes a 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 a TagOption from a resource.
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 details of all portfolios for which sharing was accepted by this account.
ListConstraintsForPortfolioResult	listConstraintsForPortfolio(ListConstraintsForPortfolioRequest listConstraintsForPortfolioRequest) Retrieves detailed constraint information for the specified portfolio and product.
ListLaunchPathsResult	listLaunchPaths(ListLaunchPathsRequest listLaunchPathsRequest) Returns a paginated list of all paths to a specified product.
ListPortfolioAccessResult	listPortfolioAccess(ListPortfolioAccessRequest listPortfolioAccessRequest) Lists the account IDs that have been authorized sharing of 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.
ListProvisioningArtifactsResult	listProvisioningArtifacts(ListProvisioningArtifactsRequest listProvisioningArtifactsRequest) Lists all provisioning artifacts associated with the specified product.
ListRecordHistoryResult	listRecordHistory(ListRecordHistoryRequest listRecordHistoryRequest) Returns a paginated list of all performed requests, in the form of RecordDetails objects that are filtered as specified.
ListResourcesForTagOptionResult	listResourcesForTagOption(ListResourcesForTagOptionRequest listResourcesForTagOptionRequest) Lists resources associated with a TagOption.
ListTagOptionsResult	listTagOptions(ListTagOptionsRequest listTagOptionsRequest) Lists detailed TagOptions information.
ProvisionProductResult	provisionProduct(ProvisionProductRequest provisionProductRequest) Requests a provision of a specified product.
RejectPortfolioShareResult	rejectPortfolioShare(RejectPortfolioShareRequest rejectPortfolioShareRequest) Rejects an offer to share a portfolio.
ScanProvisionedProductsResult	scanProvisionedProducts(ScanProvisionedProductsRequest scanProvisionedProductsRequest) Returns a paginated list of all the ProvisionedProduct objects that are currently available (not terminated).
SearchProductsResult	searchProducts(SearchProductsRequest searchProductsRequest) Returns a paginated list all of the Products objects to which the caller has access.
SearchProductsAsAdminResult	searchProductsAsAdmin(SearchProductsAsAdminRequest searchProductsAsAdminRequest) Retrieves summary and status information about all products created within the caller's account.
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) Requests termination of an existing ProvisionedProduct object.
UpdateConstraintResult	updateConstraint(UpdateConstraintRequest updateConstraintRequest) Updates an existing constraint.
UpdatePortfolioResult	updatePortfolio(UpdatePortfolioRequest updatePortfolioRequest) Updates the specified portfolio's details.
UpdateProductResult	updateProduct(UpdateProductRequest updateProductRequest) Updates an existing product.
UpdateProvisionedProductResult	updateProvisionedProduct(UpdateProvisionedProductRequest updateProvisionedProductRequest) Requests updates to the configuration of an existing ProvisionedProduct object.
UpdateProvisioningArtifactResult	updateProvisioningArtifact(UpdateProvisioningArtifactRequest updateProvisioningArtifactRequest) Updates an existing provisioning artifact's information.
UpdateTagOptionResult	updateTagOption(UpdateTagOptionRequest updateTagOptionRequest) Updates an existing 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 a portfolio.

Parameters:

acceptPortfolioShareRequest -

Returns:

Result of the AcceptPortfolioShare operation returned by the service.

Throws:

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

ResourceNotFoundException - The specified resource was not found.

LimitExceededException - The current limits of the service would have been exceeded by this operation. Reduce the resource use or increase the 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 invalid.

ResourceNotFoundException - The specified resource was not found.

LimitExceededException - The current limits of the service would have been exceeded by this operation. Reduce the resource use or increase the service limits and retry the operation.

See Also:

AWS API Documentation

associateProductWithPortfolio

AssociateProductWithPortfolioResult associateProductWithPortfolio(AssociateProductWithPortfolioRequest associateProductWithPortfolioRequest)

Associates a product with a portfolio.

Parameters:

associateProductWithPortfolioRequest -

Returns:

Result of the AssociateProductWithPortfolio operation returned by the service.

Throws:

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

ResourceNotFoundException - The specified resource was not found.

LimitExceededException - The current limits of the service would have been exceeded by this operation. Reduce the resource use or increase the service limits and retry the operation.

See Also:

AWS API Documentation

associateTagOptionWithResource

AssociateTagOptionWithResourceResult associateTagOptionWithResource(AssociateTagOptionWithResourceRequest associateTagOptionWithResourceRequest)

Associate a TagOption identifier with a resource identifier.

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

LimitExceededException - The current limits of the service would have been exceeded by this operation. Reduce the resource use or increase the 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 an invalid state. Inspect the resource you are using for this operation to ensure that all resource states are valid 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 the product to the same account or another account. You can copy the 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 invalid.

See Also:

AWS API Documentation

createConstraint

CreateConstraintResult createConstraint(CreateConstraintRequest createConstraintRequest)

Creates a new constraint. For more information, see Using Constraints.

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

LimitExceededException - The current limits of the service would have been exceeded by this operation. Reduce the resource use or increase the 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 new portfolio.

Parameters:

createPortfolioRequest -

Returns:

Result of the CreatePortfolio operation returned by the service.

Throws:

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

LimitExceededException - The current limits of the service would have been exceeded by this operation. Reduce the resource use or increase the 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)

Creates a new portfolio share.

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. Reduce the resource use or increase the service limits and retry the operation.

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

See Also:

AWS API Documentation

createProduct

CreateProductResult createProduct(CreateProductRequest createProductRequest)

Creates a new product.

Parameters:

createProductRequest -

Returns:

Result of the CreateProduct operation returned by the service.

Throws:

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

LimitExceededException - The current limits of the service would have been exceeded by this operation. Reduce the resource use or increase the 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

createProvisioningArtifact

CreateProvisioningArtifactResult createProvisioningArtifact(CreateProvisioningArtifactRequest createProvisioningArtifactRequest)

Create a new provisioning artifact for the specified product. This operation does not work with a product that has been 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 invalid.

LimitExceededException - The current limits of the service would have been exceeded by this operation. Reduce the resource use or increase the service limits and retry the operation.

See Also:

AWS API Documentation

createTagOption

CreateTagOptionResult createTagOption(CreateTagOptionRequest createTagOptionRequest)

Create a new 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. Reduce the resource use or increase the 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 invalid.

See Also:

AWS API Documentation

deletePortfolio

DeletePortfolioResult deletePortfolio(DeletePortfolioRequest deletePortfolioRequest)

Deletes the specified portfolio. This operation does not work with a portfolio that has been shared with you or if it has products, users, constraints, or shared accounts associated with it.

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

ResourceInUseException - The operation was requested against a resource that is currently in use. Free the resource from 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)

Deletes the specified portfolio share.

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. This operation does not work with a product that has been 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 - The operation was requested against a resource that is currently in use. Free the resource from use and retry the operation.

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

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

deleteProvisioningArtifact

DeleteProvisioningArtifactResult deleteProvisioningArtifact(DeleteProvisioningArtifactRequest deleteProvisioningArtifactRequest)

Deletes the specified provisioning artifact. This operation does not work on a provisioning artifact associated with a product that has been shared with you, or on the last provisioning artifact associated with a product (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 - The operation was requested against a resource that is currently in use. Free the resource from use and retry the operation.

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

See Also:

AWS API Documentation

describeConstraint

DescribeConstraintResult describeConstraint(DescribeConstraintRequest describeConstraintRequest)

Retrieves detailed information for a 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)

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

Retrieves detailed information and any tags associated with 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)

Retrieves information about a specified product.

This operation is functionally identical to DescribeProductView except that it takes as input ProductId instead of ProductViewId.

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

See Also:

AWS API Documentation

describeProductAsAdmin

DescribeProductAsAdminResult describeProductAsAdmin(DescribeProductAsAdminRequest describeProductAsAdminRequest)

Retrieves information about a specified product, 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)

Retrieves information about a specified product.

This operation is functionally identical to DescribeProduct except that it takes as input ProductViewId instead of ProductId.

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

See Also:

AWS API Documentation

describeProvisionedProduct

DescribeProvisionedProductResult describeProvisionedProduct(DescribeProvisionedProductRequest describeProvisionedProductRequest)

Retrieve detailed information about the 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

describeProvisioningArtifact

DescribeProvisioningArtifactResult describeProvisioningArtifact(DescribeProvisioningArtifactRequest describeProvisioningArtifactRequest)

Retrieves detailed information about the specified provisioning artifact.

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)

Provides information about parameters required to provision a specified product in a specified manner. Use this operation to obtain the list of ProvisioningArtifactParameters parameters available to call the ProvisionProduct operation for the specified product.

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 the ProvisionProduct operation, do not include conflicted TagOption keys as tags. Calls to ProvisionProduct with empty TagOption values cause the error "Parameter validation failed: Missing required parameter in Tags[N]:Value ". Calls to ProvisionProduct with conflicted TagOption keys automatically tag the provisioned product with the conflicted keys 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 invalid.

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

describeRecord

DescribeRecordResult describeRecord(DescribeRecordRequest describeRecordRequest)

Retrieves a paginated list of the full details of a specific request. Use this operation after calling a request operation (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)

Describes a 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 invalid.

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 - The operation was requested against a resource that is currently in use. Free the resource from use and retry the operation.

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

See Also:

AWS API Documentation

disassociateTagOptionFromResource

DisassociateTagOptionFromResourceResult disassociateTagOptionFromResource(DisassociateTagOptionFromResourceRequest disassociateTagOptionFromResourceRequest)

Disassociates a TagOption from a 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

listAcceptedPortfolioShares

ListAcceptedPortfolioSharesResult listAcceptedPortfolioShares(ListAcceptedPortfolioSharesRequest listAcceptedPortfolioSharesRequest)

Lists details of 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 invalid.

See Also:

AWS API Documentation

listConstraintsForPortfolio

ListConstraintsForPortfolioResult listConstraintsForPortfolio(ListConstraintsForPortfolioRequest listConstraintsForPortfolioRequest)

Retrieves detailed constraint information 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 invalid.

See Also:

AWS API Documentation

listLaunchPaths

ListLaunchPathsResult listLaunchPaths(ListLaunchPathsRequest listLaunchPathsRequest)

Returns a paginated list of all paths to a 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 invalid.

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

listPortfolioAccess

ListPortfolioAccessResult listPortfolioAccess(ListPortfolioAccessRequest listPortfolioAccessRequest)

Lists the account IDs that have been authorized sharing of 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 invalid.

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

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

See Also:

AWS API Documentation

listProvisioningArtifacts

ListProvisioningArtifactsResult listProvisioningArtifacts(ListProvisioningArtifactsRequest listProvisioningArtifactsRequest)

Lists all provisioning artifacts associated with 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 invalid.

See Also:

AWS API Documentation

listRecordHistory

ListRecordHistoryResult listRecordHistory(ListRecordHistoryRequest listRecordHistoryRequest)

Returns a paginated list of all performed requests, in the form of RecordDetails objects that are filtered as specified.

Parameters:

listRecordHistoryRequest -

Returns:

Result of the ListRecordHistory operation returned by the service.

Throws:

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

See Also:

AWS API Documentation

listResourcesForTagOption

ListResourcesForTagOptionResult listResourcesForTagOption(ListResourcesForTagOptionRequest listResourcesForTagOptionRequest)

Lists resources associated with a 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 invalid.

See Also:

AWS API Documentation

listTagOptions

ListTagOptionsResult listTagOptions(ListTagOptionsRequest listTagOptionsRequest)

Lists detailed TagOptions information.

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

See Also:

AWS API Documentation

provisionProduct

ProvisionProductResult provisionProduct(ProvisionProductRequest provisionProductRequest)

Requests a provision of a specified product. A provisioned product is a resourced instance for a product. For example, provisioning a CloudFormation-template-backed product results in launching a CloudFormation stack and all the underlying resources that come with it.

You can check the status of this request using the DescribeRecord operation. The error "Parameter validation failed: Missing required parameter in Tags[N]:Value" indicates that your request contains a tag which has a tag key but no corresponding tag value (value is empty or null). Your call may have included values returned from a DescribeProvisioningParameters call that resulted in a TagOption key with an empty list. This happens when TagOption keys are in conflict. For more information, see DescribeProvisioningParameters.

Parameters:

provisionProductRequest -

Returns:

Result of the ProvisionProduct operation returned by the service.

Throws:

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

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

Returns a paginated list of all the ProvisionedProduct objects that are currently available (not terminated).

Parameters:

scanProvisionedProductsRequest -

Returns:

Result of the ScanProvisionedProducts operation returned by the service.

Throws:

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

See Also:

AWS API Documentation

searchProducts

SearchProductsResult searchProducts(SearchProductsRequest searchProductsRequest)

Returns a paginated list all of the Products objects to which the caller has access.

The output of this operation can be used as input for other operations, such as DescribeProductView.

Parameters:

searchProductsRequest -

Returns:

Result of the SearchProducts operation returned by the service.

Throws:

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

See Also:

AWS API Documentation

searchProductsAsAdmin

SearchProductsAsAdminResult searchProductsAsAdmin(SearchProductsAsAdminRequest searchProductsAsAdminRequest)

Retrieves summary and status information about all products created within the caller's account. If a portfolio ID is provided, this operation retrieves information for only those products that are associated with the specified portfolio.

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

See Also:

AWS API Documentation

terminateProvisionedProduct

TerminateProvisionedProductResult terminateProvisionedProduct(TerminateProvisionedProductRequest terminateProvisionedProductRequest)

Requests termination of an existing ProvisionedProduct object. If there are Tags associated with the object, they are terminated when the ProvisionedProduct object is terminated.

This operation does not delete any records associated with the ProvisionedProduct object.

You can check the status of this request using the DescribeRecord operation.

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 an existing 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 invalid.

See Also:

AWS API Documentation

updatePortfolio

UpdatePortfolioResult updatePortfolio(UpdatePortfolioRequest updatePortfolioRequest)

Updates the specified portfolio's details. This operation does not work with a product that has been 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 invalid.

ResourceNotFoundException - The specified resource was not found.

LimitExceededException - The current limits of the service would have been exceeded by this operation. Reduce the resource use or increase the 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 an existing 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 invalid.

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 an existing ProvisionedProduct object. If there are tags associated with the object, they cannot be updated or added with this operation. Depending on the specific updates requested, this operation may update with no interruption, with some interruption, or replace the ProvisionedProduct object entirely.

You can check the status of this request using the DescribeRecord operation.

Parameters:

updateProvisionedProductRequest -

Returns:

Result of the UpdateProvisionedProduct operation returned by the service.

Throws:

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

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

updateProvisioningArtifact

UpdateProvisioningArtifactResult updateProvisioningArtifact(UpdateProvisioningArtifactRequest updateProvisioningArtifactRequest)

Updates an existing provisioning artifact's information. This operation does not work on a provisioning artifact associated with a product that has been 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 invalid.

See Also:

AWS API Documentation

updateTagOption

UpdateTagOptionResult updateTagOption(UpdateTagOptionRequest updateTagOptionRequest)

Updates an existing 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 invalid.

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.