@Generated(value="software.amazon.awssdk:codegen") public interface ServiceCatalogClient extends SdkClient, SdkAutoCloseable
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 and Description |
|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default AcceptPortfolioShareResponse |
acceptPortfolioShare(AcceptPortfolioShareRequest acceptPortfolioShareRequest)
Accepts an offer to share a portfolio.
|
default AcceptPortfolioShareResponse |
acceptPortfolioShare(Consumer<AcceptPortfolioShareRequest.Builder> acceptPortfolioShareRequest)
Accepts an offer to share a portfolio.
|
default AssociatePrincipalWithPortfolioResponse |
associatePrincipalWithPortfolio(AssociatePrincipalWithPortfolioRequest associatePrincipalWithPortfolioRequest)
Associates the specified principal ARN with the specified portfolio.
|
default AssociatePrincipalWithPortfolioResponse |
associatePrincipalWithPortfolio(Consumer<AssociatePrincipalWithPortfolioRequest.Builder> associatePrincipalWithPortfolioRequest)
Associates the specified principal ARN with the specified portfolio.
|
default AssociateProductWithPortfolioResponse |
associateProductWithPortfolio(AssociateProductWithPortfolioRequest associateProductWithPortfolioRequest)
Associates a product with a portfolio.
|
default AssociateProductWithPortfolioResponse |
associateProductWithPortfolio(Consumer<AssociateProductWithPortfolioRequest.Builder> associateProductWithPortfolioRequest)
Associates a product with a portfolio.
|
default AssociateTagOptionWithResourceResponse |
associateTagOptionWithResource(AssociateTagOptionWithResourceRequest associateTagOptionWithResourceRequest)
Associate a TagOption identifier with a resource identifier.
|
default AssociateTagOptionWithResourceResponse |
associateTagOptionWithResource(Consumer<AssociateTagOptionWithResourceRequest.Builder> associateTagOptionWithResourceRequest)
Associate a TagOption identifier with a resource identifier.
|
static ServiceCatalogClientBuilder |
builder()
Create a builder that can be used to configure and create a
ServiceCatalogClient. |
default CopyProductResponse |
copyProduct(Consumer<CopyProductRequest.Builder> copyProductRequest)
Copies the specified source product to the specified target product or a new product.
|
default CopyProductResponse |
copyProduct(CopyProductRequest copyProductRequest)
Copies the specified source product to the specified target product or a new product.
|
static ServiceCatalogClient |
create()
Create a
ServiceCatalogClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateConstraintResponse |
createConstraint(Consumer<CreateConstraintRequest.Builder> createConstraintRequest)
Creates a new constraint.
|
default CreateConstraintResponse |
createConstraint(CreateConstraintRequest createConstraintRequest)
Creates a new constraint.
|
default CreatePortfolioResponse |
createPortfolio(Consumer<CreatePortfolioRequest.Builder> createPortfolioRequest)
Creates a new portfolio.
|
default CreatePortfolioResponse |
createPortfolio(CreatePortfolioRequest createPortfolioRequest)
Creates a new portfolio.
|
default CreatePortfolioShareResponse |
createPortfolioShare(Consumer<CreatePortfolioShareRequest.Builder> createPortfolioShareRequest)
Creates a new portfolio share.
|
default CreatePortfolioShareResponse |
createPortfolioShare(CreatePortfolioShareRequest createPortfolioShareRequest)
Creates a new portfolio share.
|
default CreateProductResponse |
createProduct(Consumer<CreateProductRequest.Builder> createProductRequest)
Creates a new product.
|
default CreateProductResponse |
createProduct(CreateProductRequest createProductRequest)
Creates a new product.
|
default CreateProvisioningArtifactResponse |
createProvisioningArtifact(Consumer<CreateProvisioningArtifactRequest.Builder> createProvisioningArtifactRequest)
Create a new provisioning artifact for the specified product.
|
default CreateProvisioningArtifactResponse |
createProvisioningArtifact(CreateProvisioningArtifactRequest createProvisioningArtifactRequest)
Create a new provisioning artifact for the specified product.
|
default CreateTagOptionResponse |
createTagOption(Consumer<CreateTagOptionRequest.Builder> createTagOptionRequest)
Create a new TagOption.
|
default CreateTagOptionResponse |
createTagOption(CreateTagOptionRequest createTagOptionRequest)
Create a new TagOption.
|
default DeleteConstraintResponse |
deleteConstraint(Consumer<DeleteConstraintRequest.Builder> deleteConstraintRequest)
Deletes the specified constraint.
|
default DeleteConstraintResponse |
deleteConstraint(DeleteConstraintRequest deleteConstraintRequest)
Deletes the specified constraint.
|
default DeletePortfolioResponse |
deletePortfolio(Consumer<DeletePortfolioRequest.Builder> deletePortfolioRequest)
Deletes the specified portfolio.
|
default DeletePortfolioResponse |
deletePortfolio(DeletePortfolioRequest deletePortfolioRequest)
Deletes the specified portfolio.
|
default DeletePortfolioShareResponse |
deletePortfolioShare(Consumer<DeletePortfolioShareRequest.Builder> deletePortfolioShareRequest)
Deletes the specified portfolio share.
|
default DeletePortfolioShareResponse |
deletePortfolioShare(DeletePortfolioShareRequest deletePortfolioShareRequest)
Deletes the specified portfolio share.
|
default DeleteProductResponse |
deleteProduct(Consumer<DeleteProductRequest.Builder> deleteProductRequest)
Deletes the specified product.
|
default DeleteProductResponse |
deleteProduct(DeleteProductRequest deleteProductRequest)
Deletes the specified product.
|
default DeleteProvisioningArtifactResponse |
deleteProvisioningArtifact(Consumer<DeleteProvisioningArtifactRequest.Builder> deleteProvisioningArtifactRequest)
Deletes the specified provisioning artifact.
|
default DeleteProvisioningArtifactResponse |
deleteProvisioningArtifact(DeleteProvisioningArtifactRequest deleteProvisioningArtifactRequest)
Deletes the specified provisioning artifact.
|
default DescribeConstraintResponse |
describeConstraint(Consumer<DescribeConstraintRequest.Builder> describeConstraintRequest)
Retrieves detailed information for a specified constraint.
|
default DescribeConstraintResponse |
describeConstraint(DescribeConstraintRequest describeConstraintRequest)
Retrieves detailed information for a specified constraint.
|
default DescribeCopyProductStatusResponse |
describeCopyProductStatus(Consumer<DescribeCopyProductStatusRequest.Builder> describeCopyProductStatusRequest)
Describes the status of the specified copy product operation.
|
default DescribeCopyProductStatusResponse |
describeCopyProductStatus(DescribeCopyProductStatusRequest describeCopyProductStatusRequest)
Describes the status of the specified copy product operation.
|
default DescribePortfolioResponse |
describePortfolio(Consumer<DescribePortfolioRequest.Builder> describePortfolioRequest)
Retrieves detailed information and any tags associated with the specified portfolio.
|
default DescribePortfolioResponse |
describePortfolio(DescribePortfolioRequest describePortfolioRequest)
Retrieves detailed information and any tags associated with the specified portfolio.
|
default DescribeProductResponse |
describeProduct(Consumer<DescribeProductRequest.Builder> describeProductRequest)
Retrieves information about a specified product.
|
default DescribeProductResponse |
describeProduct(DescribeProductRequest describeProductRequest)
Retrieves information about a specified product.
|
default DescribeProductAsAdminResponse |
describeProductAsAdmin(Consumer<DescribeProductAsAdminRequest.Builder> describeProductAsAdminRequest)
Retrieves information about a specified product, run with administrator access.
|
default DescribeProductAsAdminResponse |
describeProductAsAdmin(DescribeProductAsAdminRequest describeProductAsAdminRequest)
Retrieves information about a specified product, run with administrator access.
|
default DescribeProductViewResponse |
describeProductView(Consumer<DescribeProductViewRequest.Builder> describeProductViewRequest)
Retrieves information about a specified product.
|
default DescribeProductViewResponse |
describeProductView(DescribeProductViewRequest describeProductViewRequest)
Retrieves information about a specified product.
|
default DescribeProvisionedProductResponse |
describeProvisionedProduct(Consumer<DescribeProvisionedProductRequest.Builder> describeProvisionedProductRequest)
Retrieve detailed information about the provisioned product.
|
default DescribeProvisionedProductResponse |
describeProvisionedProduct(DescribeProvisionedProductRequest describeProvisionedProductRequest)
Retrieve detailed information about the provisioned product.
|
default DescribeProvisioningArtifactResponse |
describeProvisioningArtifact(Consumer<DescribeProvisioningArtifactRequest.Builder> describeProvisioningArtifactRequest)
Retrieves detailed information about the specified provisioning artifact.
|
default DescribeProvisioningArtifactResponse |
describeProvisioningArtifact(DescribeProvisioningArtifactRequest describeProvisioningArtifactRequest)
Retrieves detailed information about the specified provisioning artifact.
|
default DescribeProvisioningParametersResponse |
describeProvisioningParameters(Consumer<DescribeProvisioningParametersRequest.Builder> describeProvisioningParametersRequest)
Provides information about parameters required to provision a specified product in a specified manner.
|
default DescribeProvisioningParametersResponse |
describeProvisioningParameters(DescribeProvisioningParametersRequest describeProvisioningParametersRequest)
Provides information about parameters required to provision a specified product in a specified manner.
|
default DescribeRecordResponse |
describeRecord(Consumer<DescribeRecordRequest.Builder> describeRecordRequest)
Retrieves a paginated list of the full details of a specific request.
|
default DescribeRecordResponse |
describeRecord(DescribeRecordRequest describeRecordRequest)
Retrieves a paginated list of the full details of a specific request.
|
default DescribeTagOptionResponse |
describeTagOption(Consumer<DescribeTagOptionRequest.Builder> describeTagOptionRequest)
Describes a TagOption.
|
default DescribeTagOptionResponse |
describeTagOption(DescribeTagOptionRequest describeTagOptionRequest)
Describes a TagOption.
|
default DisassociatePrincipalFromPortfolioResponse |
disassociatePrincipalFromPortfolio(Consumer<DisassociatePrincipalFromPortfolioRequest.Builder> disassociatePrincipalFromPortfolioRequest)
Disassociates a previously associated principal ARN from a specified portfolio.
|
default DisassociatePrincipalFromPortfolioResponse |
disassociatePrincipalFromPortfolio(DisassociatePrincipalFromPortfolioRequest disassociatePrincipalFromPortfolioRequest)
Disassociates a previously associated principal ARN from a specified portfolio.
|
default DisassociateProductFromPortfolioResponse |
disassociateProductFromPortfolio(Consumer<DisassociateProductFromPortfolioRequest.Builder> disassociateProductFromPortfolioRequest)
Disassociates the specified product from the specified portfolio.
|
default DisassociateProductFromPortfolioResponse |
disassociateProductFromPortfolio(DisassociateProductFromPortfolioRequest disassociateProductFromPortfolioRequest)
Disassociates the specified product from the specified portfolio.
|
default DisassociateTagOptionFromResourceResponse |
disassociateTagOptionFromResource(Consumer<DisassociateTagOptionFromResourceRequest.Builder> disassociateTagOptionFromResourceRequest)
Disassociates a TagOption from a resource.
|
default DisassociateTagOptionFromResourceResponse |
disassociateTagOptionFromResource(DisassociateTagOptionFromResourceRequest disassociateTagOptionFromResourceRequest)
Disassociates a TagOption from a resource.
|
default ListAcceptedPortfolioSharesResponse |
listAcceptedPortfolioShares()
Lists details of all portfolios for which sharing was accepted by this account.
|
default ListAcceptedPortfolioSharesResponse |
listAcceptedPortfolioShares(Consumer<ListAcceptedPortfolioSharesRequest.Builder> listAcceptedPortfolioSharesRequest)
Lists details of all portfolios for which sharing was accepted by this account.
|
default ListAcceptedPortfolioSharesResponse |
listAcceptedPortfolioShares(ListAcceptedPortfolioSharesRequest listAcceptedPortfolioSharesRequest)
Lists details of all portfolios for which sharing was accepted by this account.
|
default ListAcceptedPortfolioSharesIterable |
listAcceptedPortfolioSharesPaginator()
Lists details of all portfolios for which sharing was accepted by this account.
|
default ListAcceptedPortfolioSharesIterable |
listAcceptedPortfolioSharesPaginator(ListAcceptedPortfolioSharesRequest listAcceptedPortfolioSharesRequest)
Lists details of all portfolios for which sharing was accepted by this account.
|
default ListConstraintsForPortfolioResponse |
listConstraintsForPortfolio(Consumer<ListConstraintsForPortfolioRequest.Builder> listConstraintsForPortfolioRequest)
Retrieves detailed constraint information for the specified portfolio and product.
|
default ListConstraintsForPortfolioResponse |
listConstraintsForPortfolio(ListConstraintsForPortfolioRequest listConstraintsForPortfolioRequest)
Retrieves detailed constraint information for the specified portfolio and product.
|
default ListConstraintsForPortfolioIterable |
listConstraintsForPortfolioPaginator(Consumer<ListConstraintsForPortfolioRequest.Builder> listConstraintsForPortfolioRequest)
Retrieves detailed constraint information for the specified portfolio and product.
|
default ListConstraintsForPortfolioIterable |
listConstraintsForPortfolioPaginator(ListConstraintsForPortfolioRequest listConstraintsForPortfolioRequest)
Retrieves detailed constraint information for the specified portfolio and product.
|
default ListLaunchPathsResponse |
listLaunchPaths(Consumer<ListLaunchPathsRequest.Builder> listLaunchPathsRequest)
Returns a paginated list of all paths to a specified product.
|
default ListLaunchPathsResponse |
listLaunchPaths(ListLaunchPathsRequest listLaunchPathsRequest)
Returns a paginated list of all paths to a specified product.
|
default ListLaunchPathsIterable |
listLaunchPathsPaginator(Consumer<ListLaunchPathsRequest.Builder> listLaunchPathsRequest)
Returns a paginated list of all paths to a specified product.
|
default ListLaunchPathsIterable |
listLaunchPathsPaginator(ListLaunchPathsRequest listLaunchPathsRequest)
Returns a paginated list of all paths to a specified product.
|
default ListPortfolioAccessResponse |
listPortfolioAccess(Consumer<ListPortfolioAccessRequest.Builder> listPortfolioAccessRequest)
Lists the account IDs that have been authorized sharing of the specified portfolio.
|
default ListPortfolioAccessResponse |
listPortfolioAccess(ListPortfolioAccessRequest listPortfolioAccessRequest)
Lists the account IDs that have been authorized sharing of the specified portfolio.
|
default ListPortfoliosResponse |
listPortfolios()
Lists all portfolios in the catalog.
|
default ListPortfoliosResponse |
listPortfolios(Consumer<ListPortfoliosRequest.Builder> listPortfoliosRequest)
Lists all portfolios in the catalog.
|
default ListPortfoliosResponse |
listPortfolios(ListPortfoliosRequest listPortfoliosRequest)
Lists all portfolios in the catalog.
|
default ListPortfoliosForProductResponse |
listPortfoliosForProduct(Consumer<ListPortfoliosForProductRequest.Builder> listPortfoliosForProductRequest)
Lists all portfolios that the specified product is associated with.
|
default ListPortfoliosForProductResponse |
listPortfoliosForProduct(ListPortfoliosForProductRequest listPortfoliosForProductRequest)
Lists all portfolios that the specified product is associated with.
|
default ListPortfoliosForProductIterable |
listPortfoliosForProductPaginator(Consumer<ListPortfoliosForProductRequest.Builder> listPortfoliosForProductRequest)
Lists all portfolios that the specified product is associated with.
|
default ListPortfoliosForProductIterable |
listPortfoliosForProductPaginator(ListPortfoliosForProductRequest listPortfoliosForProductRequest)
Lists all portfolios that the specified product is associated with.
|
default ListPortfoliosIterable |
listPortfoliosPaginator()
Lists all portfolios in the catalog.
|
default ListPortfoliosIterable |
listPortfoliosPaginator(ListPortfoliosRequest listPortfoliosRequest)
Lists all portfolios in the catalog.
|
default ListPrincipalsForPortfolioResponse |
listPrincipalsForPortfolio(Consumer<ListPrincipalsForPortfolioRequest.Builder> listPrincipalsForPortfolioRequest)
Lists all principal ARNs associated with the specified portfolio.
|
default ListPrincipalsForPortfolioResponse |
listPrincipalsForPortfolio(ListPrincipalsForPortfolioRequest listPrincipalsForPortfolioRequest)
Lists all principal ARNs associated with the specified portfolio.
|
default ListPrincipalsForPortfolioIterable |
listPrincipalsForPortfolioPaginator(Consumer<ListPrincipalsForPortfolioRequest.Builder> listPrincipalsForPortfolioRequest)
Lists all principal ARNs associated with the specified portfolio.
|
default ListPrincipalsForPortfolioIterable |
listPrincipalsForPortfolioPaginator(ListPrincipalsForPortfolioRequest listPrincipalsForPortfolioRequest)
Lists all principal ARNs associated with the specified portfolio.
|
default ListProvisioningArtifactsResponse |
listProvisioningArtifacts(Consumer<ListProvisioningArtifactsRequest.Builder> listProvisioningArtifactsRequest)
Lists all provisioning artifacts associated with the specified product.
|
default ListProvisioningArtifactsResponse |
listProvisioningArtifacts(ListProvisioningArtifactsRequest listProvisioningArtifactsRequest)
Lists all provisioning artifacts associated with the specified product.
|
default ListRecordHistoryResponse |
listRecordHistory()
Returns a paginated list of all performed requests, in the form of RecordDetails objects that are filtered as
specified.
|
default ListRecordHistoryResponse |
listRecordHistory(Consumer<ListRecordHistoryRequest.Builder> listRecordHistoryRequest)
Returns a paginated list of all performed requests, in the form of RecordDetails objects that are filtered as
specified.
|
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 ListResourcesForTagOptionResponse |
listResourcesForTagOption(Consumer<ListResourcesForTagOptionRequest.Builder> listResourcesForTagOptionRequest)
Lists resources associated with a TagOption.
|
default ListResourcesForTagOptionResponse |
listResourcesForTagOption(ListResourcesForTagOptionRequest listResourcesForTagOptionRequest)
Lists resources associated with a TagOption.
|
default ListTagOptionsResponse |
listTagOptions()
Lists detailed TagOptions information.
|
default ListTagOptionsResponse |
listTagOptions(Consumer<ListTagOptionsRequest.Builder> listTagOptionsRequest)
Lists detailed TagOptions information.
|
default ListTagOptionsResponse |
listTagOptions(ListTagOptionsRequest listTagOptionsRequest)
Lists detailed TagOptions information.
|
default ProvisionProductResponse |
provisionProduct(Consumer<ProvisionProductRequest.Builder> provisionProductRequest)
Requests a provision of a specified product.
|
default ProvisionProductResponse |
provisionProduct(ProvisionProductRequest provisionProductRequest)
Requests a provision of a specified product.
|
default RejectPortfolioShareResponse |
rejectPortfolioShare(Consumer<RejectPortfolioShareRequest.Builder> rejectPortfolioShareRequest)
Rejects an offer to share a portfolio.
|
default RejectPortfolioShareResponse |
rejectPortfolioShare(RejectPortfolioShareRequest rejectPortfolioShareRequest)
Rejects an offer to share a portfolio.
|
default ScanProvisionedProductsResponse |
scanProvisionedProducts()
Returns a paginated list of all the ProvisionedProduct objects that are currently available (not terminated).
|
default ScanProvisionedProductsResponse |
scanProvisionedProducts(Consumer<ScanProvisionedProductsRequest.Builder> scanProvisionedProductsRequest)
Returns a paginated list of all the ProvisionedProduct objects that are currently available (not terminated).
|
default ScanProvisionedProductsResponse |
scanProvisionedProducts(ScanProvisionedProductsRequest scanProvisionedProductsRequest)
Returns a paginated list of all the ProvisionedProduct objects that are currently available (not terminated).
|
default SearchProductsResponse |
searchProducts()
Returns a paginated list all of the
Products objects to which the caller has access. |
default SearchProductsResponse |
searchProducts(Consumer<SearchProductsRequest.Builder> searchProductsRequest)
Returns a paginated list all of the
Products objects to which the caller has access. |
default SearchProductsResponse |
searchProducts(SearchProductsRequest searchProductsRequest)
Returns a paginated list all of the
Products objects to which the caller has access. |
default SearchProductsAsAdminResponse |
searchProductsAsAdmin()
Retrieves summary and status information about all products created within the caller's account.
|
default SearchProductsAsAdminResponse |
searchProductsAsAdmin(Consumer<SearchProductsAsAdminRequest.Builder> searchProductsAsAdminRequest)
Retrieves summary and status information about all products created within the caller's account.
|
default SearchProductsAsAdminResponse |
searchProductsAsAdmin(SearchProductsAsAdminRequest searchProductsAsAdminRequest)
Retrieves summary and status information about all products created within the caller's account.
|
default SearchProductsAsAdminIterable |
searchProductsAsAdminPaginator()
Retrieves summary and status information about all products created within the caller's account.
|
default SearchProductsAsAdminIterable |
searchProductsAsAdminPaginator(SearchProductsAsAdminRequest searchProductsAsAdminRequest)
Retrieves summary and status information about all products created within the caller's account.
|
default SearchProductsIterable |
searchProductsPaginator()
Returns a paginated list all of the
Products objects to which the caller has access. |
default SearchProductsIterable |
searchProductsPaginator(SearchProductsRequest searchProductsRequest)
Returns a paginated list all of the
Products objects to which the caller has access. |
static ServiceMetadata |
serviceMetadata() |
default TerminateProvisionedProductResponse |
terminateProvisionedProduct(Consumer<TerminateProvisionedProductRequest.Builder> terminateProvisionedProductRequest)
Requests termination of an existing ProvisionedProduct object.
|
default TerminateProvisionedProductResponse |
terminateProvisionedProduct(TerminateProvisionedProductRequest terminateProvisionedProductRequest)
Requests termination of an existing ProvisionedProduct object.
|
default UpdateConstraintResponse |
updateConstraint(Consumer<UpdateConstraintRequest.Builder> updateConstraintRequest)
Updates an existing constraint.
|
default UpdateConstraintResponse |
updateConstraint(UpdateConstraintRequest updateConstraintRequest)
Updates an existing constraint.
|
default UpdatePortfolioResponse |
updatePortfolio(Consumer<UpdatePortfolioRequest.Builder> updatePortfolioRequest)
Updates the specified portfolio's details.
|
default UpdatePortfolioResponse |
updatePortfolio(UpdatePortfolioRequest updatePortfolioRequest)
Updates the specified portfolio's details.
|
default UpdateProductResponse |
updateProduct(Consumer<UpdateProductRequest.Builder> updateProductRequest)
Updates an existing product.
|
default UpdateProductResponse |
updateProduct(UpdateProductRequest updateProductRequest)
Updates an existing product.
|
default UpdateProvisionedProductResponse |
updateProvisionedProduct(Consumer<UpdateProvisionedProductRequest.Builder> updateProvisionedProductRequest)
Requests updates to the configuration of an existing ProvisionedProduct object.
|
default UpdateProvisionedProductResponse |
updateProvisionedProduct(UpdateProvisionedProductRequest updateProvisionedProductRequest)
Requests updates to the configuration of an existing ProvisionedProduct object.
|
default UpdateProvisioningArtifactResponse |
updateProvisioningArtifact(Consumer<UpdateProvisioningArtifactRequest.Builder> updateProvisioningArtifactRequest)
Updates an existing provisioning artifact's information.
|
default UpdateProvisioningArtifactResponse |
updateProvisioningArtifact(UpdateProvisioningArtifactRequest updateProvisioningArtifactRequest)
Updates an existing provisioning artifact's information.
|
default UpdateTagOptionResponse |
updateTagOption(Consumer<UpdateTagOptionRequest.Builder> updateTagOptionRequest)
Updates an existing TagOption.
|
default UpdateTagOptionResponse |
updateTagOption(UpdateTagOptionRequest updateTagOptionRequest)
Updates an existing TagOption.
|
serviceNameclosestatic 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, AwsServiceException, 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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AcceptPortfolioShareResponse acceptPortfolioShare(Consumer<AcceptPortfolioShareRequest.Builder> acceptPortfolioShareRequest) throws InvalidParametersException, ResourceNotFoundException, LimitExceededException, AwsServiceException, SdkClientException, ServiceCatalogException
Accepts an offer to share a portfolio.
This is a convenience which creates an instance of the AcceptPortfolioShareRequest.Builder avoiding the
need to create one manually via AcceptPortfolioShareRequest.builder()
acceptPortfolioShareRequest - A Consumer that will call methods on AcceptPortfolioShareInput.Builder to create a
request.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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AssociatePrincipalWithPortfolioResponse associatePrincipalWithPortfolio(AssociatePrincipalWithPortfolioRequest associatePrincipalWithPortfolioRequest) throws InvalidParametersException, ResourceNotFoundException, LimitExceededException, AwsServiceException, 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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AssociatePrincipalWithPortfolioResponse associatePrincipalWithPortfolio(Consumer<AssociatePrincipalWithPortfolioRequest.Builder> associatePrincipalWithPortfolioRequest) throws InvalidParametersException, ResourceNotFoundException, LimitExceededException, AwsServiceException, SdkClientException, ServiceCatalogException
Associates the specified principal ARN with the specified portfolio.
This is a convenience which creates an instance of the AssociatePrincipalWithPortfolioRequest.Builder
avoiding the need to create one manually via AssociatePrincipalWithPortfolioRequest.builder()
associatePrincipalWithPortfolioRequest - A Consumer that will call methods on AssociatePrincipalWithPortfolioInput.Builder to
create a request.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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AssociateProductWithPortfolioResponse associateProductWithPortfolio(AssociateProductWithPortfolioRequest associateProductWithPortfolioRequest) throws InvalidParametersException, ResourceNotFoundException, LimitExceededException, AwsServiceException, 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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AssociateProductWithPortfolioResponse associateProductWithPortfolio(Consumer<AssociateProductWithPortfolioRequest.Builder> associateProductWithPortfolioRequest) throws InvalidParametersException, ResourceNotFoundException, LimitExceededException, AwsServiceException, SdkClientException, ServiceCatalogException
Associates a product with a portfolio.
This is a convenience which creates an instance of the AssociateProductWithPortfolioRequest.Builder
avoiding the need to create one manually via AssociateProductWithPortfolioRequest.builder()
associateProductWithPortfolioRequest - A Consumer that will call methods on AssociateProductWithPortfolioInput.Builder to create
a request.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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AssociateTagOptionWithResourceResponse associateTagOptionWithResource(AssociateTagOptionWithResourceRequest associateTagOptionWithResourceRequest) throws TagOptionNotMigratedException, ResourceNotFoundException, InvalidParametersException, LimitExceededException, DuplicateResourceException, InvalidStateException, AwsServiceException, SdkClientException, ServiceCatalogException
Associate a TagOption identifier with a resource identifier.
associateTagOptionWithResourceRequest - 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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AssociateTagOptionWithResourceResponse associateTagOptionWithResource(Consumer<AssociateTagOptionWithResourceRequest.Builder> associateTagOptionWithResourceRequest) throws TagOptionNotMigratedException, ResourceNotFoundException, InvalidParametersException, LimitExceededException, DuplicateResourceException, InvalidStateException, AwsServiceException, SdkClientException, ServiceCatalogException
Associate a TagOption identifier with a resource identifier.
This is a convenience which creates an instance of the AssociateTagOptionWithResourceRequest.Builder
avoiding the need to create one manually via AssociateTagOptionWithResourceRequest.builder()
associateTagOptionWithResourceRequest - A Consumer that will call methods on AssociateTagOptionWithResourceInput.Builder to create
a request.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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CopyProductResponse copyProduct(CopyProductRequest copyProductRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
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.
copyProductRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are invalid.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CopyProductResponse copyProduct(Consumer<CopyProductRequest.Builder> copyProductRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
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.
This is a convenience which creates an instance of the CopyProductRequest.Builder avoiding the need to
create one manually via CopyProductRequest.builder()
copyProductRequest - A Consumer that will call methods on CopyProductInput.Builder to create a request.ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are invalid.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateConstraintResponse createConstraint(CreateConstraintRequest createConstraintRequest) throws ResourceNotFoundException, InvalidParametersException, LimitExceededException, DuplicateResourceException, AwsServiceException, 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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateConstraintResponse createConstraint(Consumer<CreateConstraintRequest.Builder> createConstraintRequest) throws ResourceNotFoundException, InvalidParametersException, LimitExceededException, DuplicateResourceException, AwsServiceException, SdkClientException, ServiceCatalogException
Creates a new constraint. For more information, see Using Constraints.
This is a convenience which creates an instance of the CreateConstraintRequest.Builder avoiding the need
to create one manually via CreateConstraintRequest.builder()
createConstraintRequest - A Consumer that will call methods on CreateConstraintInput.Builder to create a request.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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreatePortfolioResponse createPortfolio(CreatePortfolioRequest createPortfolioRequest) throws InvalidParametersException, LimitExceededException, TagOptionNotMigratedException, AwsServiceException, 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.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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreatePortfolioResponse createPortfolio(Consumer<CreatePortfolioRequest.Builder> createPortfolioRequest) throws InvalidParametersException, LimitExceededException, TagOptionNotMigratedException, AwsServiceException, SdkClientException, ServiceCatalogException
Creates a new portfolio.
This is a convenience which creates an instance of the CreatePortfolioRequest.Builder avoiding the need
to create one manually via CreatePortfolioRequest.builder()
createPortfolioRequest - A Consumer that will call methods on CreatePortfolioInput.Builder to create a request.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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreatePortfolioShareResponse createPortfolioShare(CreatePortfolioShareRequest createPortfolioShareRequest) throws ResourceNotFoundException, LimitExceededException, InvalidParametersException, AwsServiceException, 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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreatePortfolioShareResponse createPortfolioShare(Consumer<CreatePortfolioShareRequest.Builder> createPortfolioShareRequest) throws ResourceNotFoundException, LimitExceededException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Creates a new portfolio share.
This is a convenience which creates an instance of the CreatePortfolioShareRequest.Builder avoiding the
need to create one manually via CreatePortfolioShareRequest.builder()
createPortfolioShareRequest - A Consumer that will call methods on CreatePortfolioShareInput.Builder to create a
request.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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateProductResponse createProduct(CreateProductRequest createProductRequest) throws InvalidParametersException, LimitExceededException, TagOptionNotMigratedException, AwsServiceException, 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.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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateProductResponse createProduct(Consumer<CreateProductRequest.Builder> createProductRequest) throws InvalidParametersException, LimitExceededException, TagOptionNotMigratedException, AwsServiceException, SdkClientException, ServiceCatalogException
Creates a new product.
This is a convenience which creates an instance of the CreateProductRequest.Builder avoiding the need to
create one manually via CreateProductRequest.builder()
createProductRequest - A Consumer that will call methods on CreateProductInput.Builder to create a request.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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateProvisioningArtifactResponse createProvisioningArtifact(CreateProvisioningArtifactRequest createProvisioningArtifactRequest) throws ResourceNotFoundException, InvalidParametersException, LimitExceededException, AwsServiceException, 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.
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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateProvisioningArtifactResponse createProvisioningArtifact(Consumer<CreateProvisioningArtifactRequest.Builder> createProvisioningArtifactRequest) throws ResourceNotFoundException, InvalidParametersException, LimitExceededException, AwsServiceException, 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.
This is a convenience which creates an instance of the CreateProvisioningArtifactRequest.Builder avoiding
the need to create one manually via CreateProvisioningArtifactRequest.builder()
createProvisioningArtifactRequest - A Consumer that will call methods on CreateProvisioningArtifactInput.Builder to create a
request.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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateTagOptionResponse createTagOption(CreateTagOptionRequest createTagOptionRequest) throws TagOptionNotMigratedException, DuplicateResourceException, LimitExceededException, AwsServiceException, SdkClientException, ServiceCatalogException
Create a new TagOption.
createTagOptionRequest - 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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateTagOptionResponse createTagOption(Consumer<CreateTagOptionRequest.Builder> createTagOptionRequest) throws TagOptionNotMigratedException, DuplicateResourceException, LimitExceededException, AwsServiceException, SdkClientException, ServiceCatalogException
Create a new TagOption.
This is a convenience which creates an instance of the CreateTagOptionRequest.Builder avoiding the need
to create one manually via CreateTagOptionRequest.builder()
createTagOptionRequest - A Consumer that will call methods on CreateTagOptionInput.Builder to create a request.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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteConstraintResponse deleteConstraint(DeleteConstraintRequest deleteConstraintRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, 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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteConstraintResponse deleteConstraint(Consumer<DeleteConstraintRequest.Builder> deleteConstraintRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Deletes the specified constraint.
This is a convenience which creates an instance of the DeleteConstraintRequest.Builder avoiding the need
to create one manually via DeleteConstraintRequest.builder()
deleteConstraintRequest - A Consumer that will call methods on DeleteConstraintInput.Builder to create a request.ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are invalid.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeletePortfolioResponse deletePortfolio(DeletePortfolioRequest deletePortfolioRequest) throws ResourceNotFoundException, InvalidParametersException, ResourceInUseException, TagOptionNotMigratedException, AwsServiceException, 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.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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeletePortfolioResponse deletePortfolio(Consumer<DeletePortfolioRequest.Builder> deletePortfolioRequest) throws ResourceNotFoundException, InvalidParametersException, ResourceInUseException, TagOptionNotMigratedException, AwsServiceException, 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.
This is a convenience which creates an instance of the DeletePortfolioRequest.Builder avoiding the need
to create one manually via DeletePortfolioRequest.builder()
deletePortfolioRequest - A Consumer that will call methods on DeletePortfolioInput.Builder to create a request.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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeletePortfolioShareResponse deletePortfolioShare(DeletePortfolioShareRequest deletePortfolioShareRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Deletes the specified portfolio share.
deletePortfolioShareRequest - ResourceNotFoundException - The specified resource was not found.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeletePortfolioShareResponse deletePortfolioShare(Consumer<DeletePortfolioShareRequest.Builder> deletePortfolioShareRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Deletes the specified portfolio share.
This is a convenience which creates an instance of the DeletePortfolioShareRequest.Builder avoiding the
need to create one manually via DeletePortfolioShareRequest.builder()
deletePortfolioShareRequest - A Consumer that will call methods on DeletePortfolioShareInput.Builder to create a
request.ResourceNotFoundException - The specified resource was not found.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteProductResponse deleteProduct(DeleteProductRequest deleteProductRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidParametersException, TagOptionNotMigratedException, AwsServiceException, 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.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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteProductResponse deleteProduct(Consumer<DeleteProductRequest.Builder> deleteProductRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidParametersException, TagOptionNotMigratedException, AwsServiceException, 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.
This is a convenience which creates an instance of the DeleteProductRequest.Builder avoiding the need to
create one manually via DeleteProductRequest.builder()
deleteProductRequest - A Consumer that will call methods on DeleteProductInput.Builder to create a request.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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteProvisioningArtifactResponse deleteProvisioningArtifact(DeleteProvisioningArtifactRequest deleteProvisioningArtifactRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidParametersException, AwsServiceException, 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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteProvisioningArtifactResponse deleteProvisioningArtifact(Consumer<DeleteProvisioningArtifactRequest.Builder> deleteProvisioningArtifactRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidParametersException, AwsServiceException, 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).
This is a convenience which creates an instance of the DeleteProvisioningArtifactRequest.Builder avoiding
the need to create one manually via DeleteProvisioningArtifactRequest.builder()
deleteProvisioningArtifactRequest - A Consumer that will call methods on DeleteProvisioningArtifactInput.Builder to create a
request.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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeConstraintResponse describeConstraint(DescribeConstraintRequest describeConstraintRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Retrieves detailed information for a specified constraint.
describeConstraintRequest - ResourceNotFoundException - The specified resource was not found.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeConstraintResponse describeConstraint(Consumer<DescribeConstraintRequest.Builder> describeConstraintRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Retrieves detailed information for a specified constraint.
This is a convenience which creates an instance of the DescribeConstraintRequest.Builder avoiding the
need to create one manually via DescribeConstraintRequest.builder()
describeConstraintRequest - A Consumer that will call methods on DescribeConstraintInput.Builder to create a request.ResourceNotFoundException - The specified resource was not found.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeCopyProductStatusResponse describeCopyProductStatus(DescribeCopyProductStatusRequest describeCopyProductStatusRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Describes the status of the specified copy product operation.
describeCopyProductStatusRequest - ResourceNotFoundException - The specified resource was not found.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeCopyProductStatusResponse describeCopyProductStatus(Consumer<DescribeCopyProductStatusRequest.Builder> describeCopyProductStatusRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Describes the status of the specified copy product operation.
This is a convenience which creates an instance of the DescribeCopyProductStatusRequest.Builder avoiding
the need to create one manually via DescribeCopyProductStatusRequest.builder()
describeCopyProductStatusRequest - A Consumer that will call methods on DescribeCopyProductStatusInput.Builder to create a
request.ResourceNotFoundException - The specified resource was not found.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribePortfolioResponse describePortfolio(DescribePortfolioRequest describePortfolioRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Retrieves detailed information and any tags associated with the specified portfolio.
describePortfolioRequest - ResourceNotFoundException - The specified resource was not found.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribePortfolioResponse describePortfolio(Consumer<DescribePortfolioRequest.Builder> describePortfolioRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Retrieves detailed information and any tags associated with the specified portfolio.
This is a convenience which creates an instance of the DescribePortfolioRequest.Builder avoiding the need
to create one manually via DescribePortfolioRequest.builder()
describePortfolioRequest - A Consumer that will call methods on DescribePortfolioInput.Builder to create a request.ResourceNotFoundException - The specified resource was not found.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeProductResponse describeProduct(DescribeProductRequest describeProductRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, 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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeProductResponse describeProduct(Consumer<DescribeProductRequest.Builder> describeProductRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, 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.
This is a convenience which creates an instance of the DescribeProductRequest.Builder avoiding the need
to create one manually via DescribeProductRequest.builder()
describeProductRequest - A Consumer that will call methods on DescribeProductInput.Builder to create a request.ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are invalid.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeProductAsAdminResponse describeProductAsAdmin(DescribeProductAsAdminRequest describeProductAsAdminRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Retrieves information about a specified product, run with administrator access.
describeProductAsAdminRequest - ResourceNotFoundException - The specified resource was not found.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeProductAsAdminResponse describeProductAsAdmin(Consumer<DescribeProductAsAdminRequest.Builder> describeProductAsAdminRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Retrieves information about a specified product, run with administrator access.
This is a convenience which creates an instance of the DescribeProductAsAdminRequest.Builder avoiding the
need to create one manually via DescribeProductAsAdminRequest.builder()
describeProductAsAdminRequest - A Consumer that will call methods on DescribeProductAsAdminInput.Builder to create a
request.ResourceNotFoundException - The specified resource was not found.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeProductViewResponse describeProductView(DescribeProductViewRequest describeProductViewRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, 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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeProductViewResponse describeProductView(Consumer<DescribeProductViewRequest.Builder> describeProductViewRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, 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.
This is a convenience which creates an instance of the DescribeProductViewRequest.Builder avoiding the
need to create one manually via DescribeProductViewRequest.builder()
describeProductViewRequest - A Consumer that will call methods on DescribeProductViewInput.Builder to create a request.ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are invalid.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeProvisionedProductResponse describeProvisionedProduct(DescribeProvisionedProductRequest describeProvisionedProductRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Retrieve detailed information about the provisioned product.
describeProvisionedProductRequest - ResourceNotFoundException - The specified resource was not found.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeProvisionedProductResponse describeProvisionedProduct(Consumer<DescribeProvisionedProductRequest.Builder> describeProvisionedProductRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Retrieve detailed information about the provisioned product.
This is a convenience which creates an instance of the DescribeProvisionedProductRequest.Builder avoiding
the need to create one manually via DescribeProvisionedProductRequest.builder()
describeProvisionedProductRequest - A Consumer that will call methods on DescribeProvisionedProductInput.Builder to create a
request.ResourceNotFoundException - The specified resource was not found.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeProvisioningArtifactResponse describeProvisioningArtifact(DescribeProvisioningArtifactRequest describeProvisioningArtifactRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Retrieves detailed information about the specified provisioning artifact.
describeProvisioningArtifactRequest - ResourceNotFoundException - The specified resource was not found.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeProvisioningArtifactResponse describeProvisioningArtifact(Consumer<DescribeProvisioningArtifactRequest.Builder> describeProvisioningArtifactRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Retrieves detailed information about the specified provisioning artifact.
This is a convenience which creates an instance of the DescribeProvisioningArtifactRequest.Builder
avoiding the need to create one manually via DescribeProvisioningArtifactRequest.builder()
describeProvisioningArtifactRequest - A Consumer that will call methods on DescribeProvisioningArtifactInput.Builder to create a
request.ResourceNotFoundException - The specified resource was not found.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeProvisioningParametersResponse describeProvisioningParameters(DescribeProvisioningParametersRequest describeProvisioningParametersRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, 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.
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".
describeProvisioningParametersRequest - InvalidParametersException - One or more parameters provided to the operation are invalid.ResourceNotFoundException - The specified resource was not found.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeProvisioningParametersResponse describeProvisioningParameters(Consumer<DescribeProvisioningParametersRequest.Builder> describeProvisioningParametersRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, 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.
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".
This is a convenience which creates an instance of the DescribeProvisioningParametersRequest.Builder
avoiding the need to create one manually via DescribeProvisioningParametersRequest.builder()
describeProvisioningParametersRequest - A Consumer that will call methods on DescribeProvisioningParametersInput.Builder to create
a request.InvalidParametersException - One or more parameters provided to the operation are invalid.ResourceNotFoundException - The specified resource was not found.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeRecordResponse describeRecord(DescribeRecordRequest describeRecordRequest) throws ResourceNotFoundException, AwsServiceException, 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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeRecordResponse describeRecord(Consumer<DescribeRecordRequest.Builder> describeRecordRequest) throws ResourceNotFoundException, AwsServiceException, 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).
This is a convenience which creates an instance of the DescribeRecordRequest.Builder avoiding the need to
create one manually via DescribeRecordRequest.builder()
describeRecordRequest - A Consumer that will call methods on DescribeRecordInput.Builder to create a request.ResourceNotFoundException - The specified resource was not found.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeTagOptionResponse describeTagOption(DescribeTagOptionRequest describeTagOptionRequest) throws TagOptionNotMigratedException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Describes a TagOption.
describeTagOptionRequest - 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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeTagOptionResponse describeTagOption(Consumer<DescribeTagOptionRequest.Builder> describeTagOptionRequest) throws TagOptionNotMigratedException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Describes a TagOption.
This is a convenience which creates an instance of the DescribeTagOptionRequest.Builder avoiding the need
to create one manually via DescribeTagOptionRequest.builder()
describeTagOptionRequest - A Consumer that will call methods on DescribeTagOptionInput.Builder to create a request.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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisassociatePrincipalFromPortfolioResponse disassociatePrincipalFromPortfolio(DisassociatePrincipalFromPortfolioRequest disassociatePrincipalFromPortfolioRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, 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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisassociatePrincipalFromPortfolioResponse disassociatePrincipalFromPortfolio(Consumer<DisassociatePrincipalFromPortfolioRequest.Builder> disassociatePrincipalFromPortfolioRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Disassociates a previously associated principal ARN from a specified portfolio.
This is a convenience which creates an instance of the DisassociatePrincipalFromPortfolioRequest.Builder
avoiding the need to create one manually via DisassociatePrincipalFromPortfolioRequest.builder()
disassociatePrincipalFromPortfolioRequest - A Consumer that will call methods on DisassociatePrincipalFromPortfolioInput.Builder to
create a request.InvalidParametersException - One or more parameters provided to the operation are invalid.ResourceNotFoundException - The specified resource was not found.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisassociateProductFromPortfolioResponse disassociateProductFromPortfolio(DisassociateProductFromPortfolioRequest disassociateProductFromPortfolioRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Disassociates the specified product from the specified portfolio.
disassociateProductFromPortfolioRequest - 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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisassociateProductFromPortfolioResponse disassociateProductFromPortfolio(Consumer<DisassociateProductFromPortfolioRequest.Builder> disassociateProductFromPortfolioRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Disassociates the specified product from the specified portfolio.
This is a convenience which creates an instance of the DisassociateProductFromPortfolioRequest.Builder
avoiding the need to create one manually via DisassociateProductFromPortfolioRequest.builder()
disassociateProductFromPortfolioRequest - A Consumer that will call methods on DisassociateProductFromPortfolioInput.Builder to
create a request.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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisassociateTagOptionFromResourceResponse disassociateTagOptionFromResource(DisassociateTagOptionFromResourceRequest disassociateTagOptionFromResourceRequest) throws TagOptionNotMigratedException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Disassociates a TagOption from a resource.
disassociateTagOptionFromResourceRequest - 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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisassociateTagOptionFromResourceResponse disassociateTagOptionFromResource(Consumer<DisassociateTagOptionFromResourceRequest.Builder> disassociateTagOptionFromResourceRequest) throws TagOptionNotMigratedException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Disassociates a TagOption from a resource.
This is a convenience which creates an instance of the DisassociateTagOptionFromResourceRequest.Builder
avoiding the need to create one manually via DisassociateTagOptionFromResourceRequest.builder()
disassociateTagOptionFromResourceRequest - A Consumer that will call methods on DisassociateTagOptionFromResourceInput.Builder to
create a request.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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAcceptedPortfolioSharesResponse listAcceptedPortfolioShares() throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists details of all portfolios for which sharing was accepted by this account.
InvalidParametersException - One or more parameters provided to the operation are invalid.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistAcceptedPortfolioShares(ListAcceptedPortfolioSharesRequest),
AWS API Documentationdefault ListAcceptedPortfolioSharesResponse listAcceptedPortfolioShares(ListAcceptedPortfolioSharesRequest listAcceptedPortfolioSharesRequest) throws InvalidParametersException, AwsServiceException, 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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAcceptedPortfolioSharesResponse listAcceptedPortfolioShares(Consumer<ListAcceptedPortfolioSharesRequest.Builder> listAcceptedPortfolioSharesRequest) throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists details of all portfolios for which sharing was accepted by this account.
This is a convenience which creates an instance of the ListAcceptedPortfolioSharesRequest.Builder
avoiding the need to create one manually via ListAcceptedPortfolioSharesRequest.builder()
listAcceptedPortfolioSharesRequest - A Consumer that will call methods on ListAcceptedPortfolioSharesInput.Builder to create a
request.InvalidParametersException - One or more parameters provided to the operation are invalid.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAcceptedPortfolioSharesIterable listAcceptedPortfolioSharesPaginator(ListAcceptedPortfolioSharesRequest listAcceptedPortfolioSharesRequest) throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists details of all portfolios for which sharing was accepted by this account.
This is a variant of
listAcceptedPortfolioShares(software.amazon.awssdk.services.servicecatalog.model.ListAcceptedPortfolioSharesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.servicecatalog.paginators.ListAcceptedPortfolioSharesIterable responses = client.listAcceptedPortfolioSharesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.servicecatalog.paginators.ListAcceptedPortfolioSharesIterable responses = client
.listAcceptedPortfolioSharesPaginator(request);
for (software.amazon.awssdk.services.servicecatalog.model.ListAcceptedPortfolioSharesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.servicecatalog.paginators.ListAcceptedPortfolioSharesIterable responses = client.listAcceptedPortfolioSharesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listAcceptedPortfolioShares(software.amazon.awssdk.services.servicecatalog.model.ListAcceptedPortfolioSharesRequest)
operation.
listAcceptedPortfolioSharesRequest - InvalidParametersException - One or more parameters provided to the operation are invalid.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAcceptedPortfolioSharesIterable listAcceptedPortfolioSharesPaginator() throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists details of all portfolios for which sharing was accepted by this account.
This is a variant of
listAcceptedPortfolioShares(software.amazon.awssdk.services.servicecatalog.model.ListAcceptedPortfolioSharesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.servicecatalog.paginators.ListAcceptedPortfolioSharesIterable responses = client.listAcceptedPortfolioSharesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.servicecatalog.paginators.ListAcceptedPortfolioSharesIterable responses = client
.listAcceptedPortfolioSharesPaginator(request);
for (software.amazon.awssdk.services.servicecatalog.model.ListAcceptedPortfolioSharesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.servicecatalog.paginators.ListAcceptedPortfolioSharesIterable responses = client.listAcceptedPortfolioSharesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listAcceptedPortfolioShares(software.amazon.awssdk.services.servicecatalog.model.ListAcceptedPortfolioSharesRequest)
operation.
InvalidParametersException - One or more parameters provided to the operation are invalid.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistAcceptedPortfolioSharesPaginator(ListAcceptedPortfolioSharesRequest),
AWS API Documentationdefault ListConstraintsForPortfolioResponse listConstraintsForPortfolio(ListConstraintsForPortfolioRequest listConstraintsForPortfolioRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, 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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListConstraintsForPortfolioResponse listConstraintsForPortfolio(Consumer<ListConstraintsForPortfolioRequest.Builder> listConstraintsForPortfolioRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Retrieves detailed constraint information for the specified portfolio and product.
This is a convenience which creates an instance of the ListConstraintsForPortfolioRequest.Builder
avoiding the need to create one manually via ListConstraintsForPortfolioRequest.builder()
listConstraintsForPortfolioRequest - A Consumer that will call methods on ListConstraintsForPortfolioInput.Builder to create a
request.ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are invalid.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListConstraintsForPortfolioIterable listConstraintsForPortfolioPaginator(ListConstraintsForPortfolioRequest listConstraintsForPortfolioRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Retrieves detailed constraint information for the specified portfolio and product.
This is a variant of
listConstraintsForPortfolio(software.amazon.awssdk.services.servicecatalog.model.ListConstraintsForPortfolioRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.servicecatalog.paginators.ListConstraintsForPortfolioIterable responses = client.listConstraintsForPortfolioPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.servicecatalog.paginators.ListConstraintsForPortfolioIterable responses = client
.listConstraintsForPortfolioPaginator(request);
for (software.amazon.awssdk.services.servicecatalog.model.ListConstraintsForPortfolioResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.servicecatalog.paginators.ListConstraintsForPortfolioIterable responses = client.listConstraintsForPortfolioPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listConstraintsForPortfolio(software.amazon.awssdk.services.servicecatalog.model.ListConstraintsForPortfolioRequest)
operation.
listConstraintsForPortfolioRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are invalid.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListConstraintsForPortfolioIterable listConstraintsForPortfolioPaginator(Consumer<ListConstraintsForPortfolioRequest.Builder> listConstraintsForPortfolioRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Retrieves detailed constraint information for the specified portfolio and product.
This is a variant of
listConstraintsForPortfolio(software.amazon.awssdk.services.servicecatalog.model.ListConstraintsForPortfolioRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.servicecatalog.paginators.ListConstraintsForPortfolioIterable responses = client.listConstraintsForPortfolioPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.servicecatalog.paginators.ListConstraintsForPortfolioIterable responses = client
.listConstraintsForPortfolioPaginator(request);
for (software.amazon.awssdk.services.servicecatalog.model.ListConstraintsForPortfolioResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.servicecatalog.paginators.ListConstraintsForPortfolioIterable responses = client.listConstraintsForPortfolioPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listConstraintsForPortfolio(software.amazon.awssdk.services.servicecatalog.model.ListConstraintsForPortfolioRequest)
operation.
This is a convenience which creates an instance of the ListConstraintsForPortfolioRequest.Builder
avoiding the need to create one manually via ListConstraintsForPortfolioRequest.builder()
listConstraintsForPortfolioRequest - A Consumer that will call methods on ListConstraintsForPortfolioInput.Builder to create a
request.ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are invalid.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListLaunchPathsResponse listLaunchPaths(ListLaunchPathsRequest listLaunchPathsRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, 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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListLaunchPathsResponse listLaunchPaths(Consumer<ListLaunchPathsRequest.Builder> listLaunchPathsRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, 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.
This is a convenience which creates an instance of the ListLaunchPathsRequest.Builder avoiding the need
to create one manually via ListLaunchPathsRequest.builder()
listLaunchPathsRequest - A Consumer that will call methods on ListLaunchPathsInput.Builder to create a request.InvalidParametersException - One or more parameters provided to the operation are invalid.ResourceNotFoundException - The specified resource was not found.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListLaunchPathsIterable listLaunchPathsPaginator(ListLaunchPathsRequest listLaunchPathsRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, 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.
This is a variant of
listLaunchPaths(software.amazon.awssdk.services.servicecatalog.model.ListLaunchPathsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.servicecatalog.paginators.ListLaunchPathsIterable responses = client.listLaunchPathsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.servicecatalog.paginators.ListLaunchPathsIterable responses = client
.listLaunchPathsPaginator(request);
for (software.amazon.awssdk.services.servicecatalog.model.ListLaunchPathsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.servicecatalog.paginators.ListLaunchPathsIterable responses = client.listLaunchPathsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listLaunchPaths(software.amazon.awssdk.services.servicecatalog.model.ListLaunchPathsRequest)
operation.
listLaunchPathsRequest - InvalidParametersException - One or more parameters provided to the operation are invalid.ResourceNotFoundException - The specified resource was not found.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListLaunchPathsIterable listLaunchPathsPaginator(Consumer<ListLaunchPathsRequest.Builder> listLaunchPathsRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, 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.
This is a variant of
listLaunchPaths(software.amazon.awssdk.services.servicecatalog.model.ListLaunchPathsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.servicecatalog.paginators.ListLaunchPathsIterable responses = client.listLaunchPathsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.servicecatalog.paginators.ListLaunchPathsIterable responses = client
.listLaunchPathsPaginator(request);
for (software.amazon.awssdk.services.servicecatalog.model.ListLaunchPathsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.servicecatalog.paginators.ListLaunchPathsIterable responses = client.listLaunchPathsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listLaunchPaths(software.amazon.awssdk.services.servicecatalog.model.ListLaunchPathsRequest)
operation.
This is a convenience which creates an instance of the ListLaunchPathsRequest.Builder avoiding the need
to create one manually via ListLaunchPathsRequest.builder()
listLaunchPathsRequest - A Consumer that will call methods on ListLaunchPathsInput.Builder to create a request.InvalidParametersException - One or more parameters provided to the operation are invalid.ResourceNotFoundException - The specified resource was not found.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPortfolioAccessResponse listPortfolioAccess(ListPortfolioAccessRequest listPortfolioAccessRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists the account IDs that have been authorized sharing of the specified portfolio.
listPortfolioAccessRequest - ResourceNotFoundException - The specified resource was not found.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPortfolioAccessResponse listPortfolioAccess(Consumer<ListPortfolioAccessRequest.Builder> listPortfolioAccessRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists the account IDs that have been authorized sharing of the specified portfolio.
This is a convenience which creates an instance of the ListPortfolioAccessRequest.Builder avoiding the
need to create one manually via ListPortfolioAccessRequest.builder()
listPortfolioAccessRequest - A Consumer that will call methods on ListPortfolioAccessInput.Builder to create a request.ResourceNotFoundException - The specified resource was not found.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPortfoliosResponse listPortfolios() throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists all portfolios in the catalog.
InvalidParametersException - One or more parameters provided to the operation are invalid.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistPortfolios(ListPortfoliosRequest),
AWS
API Documentationdefault ListPortfoliosResponse listPortfolios(ListPortfoliosRequest listPortfoliosRequest) throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists all portfolios in the catalog.
listPortfoliosRequest - InvalidParametersException - One or more parameters provided to the operation are invalid.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPortfoliosResponse listPortfolios(Consumer<ListPortfoliosRequest.Builder> listPortfoliosRequest) throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists all portfolios in the catalog.
This is a convenience which creates an instance of the ListPortfoliosRequest.Builder avoiding the need to
create one manually via ListPortfoliosRequest.builder()
listPortfoliosRequest - A Consumer that will call methods on ListPortfoliosInput.Builder to create a request.InvalidParametersException - One or more parameters provided to the operation are invalid.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPortfoliosIterable listPortfoliosPaginator(ListPortfoliosRequest listPortfoliosRequest) throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists all portfolios in the catalog.
This is a variant of
listPortfolios(software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.servicecatalog.paginators.ListPortfoliosIterable responses = client.listPortfoliosPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.servicecatalog.paginators.ListPortfoliosIterable responses = client
.listPortfoliosPaginator(request);
for (software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.servicecatalog.paginators.ListPortfoliosIterable responses = client.listPortfoliosPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listPortfolios(software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosRequest)
operation.
listPortfoliosRequest - InvalidParametersException - One or more parameters provided to the operation are invalid.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPortfoliosIterable listPortfoliosPaginator() throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists all portfolios in the catalog.
This is a variant of
listPortfolios(software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.servicecatalog.paginators.ListPortfoliosIterable responses = client.listPortfoliosPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.servicecatalog.paginators.ListPortfoliosIterable responses = client
.listPortfoliosPaginator(request);
for (software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.servicecatalog.paginators.ListPortfoliosIterable responses = client.listPortfoliosPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listPortfolios(software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosRequest)
operation.
InvalidParametersException - One or more parameters provided to the operation are invalid.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistPortfoliosPaginator(ListPortfoliosRequest),
AWS
API Documentationdefault ListPortfoliosForProductResponse listPortfoliosForProduct(ListPortfoliosForProductRequest listPortfoliosForProductRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, 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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPortfoliosForProductResponse listPortfoliosForProduct(Consumer<ListPortfoliosForProductRequest.Builder> listPortfoliosForProductRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists all portfolios that the specified product is associated with.
This is a convenience which creates an instance of the ListPortfoliosForProductRequest.Builder avoiding
the need to create one manually via ListPortfoliosForProductRequest.builder()
listPortfoliosForProductRequest - A Consumer that will call methods on ListPortfoliosForProductInput.Builder to create a
request.InvalidParametersException - One or more parameters provided to the operation are invalid.ResourceNotFoundException - The specified resource was not found.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPortfoliosForProductIterable listPortfoliosForProductPaginator(ListPortfoliosForProductRequest listPortfoliosForProductRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists all portfolios that the specified product is associated with.
This is a variant of
listPortfoliosForProduct(software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosForProductRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.servicecatalog.paginators.ListPortfoliosForProductIterable responses = client.listPortfoliosForProductPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.servicecatalog.paginators.ListPortfoliosForProductIterable responses = client
.listPortfoliosForProductPaginator(request);
for (software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosForProductResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.servicecatalog.paginators.ListPortfoliosForProductIterable responses = client.listPortfoliosForProductPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listPortfoliosForProduct(software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosForProductRequest)
operation.
listPortfoliosForProductRequest - InvalidParametersException - One or more parameters provided to the operation are invalid.ResourceNotFoundException - The specified resource was not found.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPortfoliosForProductIterable listPortfoliosForProductPaginator(Consumer<ListPortfoliosForProductRequest.Builder> listPortfoliosForProductRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists all portfolios that the specified product is associated with.
This is a variant of
listPortfoliosForProduct(software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosForProductRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.servicecatalog.paginators.ListPortfoliosForProductIterable responses = client.listPortfoliosForProductPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.servicecatalog.paginators.ListPortfoliosForProductIterable responses = client
.listPortfoliosForProductPaginator(request);
for (software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosForProductResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.servicecatalog.paginators.ListPortfoliosForProductIterable responses = client.listPortfoliosForProductPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listPortfoliosForProduct(software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosForProductRequest)
operation.
This is a convenience which creates an instance of the ListPortfoliosForProductRequest.Builder avoiding
the need to create one manually via ListPortfoliosForProductRequest.builder()
listPortfoliosForProductRequest - A Consumer that will call methods on ListPortfoliosForProductInput.Builder to create a
request.InvalidParametersException - One or more parameters provided to the operation are invalid.ResourceNotFoundException - The specified resource was not found.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPrincipalsForPortfolioResponse listPrincipalsForPortfolio(ListPrincipalsForPortfolioRequest listPrincipalsForPortfolioRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, 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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPrincipalsForPortfolioResponse listPrincipalsForPortfolio(Consumer<ListPrincipalsForPortfolioRequest.Builder> listPrincipalsForPortfolioRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists all principal ARNs associated with the specified portfolio.
This is a convenience which creates an instance of the ListPrincipalsForPortfolioRequest.Builder avoiding
the need to create one manually via ListPrincipalsForPortfolioRequest.builder()
listPrincipalsForPortfolioRequest - A Consumer that will call methods on ListPrincipalsForPortfolioInput.Builder to create a
request.ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are invalid.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPrincipalsForPortfolioIterable listPrincipalsForPortfolioPaginator(ListPrincipalsForPortfolioRequest listPrincipalsForPortfolioRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists all principal ARNs associated with the specified portfolio.
This is a variant of
listPrincipalsForPortfolio(software.amazon.awssdk.services.servicecatalog.model.ListPrincipalsForPortfolioRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.servicecatalog.paginators.ListPrincipalsForPortfolioIterable responses = client.listPrincipalsForPortfolioPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.servicecatalog.paginators.ListPrincipalsForPortfolioIterable responses = client
.listPrincipalsForPortfolioPaginator(request);
for (software.amazon.awssdk.services.servicecatalog.model.ListPrincipalsForPortfolioResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.servicecatalog.paginators.ListPrincipalsForPortfolioIterable responses = client.listPrincipalsForPortfolioPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listPrincipalsForPortfolio(software.amazon.awssdk.services.servicecatalog.model.ListPrincipalsForPortfolioRequest)
operation.
listPrincipalsForPortfolioRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are invalid.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPrincipalsForPortfolioIterable listPrincipalsForPortfolioPaginator(Consumer<ListPrincipalsForPortfolioRequest.Builder> listPrincipalsForPortfolioRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists all principal ARNs associated with the specified portfolio.
This is a variant of
listPrincipalsForPortfolio(software.amazon.awssdk.services.servicecatalog.model.ListPrincipalsForPortfolioRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.servicecatalog.paginators.ListPrincipalsForPortfolioIterable responses = client.listPrincipalsForPortfolioPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.servicecatalog.paginators.ListPrincipalsForPortfolioIterable responses = client
.listPrincipalsForPortfolioPaginator(request);
for (software.amazon.awssdk.services.servicecatalog.model.ListPrincipalsForPortfolioResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.servicecatalog.paginators.ListPrincipalsForPortfolioIterable responses = client.listPrincipalsForPortfolioPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listPrincipalsForPortfolio(software.amazon.awssdk.services.servicecatalog.model.ListPrincipalsForPortfolioRequest)
operation.
This is a convenience which creates an instance of the ListPrincipalsForPortfolioRequest.Builder avoiding
the need to create one manually via ListPrincipalsForPortfolioRequest.builder()
listPrincipalsForPortfolioRequest - A Consumer that will call methods on ListPrincipalsForPortfolioInput.Builder to create a
request.ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are invalid.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListProvisioningArtifactsResponse listProvisioningArtifacts(ListProvisioningArtifactsRequest listProvisioningArtifactsRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, 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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListProvisioningArtifactsResponse listProvisioningArtifacts(Consumer<ListProvisioningArtifactsRequest.Builder> listProvisioningArtifactsRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists all provisioning artifacts associated with the specified product.
This is a convenience which creates an instance of the ListProvisioningArtifactsRequest.Builder avoiding
the need to create one manually via ListProvisioningArtifactsRequest.builder()
listProvisioningArtifactsRequest - A Consumer that will call methods on ListProvisioningArtifactsInput.Builder to create a
request.ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are invalid.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRecordHistoryResponse listRecordHistory() throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Returns a paginated list of all performed requests, in the form of RecordDetails objects that are filtered as specified.
InvalidParametersException - One or more parameters provided to the operation are invalid.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistRecordHistory(ListRecordHistoryRequest),
AWS API Documentationdefault ListRecordHistoryResponse listRecordHistory(ListRecordHistoryRequest listRecordHistoryRequest) throws InvalidParametersException, AwsServiceException, 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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRecordHistoryResponse listRecordHistory(Consumer<ListRecordHistoryRequest.Builder> listRecordHistoryRequest) throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Returns a paginated list of all performed requests, in the form of RecordDetails objects that are filtered as specified.
This is a convenience which creates an instance of the ListRecordHistoryRequest.Builder avoiding the need
to create one manually via ListRecordHistoryRequest.builder()
listRecordHistoryRequest - A Consumer that will call methods on ListRecordHistoryInput.Builder to create a request.InvalidParametersException - One or more parameters provided to the operation are invalid.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListResourcesForTagOptionResponse listResourcesForTagOption(ListResourcesForTagOptionRequest listResourcesForTagOptionRequest) throws TagOptionNotMigratedException, ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists resources associated with a TagOption.
listResourcesForTagOptionRequest - 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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListResourcesForTagOptionResponse listResourcesForTagOption(Consumer<ListResourcesForTagOptionRequest.Builder> listResourcesForTagOptionRequest) throws TagOptionNotMigratedException, ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists resources associated with a TagOption.
This is a convenience which creates an instance of the ListResourcesForTagOptionRequest.Builder avoiding
the need to create one manually via ListResourcesForTagOptionRequest.builder()
listResourcesForTagOptionRequest - A Consumer that will call methods on ListResourcesForTagOptionInput.Builder to create a
request.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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagOptionsResponse listTagOptions() throws TagOptionNotMigratedException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists detailed TagOptions information.
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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistTagOptions(ListTagOptionsRequest),
AWS
API Documentationdefault ListTagOptionsResponse listTagOptions(ListTagOptionsRequest listTagOptionsRequest) throws TagOptionNotMigratedException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists detailed TagOptions information.
listTagOptionsRequest - 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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagOptionsResponse listTagOptions(Consumer<ListTagOptionsRequest.Builder> listTagOptionsRequest) throws TagOptionNotMigratedException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists detailed TagOptions information.
This is a convenience which creates an instance of the ListTagOptionsRequest.Builder avoiding the need to
create one manually via ListTagOptionsRequest.builder()
listTagOptionsRequest - A Consumer that will call methods on ListTagOptionsInput.Builder to create a request.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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ProvisionProductResponse provisionProduct(ProvisionProductRequest provisionProductRequest) throws InvalidParametersException, ResourceNotFoundException, DuplicateResourceException, AwsServiceException, 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. 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.
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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ProvisionProductResponse provisionProduct(Consumer<ProvisionProductRequest.Builder> provisionProductRequest) throws InvalidParametersException, ResourceNotFoundException, DuplicateResourceException, AwsServiceException, 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. 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.
This is a convenience which creates an instance of the ProvisionProductRequest.Builder avoiding the need
to create one manually via ProvisionProductRequest.builder()
provisionProductRequest - A Consumer that will call methods on ProvisionProductInput.Builder to create a request.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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RejectPortfolioShareResponse rejectPortfolioShare(RejectPortfolioShareRequest rejectPortfolioShareRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Rejects an offer to share a portfolio.
rejectPortfolioShareRequest - ResourceNotFoundException - The specified resource was not found.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RejectPortfolioShareResponse rejectPortfolioShare(Consumer<RejectPortfolioShareRequest.Builder> rejectPortfolioShareRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Rejects an offer to share a portfolio.
This is a convenience which creates an instance of the RejectPortfolioShareRequest.Builder avoiding the
need to create one manually via RejectPortfolioShareRequest.builder()
rejectPortfolioShareRequest - A Consumer that will call methods on RejectPortfolioShareInput.Builder to create a
request.ResourceNotFoundException - The specified resource was not found.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ScanProvisionedProductsResponse scanProvisionedProducts() throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Returns a paginated list of all the ProvisionedProduct objects that are currently available (not terminated).
InvalidParametersException - One or more parameters provided to the operation are invalid.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionscanProvisionedProducts(ScanProvisionedProductsRequest),
AWS API Documentationdefault ScanProvisionedProductsResponse scanProvisionedProducts(ScanProvisionedProductsRequest scanProvisionedProductsRequest) throws InvalidParametersException, AwsServiceException, 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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ScanProvisionedProductsResponse scanProvisionedProducts(Consumer<ScanProvisionedProductsRequest.Builder> scanProvisionedProductsRequest) throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Returns a paginated list of all the ProvisionedProduct objects that are currently available (not terminated).
This is a convenience which creates an instance of the ScanProvisionedProductsRequest.Builder avoiding
the need to create one manually via ScanProvisionedProductsRequest.builder()
scanProvisionedProductsRequest - A Consumer that will call methods on ScanProvisionedProductsInput.Builder to create a
request.InvalidParametersException - One or more parameters provided to the operation are invalid.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchProductsResponse searchProducts() throws InvalidParametersException, AwsServiceException, 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.
InvalidParametersException - One or more parameters provided to the operation are invalid.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionsearchProducts(SearchProductsRequest),
AWS
API Documentationdefault SearchProductsResponse searchProducts(SearchProductsRequest searchProductsRequest) throws InvalidParametersException, AwsServiceException, 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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchProductsResponse searchProducts(Consumer<SearchProductsRequest.Builder> searchProductsRequest) throws InvalidParametersException, AwsServiceException, 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.
This is a convenience which creates an instance of the SearchProductsRequest.Builder avoiding the need to
create one manually via SearchProductsRequest.builder()
searchProductsRequest - A Consumer that will call methods on SearchProductsInput.Builder to create a request.InvalidParametersException - One or more parameters provided to the operation are invalid.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchProductsIterable searchProductsPaginator(SearchProductsRequest searchProductsRequest) throws InvalidParametersException, AwsServiceException, 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.
This is a variant of
searchProducts(software.amazon.awssdk.services.servicecatalog.model.SearchProductsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.servicecatalog.paginators.SearchProductsIterable responses = client.searchProductsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.servicecatalog.paginators.SearchProductsIterable responses = client
.searchProductsPaginator(request);
for (software.amazon.awssdk.services.servicecatalog.model.SearchProductsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.servicecatalog.paginators.SearchProductsIterable responses = client.searchProductsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
searchProducts(software.amazon.awssdk.services.servicecatalog.model.SearchProductsRequest)
operation.
searchProductsRequest - InvalidParametersException - One or more parameters provided to the operation are invalid.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchProductsIterable searchProductsPaginator() throws InvalidParametersException, AwsServiceException, 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.
This is a variant of
searchProducts(software.amazon.awssdk.services.servicecatalog.model.SearchProductsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.servicecatalog.paginators.SearchProductsIterable responses = client.searchProductsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.servicecatalog.paginators.SearchProductsIterable responses = client
.searchProductsPaginator(request);
for (software.amazon.awssdk.services.servicecatalog.model.SearchProductsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.servicecatalog.paginators.SearchProductsIterable responses = client.searchProductsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
searchProducts(software.amazon.awssdk.services.servicecatalog.model.SearchProductsRequest)
operation.
InvalidParametersException - One or more parameters provided to the operation are invalid.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionsearchProductsPaginator(SearchProductsRequest),
AWS
API Documentationdefault SearchProductsAsAdminResponse searchProductsAsAdmin() throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, 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.
ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are invalid.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionsearchProductsAsAdmin(SearchProductsAsAdminRequest),
AWS API Documentationdefault SearchProductsAsAdminResponse searchProductsAsAdmin(SearchProductsAsAdminRequest searchProductsAsAdminRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, 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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchProductsAsAdminResponse searchProductsAsAdmin(Consumer<SearchProductsAsAdminRequest.Builder> searchProductsAsAdminRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, 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.
This is a convenience which creates an instance of the SearchProductsAsAdminRequest.Builder avoiding the
need to create one manually via SearchProductsAsAdminRequest.builder()
searchProductsAsAdminRequest - A Consumer that will call methods on SearchProductsAsAdminInput.Builder to create a
request.ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are invalid.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchProductsAsAdminIterable searchProductsAsAdminPaginator(SearchProductsAsAdminRequest searchProductsAsAdminRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, 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.
This is a variant of
searchProductsAsAdmin(software.amazon.awssdk.services.servicecatalog.model.SearchProductsAsAdminRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.servicecatalog.paginators.SearchProductsAsAdminIterable responses = client.searchProductsAsAdminPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.servicecatalog.paginators.SearchProductsAsAdminIterable responses = client
.searchProductsAsAdminPaginator(request);
for (software.amazon.awssdk.services.servicecatalog.model.SearchProductsAsAdminResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.servicecatalog.paginators.SearchProductsAsAdminIterable responses = client.searchProductsAsAdminPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
searchProductsAsAdmin(software.amazon.awssdk.services.servicecatalog.model.SearchProductsAsAdminRequest)
operation.
searchProductsAsAdminRequest - ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are invalid.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchProductsAsAdminIterable searchProductsAsAdminPaginator() throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, 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.
This is a variant of
searchProductsAsAdmin(software.amazon.awssdk.services.servicecatalog.model.SearchProductsAsAdminRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.servicecatalog.paginators.SearchProductsAsAdminIterable responses = client.searchProductsAsAdminPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.servicecatalog.paginators.SearchProductsAsAdminIterable responses = client
.searchProductsAsAdminPaginator(request);
for (software.amazon.awssdk.services.servicecatalog.model.SearchProductsAsAdminResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.servicecatalog.paginators.SearchProductsAsAdminIterable responses = client.searchProductsAsAdminPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
searchProductsAsAdmin(software.amazon.awssdk.services.servicecatalog.model.SearchProductsAsAdminRequest)
operation.
ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are invalid.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionsearchProductsAsAdminPaginator(SearchProductsAsAdminRequest),
AWS API Documentationdefault TerminateProvisionedProductResponse terminateProvisionedProduct(TerminateProvisionedProductRequest terminateProvisionedProductRequest) throws ResourceNotFoundException, AwsServiceException, 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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TerminateProvisionedProductResponse terminateProvisionedProduct(Consumer<TerminateProvisionedProductRequest.Builder> terminateProvisionedProductRequest) throws ResourceNotFoundException, AwsServiceException, 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.
This is a convenience which creates an instance of the TerminateProvisionedProductRequest.Builder
avoiding the need to create one manually via TerminateProvisionedProductRequest.builder()
terminateProvisionedProductRequest - A Consumer that will call methods on TerminateProvisionedProductInput.Builder to create a
request.ResourceNotFoundException - The specified resource was not found.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateConstraintResponse updateConstraint(UpdateConstraintRequest updateConstraintRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, 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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateConstraintResponse updateConstraint(Consumer<UpdateConstraintRequest.Builder> updateConstraintRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Updates an existing constraint.
This is a convenience which creates an instance of the UpdateConstraintRequest.Builder avoiding the need
to create one manually via UpdateConstraintRequest.builder()
updateConstraintRequest - A Consumer that will call methods on UpdateConstraintInput.Builder to create a request.ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are invalid.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdatePortfolioResponse updatePortfolio(UpdatePortfolioRequest updatePortfolioRequest) throws InvalidParametersException, ResourceNotFoundException, LimitExceededException, TagOptionNotMigratedException, AwsServiceException, 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.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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdatePortfolioResponse updatePortfolio(Consumer<UpdatePortfolioRequest.Builder> updatePortfolioRequest) throws InvalidParametersException, ResourceNotFoundException, LimitExceededException, TagOptionNotMigratedException, AwsServiceException, SdkClientException, ServiceCatalogException
Updates the specified portfolio's details. This operation does not work with a product that has been shared with you.
This is a convenience which creates an instance of the UpdatePortfolioRequest.Builder avoiding the need
to create one manually via UpdatePortfolioRequest.builder()
updatePortfolioRequest - A Consumer that will call methods on UpdatePortfolioInput.Builder to create a request.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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateProductResponse updateProduct(UpdateProductRequest updateProductRequest) throws ResourceNotFoundException, InvalidParametersException, TagOptionNotMigratedException, AwsServiceException, 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.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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateProductResponse updateProduct(Consumer<UpdateProductRequest.Builder> updateProductRequest) throws ResourceNotFoundException, InvalidParametersException, TagOptionNotMigratedException, AwsServiceException, SdkClientException, ServiceCatalogException
Updates an existing product.
This is a convenience which creates an instance of the UpdateProductRequest.Builder avoiding the need to
create one manually via UpdateProductRequest.builder()
updateProductRequest - A Consumer that will call methods on UpdateProductInput.Builder to create a request.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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateProvisionedProductResponse updateProvisionedProduct(UpdateProvisionedProductRequest updateProvisionedProductRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, 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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateProvisionedProductResponse updateProvisionedProduct(Consumer<UpdateProvisionedProductRequest.Builder> updateProvisionedProductRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, 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.
This is a convenience which creates an instance of the UpdateProvisionedProductRequest.Builder avoiding
the need to create one manually via UpdateProvisionedProductRequest.builder()
updateProvisionedProductRequest - A Consumer that will call methods on UpdateProvisionedProductInput.Builder to create a
request.InvalidParametersException - One or more parameters provided to the operation are invalid.ResourceNotFoundException - The specified resource was not found.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateProvisioningArtifactResponse updateProvisioningArtifact(UpdateProvisioningArtifactRequest updateProvisioningArtifactRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, 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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateProvisioningArtifactResponse updateProvisioningArtifact(Consumer<UpdateProvisioningArtifactRequest.Builder> updateProvisioningArtifactRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, 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.
This is a convenience which creates an instance of the UpdateProvisioningArtifactRequest.Builder avoiding
the need to create one manually via UpdateProvisioningArtifactRequest.builder()
updateProvisioningArtifactRequest - A Consumer that will call methods on UpdateProvisioningArtifactInput.Builder to create a
request.ResourceNotFoundException - The specified resource was not found.InvalidParametersException - One or more parameters provided to the operation are invalid.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateTagOptionResponse updateTagOption(UpdateTagOptionRequest updateTagOptionRequest) throws TagOptionNotMigratedException, ResourceNotFoundException, DuplicateResourceException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Updates an existing TagOption.
updateTagOptionRequest - 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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateTagOptionResponse updateTagOption(Consumer<UpdateTagOptionRequest.Builder> updateTagOptionRequest) throws TagOptionNotMigratedException, ResourceNotFoundException, DuplicateResourceException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Updates an existing TagOption.
This is a convenience which creates an instance of the UpdateTagOptionRequest.Builder avoiding the need
to create one manually via UpdateTagOptionRequest.builder()
updateTagOptionRequest - A Consumer that will call methods on UpdateTagOptionInput.Builder to create a request.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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.