AutoCloseable
@Generated("software.amazon.awssdk:codegen") public interface ServiceCatalogClient extends AutoCloseable
builder()
method.
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
Modifier and Type | Field | Description |
---|---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method | Description |
---|---|---|
default AcceptPortfolioShareResponse |
acceptPortfolioShare(AcceptPortfolioShareRequest acceptPortfolioShareRequest) |
Accepts an offer to share a portfolio.
|
default AssociatePrincipalWithPortfolioResponse |
associatePrincipalWithPortfolio(AssociatePrincipalWithPortfolioRequest associatePrincipalWithPortfolioRequest) |
Associates the specified principal ARN with the specified portfolio.
|
default AssociateProductWithPortfolioResponse |
associateProductWithPortfolio(AssociateProductWithPortfolioRequest associateProductWithPortfolioRequest) |
Associates a product with a portfolio.
|
static ServiceCatalogClientBuilder |
builder() |
Create a builder that can be used to configure and create a
ServiceCatalogClient . |
static ServiceCatalogClient |
create() |
Create a
ServiceCatalogClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CreateConstraintResponse |
createConstraint(CreateConstraintRequest createConstraintRequest) |
Creates a new constraint.
|
default CreatePortfolioResponse |
createPortfolio(CreatePortfolioRequest createPortfolioRequest) |
Creates a new portfolio.
|
default CreatePortfolioShareResponse |
createPortfolioShare(CreatePortfolioShareRequest createPortfolioShareRequest) |
Creates a new portfolio share.
|
default CreateProductResponse |
createProduct(CreateProductRequest createProductRequest) |
Creates a new product.
|
default CreateProvisioningArtifactResponse |
createProvisioningArtifact(CreateProvisioningArtifactRequest createProvisioningArtifactRequest) |
Create a new provisioning artifact for the specified product.
|
default DeleteConstraintResponse |
deleteConstraint(DeleteConstraintRequest deleteConstraintRequest) |
Deletes the specified constraint.
|
default DeletePortfolioResponse |
deletePortfolio(DeletePortfolioRequest deletePortfolioRequest) |
Deletes the specified portfolio.
|
default DeletePortfolioShareResponse |
deletePortfolioShare(DeletePortfolioShareRequest deletePortfolioShareRequest) |
Deletes the specified portfolio share.
|
default DeleteProductResponse |
deleteProduct(DeleteProductRequest deleteProductRequest) |
Deletes the specified product.
|
default DeleteProvisioningArtifactResponse |
deleteProvisioningArtifact(DeleteProvisioningArtifactRequest deleteProvisioningArtifactRequest) |
Deletes the specified provisioning artifact.
|
default DescribeConstraintResponse |
describeConstraint(DescribeConstraintRequest describeConstraintRequest) |
Retrieves detailed information for a specified constraint.
|
default DescribePortfolioResponse |
describePortfolio(DescribePortfolioRequest describePortfolioRequest) |
Retrieves detailed information and any tags associated with the specified portfolio.
|
default DescribeProductResponse |
describeProduct(DescribeProductRequest describeProductRequest) |
Retrieves information about a specified product.
|
default DescribeProductAsAdminResponse |
describeProductAsAdmin(DescribeProductAsAdminRequest describeProductAsAdminRequest) |
Retrieves information about a specified product, run with administrator access.
|
default DescribeProductViewResponse |
describeProductView(DescribeProductViewRequest describeProductViewRequest) |
Retrieves information about a specified product.
|
default DescribeProvisionedProductResponse |
describeProvisionedProduct(DescribeProvisionedProductRequest describeProvisionedProductRequest) |
Retrieve detailed information about the provisioned product.
|
default DescribeProvisioningArtifactResponse |
describeProvisioningArtifact(DescribeProvisioningArtifactRequest describeProvisioningArtifactRequest) |
Retrieves detailed information about the specified provisioning artifact.
|
default DescribeProvisioningParametersResponse |
describeProvisioningParameters(DescribeProvisioningParametersRequest describeProvisioningParametersRequest) |
Provides information about parameters required to provision a specified product in a specified manner.
|
default DescribeRecordResponse |
describeRecord(DescribeRecordRequest describeRecordRequest) |
Retrieves a paginated list of the full details of a specific request.
|
default DisassociatePrincipalFromPortfolioResponse |
disassociatePrincipalFromPortfolio(DisassociatePrincipalFromPortfolioRequest disassociatePrincipalFromPortfolioRequest) |
Disassociates a previously associated principal ARN from a specified portfolio.
|
default DisassociateProductFromPortfolioResponse |
disassociateProductFromPortfolio(DisassociateProductFromPortfolioRequest disassociateProductFromPortfolioRequest) |
Disassociates the specified product from the specified portfolio.
|
default ListAcceptedPortfolioSharesResponse |
listAcceptedPortfolioShares(ListAcceptedPortfolioSharesRequest listAcceptedPortfolioSharesRequest) |
Lists details of all portfolios for which sharing was accepted by this account.
|
default ListConstraintsForPortfolioResponse |
listConstraintsForPortfolio(ListConstraintsForPortfolioRequest listConstraintsForPortfolioRequest) |
Retrieves detailed constraint information for the specified portfolio and product.
|
default ListLaunchPathsResponse |
listLaunchPaths(ListLaunchPathsRequest listLaunchPathsRequest) |
Returns a paginated list of all paths to a specified product.
|
default ListPortfolioAccessResponse |
listPortfolioAccess(ListPortfolioAccessRequest listPortfolioAccessRequest) |
Lists the account IDs that have been authorized sharing of the specified portfolio.
|
default ListPortfoliosResponse |
listPortfolios(ListPortfoliosRequest listPortfoliosRequest) |
Lists all portfolios in the catalog.
|
default ListPortfoliosForProductResponse |
listPortfoliosForProduct(ListPortfoliosForProductRequest listPortfoliosForProductRequest) |
Lists all portfolios that the specified product is associated with.
|
default ListPrincipalsForPortfolioResponse |
listPrincipalsForPortfolio(ListPrincipalsForPortfolioRequest listPrincipalsForPortfolioRequest) |
Lists all principal ARNs associated with the specified portfolio.
|
default ListProvisioningArtifactsResponse |
listProvisioningArtifacts(ListProvisioningArtifactsRequest listProvisioningArtifactsRequest) |
Lists all provisioning artifacts associated with the specified product.
|
default ListRecordHistoryResponse |
listRecordHistory(ListRecordHistoryRequest listRecordHistoryRequest) |
Returns a paginated list of all performed requests, in the form of RecordDetails objects that are filtered as
specified.
|
default ProvisionProductResponse |
provisionProduct(ProvisionProductRequest provisionProductRequest) |
Requests a provision of a specified product.
|
default RejectPortfolioShareResponse |
rejectPortfolioShare(RejectPortfolioShareRequest rejectPortfolioShareRequest) |
Rejects an offer to share a portfolio.
|
default ScanProvisionedProductsResponse |
scanProvisionedProducts(ScanProvisionedProductsRequest scanProvisionedProductsRequest) |
Returns a paginated list of all the ProvisionedProduct objects that are currently available (not terminated).
|
default SearchProductsResponse |
searchProducts(SearchProductsRequest searchProductsRequest) |
Returns a paginated list all of the
Products objects to which the caller has access. |
default SearchProductsAsAdminResponse |
searchProductsAsAdmin(SearchProductsAsAdminRequest searchProductsAsAdminRequest) |
Retrieves summary and status information about all products created within the caller's account.
|
static ServiceMetadata |
serviceMetadata() |
|
default TerminateProvisionedProductResponse |
terminateProvisionedProduct(TerminateProvisionedProductRequest terminateProvisionedProductRequest) |
Requests termination of an existing ProvisionedProduct object.
|
default UpdateConstraintResponse |
updateConstraint(UpdateConstraintRequest updateConstraintRequest) |
Updates an existing constraint.
|
default UpdatePortfolioResponse |
updatePortfolio(UpdatePortfolioRequest updatePortfolioRequest) |
Updates the specified portfolio's details.
|
default UpdateProductResponse |
updateProduct(UpdateProductRequest updateProductRequest) |
Updates an existing product.
|
default UpdateProvisionedProductResponse |
updateProvisionedProduct(UpdateProvisionedProductRequest updateProvisionedProductRequest) |
Requests updates to the configuration of an existing ProvisionedProduct object.
|
default UpdateProvisioningArtifactResponse |
updateProvisioningArtifact(UpdateProvisioningArtifactRequest updateProvisioningArtifactRequest) |
Updates an existing provisioning artifact's information.
|
close
static final String SERVICE_NAME
static ServiceCatalogClient create()
ServiceCatalogClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static ServiceCatalogClientBuilder builder()
ServiceCatalogClient
.default AcceptPortfolioShareResponse acceptPortfolioShare(AcceptPortfolioShareRequest acceptPortfolioShareRequest) throws InvalidParametersException, ResourceNotFoundException, LimitExceededException, SdkBaseException, SdkClientException, ServiceCatalogException
Accepts an offer to share a portfolio.
acceptPortfolioShareRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault AssociatePrincipalWithPortfolioResponse associatePrincipalWithPortfolio(AssociatePrincipalWithPortfolioRequest associatePrincipalWithPortfolioRequest) throws InvalidParametersException, ResourceNotFoundException, LimitExceededException, SdkBaseException, SdkClientException, ServiceCatalogException
Associates the specified principal ARN with the specified portfolio.
associatePrincipalWithPortfolioRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault AssociateProductWithPortfolioResponse associateProductWithPortfolio(AssociateProductWithPortfolioRequest associateProductWithPortfolioRequest) throws InvalidParametersException, ResourceNotFoundException, LimitExceededException, SdkBaseException, SdkClientException, ServiceCatalogException
Associates a product with a portfolio.
associateProductWithPortfolioRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateConstraintResponse createConstraint(CreateConstraintRequest createConstraintRequest) throws ResourceNotFoundException, InvalidParametersException, LimitExceededException, DuplicateResourceException, SdkBaseException, SdkClientException, ServiceCatalogException
Creates a new constraint. For more information, see Using Constraints.
createConstraintRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreatePortfolioResponse createPortfolio(CreatePortfolioRequest createPortfolioRequest) throws InvalidParametersException, LimitExceededException, SdkBaseException, SdkClientException, ServiceCatalogException
Creates a new portfolio.
createPortfolioRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreatePortfolioShareResponse createPortfolioShare(CreatePortfolioShareRequest createPortfolioShareRequest) throws ResourceNotFoundException, LimitExceededException, InvalidParametersException, SdkBaseException, SdkClientException, ServiceCatalogException
Creates a new portfolio share.
createPortfolioShareRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateProductResponse createProduct(CreateProductRequest createProductRequest) throws InvalidParametersException, LimitExceededException, SdkBaseException, SdkClientException, ServiceCatalogException
Creates a new product.
createProductRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateProvisioningArtifactResponse createProvisioningArtifact(CreateProvisioningArtifactRequest createProvisioningArtifactRequest) throws ResourceNotFoundException, InvalidParametersException, LimitExceededException, SdkBaseException, SdkClientException, ServiceCatalogException
Create a new provisioning artifact for the specified product. This operation does not work with a product that has been shared with you.
See the bottom of this topic for an example JSON request.
createProvisioningArtifactRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteConstraintResponse deleteConstraint(DeleteConstraintRequest deleteConstraintRequest) throws ResourceNotFoundException, InvalidParametersException, SdkBaseException, SdkClientException, ServiceCatalogException
Deletes the specified constraint.
deleteConstraintRequest
- ResourceNotFoundException
- The specified resource was not found.InvalidParametersException
- One or more parameters provided to the operation are invalid.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeletePortfolioResponse deletePortfolio(DeletePortfolioRequest deletePortfolioRequest) throws ResourceNotFoundException, InvalidParametersException, ResourceInUseException, SdkBaseException, SdkClientException, ServiceCatalogException
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.
deletePortfolioRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeletePortfolioShareResponse deletePortfolioShare(DeletePortfolioShareRequest deletePortfolioShareRequest) throws ResourceNotFoundException, SdkBaseException, SdkClientException, ServiceCatalogException
Deletes the specified portfolio share.
deletePortfolioShareRequest
- ResourceNotFoundException
- The specified resource was not found.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteProductResponse deleteProduct(DeleteProductRequest deleteProductRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidParametersException, SdkBaseException, SdkClientException, ServiceCatalogException
Deletes the specified product. This operation does not work with a product that has been shared with you or is associated with a portfolio.
deleteProductRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteProvisioningArtifactResponse deleteProvisioningArtifact(DeleteProvisioningArtifactRequest deleteProvisioningArtifactRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidParametersException, SdkBaseException, SdkClientException, ServiceCatalogException
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).
deleteProvisioningArtifactRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeConstraintResponse describeConstraint(DescribeConstraintRequest describeConstraintRequest) throws ResourceNotFoundException, SdkBaseException, SdkClientException, ServiceCatalogException
Retrieves detailed information for a specified constraint.
describeConstraintRequest
- ResourceNotFoundException
- The specified resource was not found.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribePortfolioResponse describePortfolio(DescribePortfolioRequest describePortfolioRequest) throws ResourceNotFoundException, SdkBaseException, SdkClientException, ServiceCatalogException
Retrieves detailed information and any tags associated with the specified portfolio.
describePortfolioRequest
- ResourceNotFoundException
- The specified resource was not found.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeProductResponse describeProduct(DescribeProductRequest describeProductRequest) throws ResourceNotFoundException, InvalidParametersException, SdkBaseException, SdkClientException, ServiceCatalogException
Retrieves information about a specified product.
This operation is functionally identical to DescribeProductView except that it takes as input
ProductId
instead of ProductViewId
.
describeProductRequest
- ResourceNotFoundException
- The specified resource was not found.InvalidParametersException
- One or more parameters provided to the operation are invalid.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeProductAsAdminResponse describeProductAsAdmin(DescribeProductAsAdminRequest describeProductAsAdminRequest) throws ResourceNotFoundException, SdkBaseException, SdkClientException, ServiceCatalogException
Retrieves information about a specified product, run with administrator access.
describeProductAsAdminRequest
- ResourceNotFoundException
- The specified resource was not found.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeProductViewResponse describeProductView(DescribeProductViewRequest describeProductViewRequest) throws ResourceNotFoundException, InvalidParametersException, SdkBaseException, SdkClientException, ServiceCatalogException
Retrieves information about a specified product.
This operation is functionally identical to DescribeProduct except that it takes as input
ProductViewId
instead of ProductId
.
describeProductViewRequest
- ResourceNotFoundException
- The specified resource was not found.InvalidParametersException
- One or more parameters provided to the operation are invalid.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeProvisionedProductResponse describeProvisionedProduct(DescribeProvisionedProductRequest describeProvisionedProductRequest) throws ResourceNotFoundException, SdkBaseException, SdkClientException, ServiceCatalogException
Retrieve detailed information about the provisioned product.
describeProvisionedProductRequest
- ResourceNotFoundException
- The specified resource was not found.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeProvisioningArtifactResponse describeProvisioningArtifact(DescribeProvisioningArtifactRequest describeProvisioningArtifactRequest) throws ResourceNotFoundException, SdkBaseException, SdkClientException, ServiceCatalogException
Retrieves detailed information about the specified provisioning artifact.
describeProvisioningArtifactRequest
- ResourceNotFoundException
- The specified resource was not found.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeProvisioningParametersResponse describeProvisioningParameters(DescribeProvisioningParametersRequest describeProvisioningParametersRequest) throws InvalidParametersException, ResourceNotFoundException, SdkBaseException, SdkClientException, ServiceCatalogException
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.
describeProvisioningParametersRequest
- InvalidParametersException
- One or more parameters provided to the operation are invalid.ResourceNotFoundException
- The specified resource was not found.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeRecordResponse describeRecord(DescribeRecordRequest describeRecordRequest) throws ResourceNotFoundException, SdkBaseException, SdkClientException, ServiceCatalogException
Retrieves a paginated list of the full details of a specific request. Use this operation after calling a request operation (ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct).
describeRecordRequest
- ResourceNotFoundException
- The specified resource was not found.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DisassociatePrincipalFromPortfolioResponse disassociatePrincipalFromPortfolio(DisassociatePrincipalFromPortfolioRequest disassociatePrincipalFromPortfolioRequest) throws InvalidParametersException, ResourceNotFoundException, SdkBaseException, SdkClientException, ServiceCatalogException
Disassociates a previously associated principal ARN from a specified portfolio.
disassociatePrincipalFromPortfolioRequest
- InvalidParametersException
- One or more parameters provided to the operation are invalid.ResourceNotFoundException
- The specified resource was not found.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DisassociateProductFromPortfolioResponse disassociateProductFromPortfolio(DisassociateProductFromPortfolioRequest disassociateProductFromPortfolioRequest) throws ResourceNotFoundException, InvalidParametersException, SdkBaseException, SdkClientException, ServiceCatalogException
Disassociates the specified product from the specified portfolio.
disassociateProductFromPortfolioRequest
- ResourceNotFoundException
- The specified resource was not found.InvalidParametersException
- One or more parameters provided to the operation are invalid.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListAcceptedPortfolioSharesResponse listAcceptedPortfolioShares(ListAcceptedPortfolioSharesRequest listAcceptedPortfolioSharesRequest) throws InvalidParametersException, SdkBaseException, SdkClientException, ServiceCatalogException
Lists details of all portfolios for which sharing was accepted by this account.
listAcceptedPortfolioSharesRequest
- InvalidParametersException
- One or more parameters provided to the operation are invalid.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListConstraintsForPortfolioResponse listConstraintsForPortfolio(ListConstraintsForPortfolioRequest listConstraintsForPortfolioRequest) throws ResourceNotFoundException, InvalidParametersException, SdkBaseException, SdkClientException, ServiceCatalogException
Retrieves detailed constraint information for the specified portfolio and product.
listConstraintsForPortfolioRequest
- ResourceNotFoundException
- The specified resource was not found.InvalidParametersException
- One or more parameters provided to the operation are invalid.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListLaunchPathsResponse listLaunchPaths(ListLaunchPathsRequest listLaunchPathsRequest) throws InvalidParametersException, ResourceNotFoundException, SdkBaseException, SdkClientException, ServiceCatalogException
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.
listLaunchPathsRequest
- InvalidParametersException
- One or more parameters provided to the operation are invalid.ResourceNotFoundException
- The specified resource was not found.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListPortfolioAccessResponse listPortfolioAccess(ListPortfolioAccessRequest listPortfolioAccessRequest) throws ResourceNotFoundException, SdkBaseException, SdkClientException, ServiceCatalogException
Lists the account IDs that have been authorized sharing of the specified portfolio.
listPortfolioAccessRequest
- ResourceNotFoundException
- The specified resource was not found.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListPortfoliosResponse listPortfolios(ListPortfoliosRequest listPortfoliosRequest) throws InvalidParametersException, SdkBaseException, SdkClientException, ServiceCatalogException
Lists all portfolios in the catalog.
listPortfoliosRequest
- InvalidParametersException
- One or more parameters provided to the operation are invalid.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListPortfoliosForProductResponse listPortfoliosForProduct(ListPortfoliosForProductRequest listPortfoliosForProductRequest) throws InvalidParametersException, ResourceNotFoundException, SdkBaseException, SdkClientException, ServiceCatalogException
Lists all portfolios that the specified product is associated with.
listPortfoliosForProductRequest
- InvalidParametersException
- One or more parameters provided to the operation are invalid.ResourceNotFoundException
- The specified resource was not found.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListPrincipalsForPortfolioResponse listPrincipalsForPortfolio(ListPrincipalsForPortfolioRequest listPrincipalsForPortfolioRequest) throws ResourceNotFoundException, InvalidParametersException, SdkBaseException, SdkClientException, ServiceCatalogException
Lists all principal ARNs associated with the specified portfolio.
listPrincipalsForPortfolioRequest
- ResourceNotFoundException
- The specified resource was not found.InvalidParametersException
- One or more parameters provided to the operation are invalid.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListProvisioningArtifactsResponse listProvisioningArtifacts(ListProvisioningArtifactsRequest listProvisioningArtifactsRequest) throws ResourceNotFoundException, InvalidParametersException, SdkBaseException, SdkClientException, ServiceCatalogException
Lists all provisioning artifacts associated with the specified product.
listProvisioningArtifactsRequest
- ResourceNotFoundException
- The specified resource was not found.InvalidParametersException
- One or more parameters provided to the operation are invalid.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListRecordHistoryResponse listRecordHistory(ListRecordHistoryRequest listRecordHistoryRequest) throws InvalidParametersException, SdkBaseException, SdkClientException, ServiceCatalogException
Returns a paginated list of all performed requests, in the form of RecordDetails objects that are filtered as specified.
listRecordHistoryRequest
- InvalidParametersException
- One or more parameters provided to the operation are invalid.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ProvisionProductResponse provisionProduct(ProvisionProductRequest provisionProductRequest) throws InvalidParametersException, ResourceNotFoundException, DuplicateResourceException, SdkBaseException, SdkClientException, ServiceCatalogException
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.
provisionProductRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RejectPortfolioShareResponse rejectPortfolioShare(RejectPortfolioShareRequest rejectPortfolioShareRequest) throws ResourceNotFoundException, SdkBaseException, SdkClientException, ServiceCatalogException
Rejects an offer to share a portfolio.
rejectPortfolioShareRequest
- ResourceNotFoundException
- The specified resource was not found.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ScanProvisionedProductsResponse scanProvisionedProducts(ScanProvisionedProductsRequest scanProvisionedProductsRequest) throws InvalidParametersException, SdkBaseException, SdkClientException, ServiceCatalogException
Returns a paginated list of all the ProvisionedProduct objects that are currently available (not terminated).
scanProvisionedProductsRequest
- InvalidParametersException
- One or more parameters provided to the operation are invalid.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault SearchProductsResponse searchProducts(SearchProductsRequest searchProductsRequest) throws InvalidParametersException, SdkBaseException, SdkClientException, ServiceCatalogException
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.
searchProductsRequest
- InvalidParametersException
- One or more parameters provided to the operation are invalid.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault SearchProductsAsAdminResponse searchProductsAsAdmin(SearchProductsAsAdminRequest searchProductsAsAdminRequest) throws ResourceNotFoundException, InvalidParametersException, SdkBaseException, SdkClientException, ServiceCatalogException
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.
searchProductsAsAdminRequest
- ResourceNotFoundException
- The specified resource was not found.InvalidParametersException
- One or more parameters provided to the operation are invalid.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault TerminateProvisionedProductResponse terminateProvisionedProduct(TerminateProvisionedProductRequest terminateProvisionedProductRequest) throws ResourceNotFoundException, SdkBaseException, SdkClientException, ServiceCatalogException
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.
terminateProvisionedProductRequest
- ResourceNotFoundException
- The specified resource was not found.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateConstraintResponse updateConstraint(UpdateConstraintRequest updateConstraintRequest) throws ResourceNotFoundException, InvalidParametersException, SdkBaseException, SdkClientException, ServiceCatalogException
Updates an existing constraint.
updateConstraintRequest
- ResourceNotFoundException
- The specified resource was not found.InvalidParametersException
- One or more parameters provided to the operation are invalid.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdatePortfolioResponse updatePortfolio(UpdatePortfolioRequest updatePortfolioRequest) throws InvalidParametersException, ResourceNotFoundException, LimitExceededException, SdkBaseException, SdkClientException, ServiceCatalogException
Updates the specified portfolio's details. This operation does not work with a product that has been shared with you.
updatePortfolioRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateProductResponse updateProduct(UpdateProductRequest updateProductRequest) throws ResourceNotFoundException, InvalidParametersException, SdkBaseException, SdkClientException, ServiceCatalogException
Updates an existing product.
updateProductRequest
- ResourceNotFoundException
- The specified resource was not found.InvalidParametersException
- One or more parameters provided to the operation are invalid.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateProvisionedProductResponse updateProvisionedProduct(UpdateProvisionedProductRequest updateProvisionedProductRequest) throws InvalidParametersException, ResourceNotFoundException, SdkBaseException, SdkClientException, ServiceCatalogException
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.
updateProvisionedProductRequest
- InvalidParametersException
- One or more parameters provided to the operation are invalid.ResourceNotFoundException
- The specified resource was not found.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateProvisioningArtifactResponse updateProvisioningArtifact(UpdateProvisioningArtifactRequest updateProvisioningArtifactRequest) throws ResourceNotFoundException, InvalidParametersException, SdkBaseException, SdkClientException, ServiceCatalogException
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.
updateProvisioningArtifactRequest
- ResourceNotFoundException
- The specified resource was not found.InvalidParametersException
- One or more parameters provided to the operation are invalid.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ServiceCatalogException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typestatic ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.