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