Interface ServiceCatalogAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
invalid reference
SdkAsyncHttpClient
Service Catalog enables organizations to create and manage catalogs of IT services that are approved for Amazon Web Services. To get the most out of this documentation, you should be familiar with the terminology discussed in Service Catalog Concepts.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionacceptPortfolioShare
(Consumer<AcceptPortfolioShareRequest.Builder> acceptPortfolioShareRequest) Accepts an offer to share the specified portfolio.acceptPortfolioShare
(AcceptPortfolioShareRequest acceptPortfolioShareRequest) Accepts an offer to share the specified portfolio.associateBudgetWithResource
(Consumer<AssociateBudgetWithResourceRequest.Builder> associateBudgetWithResourceRequest) Associates the specified budget with the specified resource.associateBudgetWithResource
(AssociateBudgetWithResourceRequest associateBudgetWithResourceRequest) Associates the specified budget with the specified resource.associatePrincipalWithPortfolio
(Consumer<AssociatePrincipalWithPortfolioRequest.Builder> associatePrincipalWithPortfolioRequest) Associates the specified principal ARN with the specified portfolio.associatePrincipalWithPortfolio
(AssociatePrincipalWithPortfolioRequest associatePrincipalWithPortfolioRequest) Associates the specified principal ARN with the specified portfolio.associateProductWithPortfolio
(Consumer<AssociateProductWithPortfolioRequest.Builder> associateProductWithPortfolioRequest) Associates the specified product with the specified portfolio.associateProductWithPortfolio
(AssociateProductWithPortfolioRequest associateProductWithPortfolioRequest) Associates the specified product with the specified portfolio.associateServiceActionWithProvisioningArtifact
(Consumer<AssociateServiceActionWithProvisioningArtifactRequest.Builder> associateServiceActionWithProvisioningArtifactRequest) Associates a self-service action with a provisioning artifact.associateServiceActionWithProvisioningArtifact
(AssociateServiceActionWithProvisioningArtifactRequest associateServiceActionWithProvisioningArtifactRequest) Associates a self-service action with a provisioning artifact.associateTagOptionWithResource
(Consumer<AssociateTagOptionWithResourceRequest.Builder> associateTagOptionWithResourceRequest) Associate the specified TagOption with the specified portfolio or product.associateTagOptionWithResource
(AssociateTagOptionWithResourceRequest associateTagOptionWithResourceRequest) Associate the specified TagOption with the specified portfolio or product.batchAssociateServiceActionWithProvisioningArtifact
(Consumer<BatchAssociateServiceActionWithProvisioningArtifactRequest.Builder> batchAssociateServiceActionWithProvisioningArtifactRequest) Associates multiple self-service actions with provisioning artifacts.batchAssociateServiceActionWithProvisioningArtifact
(BatchAssociateServiceActionWithProvisioningArtifactRequest batchAssociateServiceActionWithProvisioningArtifactRequest) Associates multiple self-service actions with provisioning artifacts.batchDisassociateServiceActionFromProvisioningArtifact
(Consumer<BatchDisassociateServiceActionFromProvisioningArtifactRequest.Builder> batchDisassociateServiceActionFromProvisioningArtifactRequest) Disassociates a batch of self-service actions from the specified provisioning artifact.batchDisassociateServiceActionFromProvisioningArtifact
(BatchDisassociateServiceActionFromProvisioningArtifactRequest batchDisassociateServiceActionFromProvisioningArtifactRequest) Disassociates a batch of self-service actions from the specified provisioning artifact.builder()
Create a builder that can be used to configure and create aServiceCatalogAsyncClient
.default CompletableFuture
<CopyProductResponse> copyProduct
(Consumer<CopyProductRequest.Builder> copyProductRequest) Copies the specified source product to the specified target product or a new product.default CompletableFuture
<CopyProductResponse> copyProduct
(CopyProductRequest copyProductRequest) Copies the specified source product to the specified target product or a new product.static ServiceCatalogAsyncClient
create()
Create aServiceCatalogAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createConstraint
(Consumer<CreateConstraintRequest.Builder> createConstraintRequest) Creates a constraint.createConstraint
(CreateConstraintRequest createConstraintRequest) Creates a constraint.default CompletableFuture
<CreatePortfolioResponse> createPortfolio
(Consumer<CreatePortfolioRequest.Builder> createPortfolioRequest) Creates a portfolio.default CompletableFuture
<CreatePortfolioResponse> createPortfolio
(CreatePortfolioRequest createPortfolioRequest) Creates a portfolio.createPortfolioShare
(Consumer<CreatePortfolioShareRequest.Builder> createPortfolioShareRequest) Shares the specified portfolio with the specified account or organization node.createPortfolioShare
(CreatePortfolioShareRequest createPortfolioShareRequest) Shares the specified portfolio with the specified account or organization node.default CompletableFuture
<CreateProductResponse> createProduct
(Consumer<CreateProductRequest.Builder> createProductRequest) Creates a product.default CompletableFuture
<CreateProductResponse> createProduct
(CreateProductRequest createProductRequest) Creates a product.createProvisionedProductPlan
(Consumer<CreateProvisionedProductPlanRequest.Builder> createProvisionedProductPlanRequest) Creates a plan.createProvisionedProductPlan
(CreateProvisionedProductPlanRequest createProvisionedProductPlanRequest) Creates a plan.createProvisioningArtifact
(Consumer<CreateProvisioningArtifactRequest.Builder> createProvisioningArtifactRequest) Creates a provisioning artifact (also known as a version) for the specified product.createProvisioningArtifact
(CreateProvisioningArtifactRequest createProvisioningArtifactRequest) Creates a provisioning artifact (also known as a version) for the specified product.createServiceAction
(Consumer<CreateServiceActionRequest.Builder> createServiceActionRequest) Creates a self-service action.createServiceAction
(CreateServiceActionRequest createServiceActionRequest) Creates a self-service action.default CompletableFuture
<CreateTagOptionResponse> createTagOption
(Consumer<CreateTagOptionRequest.Builder> createTagOptionRequest) Creates a TagOption.default CompletableFuture
<CreateTagOptionResponse> createTagOption
(CreateTagOptionRequest createTagOptionRequest) Creates a TagOption.deleteConstraint
(Consumer<DeleteConstraintRequest.Builder> deleteConstraintRequest) Deletes the specified constraint.deleteConstraint
(DeleteConstraintRequest deleteConstraintRequest) Deletes the specified constraint.default CompletableFuture
<DeletePortfolioResponse> deletePortfolio
(Consumer<DeletePortfolioRequest.Builder> deletePortfolioRequest) Deletes the specified portfolio.default CompletableFuture
<DeletePortfolioResponse> deletePortfolio
(DeletePortfolioRequest deletePortfolioRequest) Deletes the specified portfolio.deletePortfolioShare
(Consumer<DeletePortfolioShareRequest.Builder> deletePortfolioShareRequest) Stops sharing the specified portfolio with the specified account or organization node.deletePortfolioShare
(DeletePortfolioShareRequest deletePortfolioShareRequest) Stops sharing the specified portfolio with the specified account or organization node.default CompletableFuture
<DeleteProductResponse> deleteProduct
(Consumer<DeleteProductRequest.Builder> deleteProductRequest) Deletes the specified product.default CompletableFuture
<DeleteProductResponse> deleteProduct
(DeleteProductRequest deleteProductRequest) Deletes the specified product.deleteProvisionedProductPlan
(Consumer<DeleteProvisionedProductPlanRequest.Builder> deleteProvisionedProductPlanRequest) Deletes the specified plan.deleteProvisionedProductPlan
(DeleteProvisionedProductPlanRequest deleteProvisionedProductPlanRequest) Deletes the specified plan.deleteProvisioningArtifact
(Consumer<DeleteProvisioningArtifactRequest.Builder> deleteProvisioningArtifactRequest) Deletes the specified provisioning artifact (also known as a version) for the specified product.deleteProvisioningArtifact
(DeleteProvisioningArtifactRequest deleteProvisioningArtifactRequest) Deletes the specified provisioning artifact (also known as a version) for the specified product.deleteServiceAction
(Consumer<DeleteServiceActionRequest.Builder> deleteServiceActionRequest) Deletes a self-service action.deleteServiceAction
(DeleteServiceActionRequest deleteServiceActionRequest) Deletes a self-service action.default CompletableFuture
<DeleteTagOptionResponse> deleteTagOption
(Consumer<DeleteTagOptionRequest.Builder> deleteTagOptionRequest) Deletes the specified TagOption.default CompletableFuture
<DeleteTagOptionResponse> deleteTagOption
(DeleteTagOptionRequest deleteTagOptionRequest) Deletes the specified TagOption.describeConstraint
(Consumer<DescribeConstraintRequest.Builder> describeConstraintRequest) Gets information about the specified constraint.describeConstraint
(DescribeConstraintRequest describeConstraintRequest) Gets information about the specified constraint.describeCopyProductStatus
(Consumer<DescribeCopyProductStatusRequest.Builder> describeCopyProductStatusRequest) Gets the status of the specified copy product operation.describeCopyProductStatus
(DescribeCopyProductStatusRequest describeCopyProductStatusRequest) Gets the status of the specified copy product operation.describePortfolio
(Consumer<DescribePortfolioRequest.Builder> describePortfolioRequest) Gets information about the specified portfolio.describePortfolio
(DescribePortfolioRequest describePortfolioRequest) Gets information about the specified portfolio.describePortfolioShares
(Consumer<DescribePortfolioSharesRequest.Builder> describePortfolioSharesRequest) Returns a summary of each of the portfolio shares that were created for the specified portfolio.describePortfolioShares
(DescribePortfolioSharesRequest describePortfolioSharesRequest) Returns a summary of each of the portfolio shares that were created for the specified portfolio.default DescribePortfolioSharesPublisher
describePortfolioSharesPaginator
(Consumer<DescribePortfolioSharesRequest.Builder> describePortfolioSharesRequest) This is a variant ofdescribePortfolioShares(software.amazon.awssdk.services.servicecatalog.model.DescribePortfolioSharesRequest)
operation.default DescribePortfolioSharesPublisher
describePortfolioSharesPaginator
(DescribePortfolioSharesRequest describePortfolioSharesRequest) This is a variant ofdescribePortfolioShares(software.amazon.awssdk.services.servicecatalog.model.DescribePortfolioSharesRequest)
operation.describePortfolioShareStatus
(Consumer<DescribePortfolioShareStatusRequest.Builder> describePortfolioShareStatusRequest) Gets the status of the specified portfolio share operation.describePortfolioShareStatus
(DescribePortfolioShareStatusRequest describePortfolioShareStatusRequest) Gets the status of the specified portfolio share operation.default CompletableFuture
<DescribeProductResponse> describeProduct
(Consumer<DescribeProductRequest.Builder> describeProductRequest) Gets information about the specified product.default CompletableFuture
<DescribeProductResponse> describeProduct
(DescribeProductRequest describeProductRequest) Gets information about the specified product.describeProductAsAdmin
(Consumer<DescribeProductAsAdminRequest.Builder> describeProductAsAdminRequest) Gets information about the specified product.describeProductAsAdmin
(DescribeProductAsAdminRequest describeProductAsAdminRequest) Gets information about the specified product.describeProductView
(Consumer<DescribeProductViewRequest.Builder> describeProductViewRequest) Gets information about the specified product.describeProductView
(DescribeProductViewRequest describeProductViewRequest) Gets information about the specified product.describeProvisionedProduct
(Consumer<DescribeProvisionedProductRequest.Builder> describeProvisionedProductRequest) Gets information about the specified provisioned product.describeProvisionedProduct
(DescribeProvisionedProductRequest describeProvisionedProductRequest) Gets information about the specified provisioned product.describeProvisionedProductPlan
(Consumer<DescribeProvisionedProductPlanRequest.Builder> describeProvisionedProductPlanRequest) Gets information about the resource changes for the specified plan.describeProvisionedProductPlan
(DescribeProvisionedProductPlanRequest describeProvisionedProductPlanRequest) Gets information about the resource changes for the specified plan.describeProvisioningArtifact
(Consumer<DescribeProvisioningArtifactRequest.Builder> describeProvisioningArtifactRequest) Gets information about the specified provisioning artifact (also known as a version) for the specified product.describeProvisioningArtifact
(DescribeProvisioningArtifactRequest describeProvisioningArtifactRequest) Gets information about the specified provisioning artifact (also known as a version) for the specified product.describeProvisioningParameters
(Consumer<DescribeProvisioningParametersRequest.Builder> describeProvisioningParametersRequest) Gets information about the configuration required to provision the specified product using the specified provisioning artifact.describeProvisioningParameters
(DescribeProvisioningParametersRequest describeProvisioningParametersRequest) Gets information about the configuration required to provision the specified product using the specified provisioning artifact.default CompletableFuture
<DescribeRecordResponse> describeRecord
(Consumer<DescribeRecordRequest.Builder> describeRecordRequest) Gets information about the specified request operation.default CompletableFuture
<DescribeRecordResponse> describeRecord
(DescribeRecordRequest describeRecordRequest) Gets information about the specified request operation.describeServiceAction
(Consumer<DescribeServiceActionRequest.Builder> describeServiceActionRequest) Describes a self-service action.describeServiceAction
(DescribeServiceActionRequest describeServiceActionRequest) Describes a self-service action.describeServiceActionExecutionParameters
(Consumer<DescribeServiceActionExecutionParametersRequest.Builder> describeServiceActionExecutionParametersRequest) Finds the default parameters for a specific self-service action on a specific provisioned product and returns a map of the results to the user.describeServiceActionExecutionParameters
(DescribeServiceActionExecutionParametersRequest describeServiceActionExecutionParametersRequest) Finds the default parameters for a specific self-service action on a specific provisioned product and returns a map of the results to the user.describeTagOption
(Consumer<DescribeTagOptionRequest.Builder> describeTagOptionRequest) Gets information about the specified TagOption.describeTagOption
(DescribeTagOptionRequest describeTagOptionRequest) Gets information about the specified TagOption.disableAWSOrganizationsAccess
(Consumer<DisableAwsOrganizationsAccessRequest.Builder> disableAwsOrganizationsAccessRequest) Disable portfolio sharing through the Organizations service.disableAWSOrganizationsAccess
(DisableAwsOrganizationsAccessRequest disableAwsOrganizationsAccessRequest) Disable portfolio sharing through the Organizations service.disassociateBudgetFromResource
(Consumer<DisassociateBudgetFromResourceRequest.Builder> disassociateBudgetFromResourceRequest) Disassociates the specified budget from the specified resource.disassociateBudgetFromResource
(DisassociateBudgetFromResourceRequest disassociateBudgetFromResourceRequest) Disassociates the specified budget from the specified resource.disassociatePrincipalFromPortfolio
(Consumer<DisassociatePrincipalFromPortfolioRequest.Builder> disassociatePrincipalFromPortfolioRequest) Disassociates a previously associated principal ARN from a specified portfolio.disassociatePrincipalFromPortfolio
(DisassociatePrincipalFromPortfolioRequest disassociatePrincipalFromPortfolioRequest) Disassociates a previously associated principal ARN from a specified portfolio.disassociateProductFromPortfolio
(Consumer<DisassociateProductFromPortfolioRequest.Builder> disassociateProductFromPortfolioRequest) Disassociates the specified product from the specified portfolio.disassociateProductFromPortfolio
(DisassociateProductFromPortfolioRequest disassociateProductFromPortfolioRequest) Disassociates the specified product from the specified portfolio.disassociateServiceActionFromProvisioningArtifact
(Consumer<DisassociateServiceActionFromProvisioningArtifactRequest.Builder> disassociateServiceActionFromProvisioningArtifactRequest) Disassociates the specified self-service action association from the specified provisioning artifact.disassociateServiceActionFromProvisioningArtifact
(DisassociateServiceActionFromProvisioningArtifactRequest disassociateServiceActionFromProvisioningArtifactRequest) Disassociates the specified self-service action association from the specified provisioning artifact.disassociateTagOptionFromResource
(Consumer<DisassociateTagOptionFromResourceRequest.Builder> disassociateTagOptionFromResourceRequest) Disassociates the specified TagOption from the specified resource.disassociateTagOptionFromResource
(DisassociateTagOptionFromResourceRequest disassociateTagOptionFromResourceRequest) Disassociates the specified TagOption from the specified resource.enableAWSOrganizationsAccess
(Consumer<EnableAwsOrganizationsAccessRequest.Builder> enableAwsOrganizationsAccessRequest) Enable portfolio sharing feature through Organizations.enableAWSOrganizationsAccess
(EnableAwsOrganizationsAccessRequest enableAwsOrganizationsAccessRequest) Enable portfolio sharing feature through Organizations.executeProvisionedProductPlan
(Consumer<ExecuteProvisionedProductPlanRequest.Builder> executeProvisionedProductPlanRequest) Provisions or modifies a product based on the resource changes for the specified plan.executeProvisionedProductPlan
(ExecuteProvisionedProductPlanRequest executeProvisionedProductPlanRequest) Provisions or modifies a product based on the resource changes for the specified plan.executeProvisionedProductServiceAction
(Consumer<ExecuteProvisionedProductServiceActionRequest.Builder> executeProvisionedProductServiceActionRequest) Executes a self-service action against a provisioned product.executeProvisionedProductServiceAction
(ExecuteProvisionedProductServiceActionRequest executeProvisionedProductServiceActionRequest) Executes a self-service action against a provisioned product.Get the Access Status for Organizations portfolio share feature.getAWSOrganizationsAccessStatus
(Consumer<GetAwsOrganizationsAccessStatusRequest.Builder> getAwsOrganizationsAccessStatusRequest) Get the Access Status for Organizations portfolio share feature.getAWSOrganizationsAccessStatus
(GetAwsOrganizationsAccessStatusRequest getAwsOrganizationsAccessStatusRequest) Get the Access Status for Organizations portfolio share feature.getProvisionedProductOutputs
(Consumer<GetProvisionedProductOutputsRequest.Builder> getProvisionedProductOutputsRequest) This API takes either aProvisonedProductId
or aProvisionedProductName
, along with a list of one or more output keys, and responds with the key/value pairs of those outputs.getProvisionedProductOutputs
(GetProvisionedProductOutputsRequest getProvisionedProductOutputsRequest) This API takes either aProvisonedProductId
or aProvisionedProductName
, along with a list of one or more output keys, and responds with the key/value pairs of those outputs.getProvisionedProductOutputsPaginator
(Consumer<GetProvisionedProductOutputsRequest.Builder> getProvisionedProductOutputsRequest) This is a variant ofgetProvisionedProductOutputs(software.amazon.awssdk.services.servicecatalog.model.GetProvisionedProductOutputsRequest)
operation.getProvisionedProductOutputsPaginator
(GetProvisionedProductOutputsRequest getProvisionedProductOutputsRequest) This is a variant ofgetProvisionedProductOutputs(software.amazon.awssdk.services.servicecatalog.model.GetProvisionedProductOutputsRequest)
operation.importAsProvisionedProduct
(Consumer<ImportAsProvisionedProductRequest.Builder> importAsProvisionedProductRequest) Requests the import of a resource as an Service Catalog provisioned product that is associated to an Service Catalog product and provisioning artifact.importAsProvisionedProduct
(ImportAsProvisionedProductRequest importAsProvisionedProductRequest) Requests the import of a resource as an Service Catalog provisioned product that is associated to an Service Catalog product and provisioning artifact.Lists all imported portfolios for which account-to-account shares were accepted by this account.listAcceptedPortfolioShares
(Consumer<ListAcceptedPortfolioSharesRequest.Builder> listAcceptedPortfolioSharesRequest) Lists all imported portfolios for which account-to-account shares were accepted by this account.listAcceptedPortfolioShares
(ListAcceptedPortfolioSharesRequest listAcceptedPortfolioSharesRequest) Lists all imported portfolios for which account-to-account shares were accepted by this account.This is a variant oflistAcceptedPortfolioShares(software.amazon.awssdk.services.servicecatalog.model.ListAcceptedPortfolioSharesRequest)
operation.listAcceptedPortfolioSharesPaginator
(Consumer<ListAcceptedPortfolioSharesRequest.Builder> listAcceptedPortfolioSharesRequest) This is a variant oflistAcceptedPortfolioShares(software.amazon.awssdk.services.servicecatalog.model.ListAcceptedPortfolioSharesRequest)
operation.listAcceptedPortfolioSharesPaginator
(ListAcceptedPortfolioSharesRequest listAcceptedPortfolioSharesRequest) This is a variant oflistAcceptedPortfolioShares(software.amazon.awssdk.services.servicecatalog.model.ListAcceptedPortfolioSharesRequest)
operation.listBudgetsForResource
(Consumer<ListBudgetsForResourceRequest.Builder> listBudgetsForResourceRequest) Lists all the budgets associated to the specified resource.listBudgetsForResource
(ListBudgetsForResourceRequest listBudgetsForResourceRequest) Lists all the budgets associated to the specified resource.default ListBudgetsForResourcePublisher
listBudgetsForResourcePaginator
(Consumer<ListBudgetsForResourceRequest.Builder> listBudgetsForResourceRequest) This is a variant oflistBudgetsForResource(software.amazon.awssdk.services.servicecatalog.model.ListBudgetsForResourceRequest)
operation.default ListBudgetsForResourcePublisher
listBudgetsForResourcePaginator
(ListBudgetsForResourceRequest listBudgetsForResourceRequest) This is a variant oflistBudgetsForResource(software.amazon.awssdk.services.servicecatalog.model.ListBudgetsForResourceRequest)
operation.listConstraintsForPortfolio
(Consumer<ListConstraintsForPortfolioRequest.Builder> listConstraintsForPortfolioRequest) Lists the constraints for the specified portfolio and product.listConstraintsForPortfolio
(ListConstraintsForPortfolioRequest listConstraintsForPortfolioRequest) Lists the constraints for the specified portfolio and product.listConstraintsForPortfolioPaginator
(Consumer<ListConstraintsForPortfolioRequest.Builder> listConstraintsForPortfolioRequest) This is a variant oflistConstraintsForPortfolio(software.amazon.awssdk.services.servicecatalog.model.ListConstraintsForPortfolioRequest)
operation.listConstraintsForPortfolioPaginator
(ListConstraintsForPortfolioRequest listConstraintsForPortfolioRequest) This is a variant oflistConstraintsForPortfolio(software.amazon.awssdk.services.servicecatalog.model.ListConstraintsForPortfolioRequest)
operation.default CompletableFuture
<ListLaunchPathsResponse> listLaunchPaths
(Consumer<ListLaunchPathsRequest.Builder> listLaunchPathsRequest) Lists the paths to the specified product.default CompletableFuture
<ListLaunchPathsResponse> listLaunchPaths
(ListLaunchPathsRequest listLaunchPathsRequest) Lists the paths to the specified product.default ListLaunchPathsPublisher
listLaunchPathsPaginator
(Consumer<ListLaunchPathsRequest.Builder> listLaunchPathsRequest) This is a variant oflistLaunchPaths(software.amazon.awssdk.services.servicecatalog.model.ListLaunchPathsRequest)
operation.default ListLaunchPathsPublisher
listLaunchPathsPaginator
(ListLaunchPathsRequest listLaunchPathsRequest) This is a variant oflistLaunchPaths(software.amazon.awssdk.services.servicecatalog.model.ListLaunchPathsRequest)
operation.listOrganizationPortfolioAccess
(Consumer<ListOrganizationPortfolioAccessRequest.Builder> listOrganizationPortfolioAccessRequest) Lists the organization nodes that have access to the specified portfolio.listOrganizationPortfolioAccess
(ListOrganizationPortfolioAccessRequest listOrganizationPortfolioAccessRequest) Lists the organization nodes that have access to the specified portfolio.listOrganizationPortfolioAccessPaginator
(Consumer<ListOrganizationPortfolioAccessRequest.Builder> listOrganizationPortfolioAccessRequest) This is a variant oflistOrganizationPortfolioAccess(software.amazon.awssdk.services.servicecatalog.model.ListOrganizationPortfolioAccessRequest)
operation.listOrganizationPortfolioAccessPaginator
(ListOrganizationPortfolioAccessRequest listOrganizationPortfolioAccessRequest) This is a variant oflistOrganizationPortfolioAccess(software.amazon.awssdk.services.servicecatalog.model.ListOrganizationPortfolioAccessRequest)
operation.listPortfolioAccess
(Consumer<ListPortfolioAccessRequest.Builder> listPortfolioAccessRequest) Lists the account IDs that have access to the specified portfolio.listPortfolioAccess
(ListPortfolioAccessRequest listPortfolioAccessRequest) Lists the account IDs that have access to the specified portfolio.default ListPortfolioAccessPublisher
listPortfolioAccessPaginator
(Consumer<ListPortfolioAccessRequest.Builder> listPortfolioAccessRequest) This is a variant oflistPortfolioAccess(software.amazon.awssdk.services.servicecatalog.model.ListPortfolioAccessRequest)
operation.default ListPortfolioAccessPublisher
listPortfolioAccessPaginator
(ListPortfolioAccessRequest listPortfolioAccessRequest) This is a variant oflistPortfolioAccess(software.amazon.awssdk.services.servicecatalog.model.ListPortfolioAccessRequest)
operation.default CompletableFuture
<ListPortfoliosResponse> Lists all portfolios in the catalog.default CompletableFuture
<ListPortfoliosResponse> listPortfolios
(Consumer<ListPortfoliosRequest.Builder> listPortfoliosRequest) Lists all portfolios in the catalog.default CompletableFuture
<ListPortfoliosResponse> listPortfolios
(ListPortfoliosRequest listPortfoliosRequest) Lists all portfolios in the catalog.listPortfoliosForProduct
(Consumer<ListPortfoliosForProductRequest.Builder> listPortfoliosForProductRequest) Lists all portfolios that the specified product is associated with.listPortfoliosForProduct
(ListPortfoliosForProductRequest listPortfoliosForProductRequest) Lists all portfolios that the specified product is associated with.listPortfoliosForProductPaginator
(Consumer<ListPortfoliosForProductRequest.Builder> listPortfoliosForProductRequest) This is a variant oflistPortfoliosForProduct(software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosForProductRequest)
operation.listPortfoliosForProductPaginator
(ListPortfoliosForProductRequest listPortfoliosForProductRequest) This is a variant oflistPortfoliosForProduct(software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosForProductRequest)
operation.default ListPortfoliosPublisher
This is a variant oflistPortfolios(software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosRequest)
operation.default ListPortfoliosPublisher
listPortfoliosPaginator
(Consumer<ListPortfoliosRequest.Builder> listPortfoliosRequest) This is a variant oflistPortfolios(software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosRequest)
operation.default ListPortfoliosPublisher
listPortfoliosPaginator
(ListPortfoliosRequest listPortfoliosRequest) This is a variant oflistPortfolios(software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosRequest)
operation.listPrincipalsForPortfolio
(Consumer<ListPrincipalsForPortfolioRequest.Builder> listPrincipalsForPortfolioRequest) Lists allPrincipalARN
s and correspondingPrincipalType
s associated with the specified portfolio.listPrincipalsForPortfolio
(ListPrincipalsForPortfolioRequest listPrincipalsForPortfolioRequest) Lists allPrincipalARN
s and correspondingPrincipalType
s associated with the specified portfolio.listPrincipalsForPortfolioPaginator
(Consumer<ListPrincipalsForPortfolioRequest.Builder> listPrincipalsForPortfolioRequest) This is a variant oflistPrincipalsForPortfolio(software.amazon.awssdk.services.servicecatalog.model.ListPrincipalsForPortfolioRequest)
operation.listPrincipalsForPortfolioPaginator
(ListPrincipalsForPortfolioRequest listPrincipalsForPortfolioRequest) This is a variant oflistPrincipalsForPortfolio(software.amazon.awssdk.services.servicecatalog.model.ListPrincipalsForPortfolioRequest)
operation.Lists the plans for the specified provisioned product or all plans to which the user has access.listProvisionedProductPlans
(Consumer<ListProvisionedProductPlansRequest.Builder> listProvisionedProductPlansRequest) Lists the plans for the specified provisioned product or all plans to which the user has access.listProvisionedProductPlans
(ListProvisionedProductPlansRequest listProvisionedProductPlansRequest) Lists the plans for the specified provisioned product or all plans to which the user has access.listProvisioningArtifacts
(Consumer<ListProvisioningArtifactsRequest.Builder> listProvisioningArtifactsRequest) Lists all provisioning artifacts (also known as versions) for the specified product.listProvisioningArtifacts
(ListProvisioningArtifactsRequest listProvisioningArtifactsRequest) Lists all provisioning artifacts (also known as versions) for the specified product.listProvisioningArtifactsForServiceAction
(Consumer<ListProvisioningArtifactsForServiceActionRequest.Builder> listProvisioningArtifactsForServiceActionRequest) Lists all provisioning artifacts (also known as versions) for the specified self-service action.listProvisioningArtifactsForServiceAction
(ListProvisioningArtifactsForServiceActionRequest listProvisioningArtifactsForServiceActionRequest) Lists all provisioning artifacts (also known as versions) for the specified self-service action.listProvisioningArtifactsForServiceActionPaginator
(Consumer<ListProvisioningArtifactsForServiceActionRequest.Builder> listProvisioningArtifactsForServiceActionRequest) listProvisioningArtifactsForServiceActionPaginator
(ListProvisioningArtifactsForServiceActionRequest listProvisioningArtifactsForServiceActionRequest) Lists the specified requests or all performed requests.listRecordHistory
(Consumer<ListRecordHistoryRequest.Builder> listRecordHistoryRequest) Lists the specified requests or all performed requests.listRecordHistory
(ListRecordHistoryRequest listRecordHistoryRequest) Lists the specified requests or all performed requests.listResourcesForTagOption
(Consumer<ListResourcesForTagOptionRequest.Builder> listResourcesForTagOptionRequest) Lists the resources associated with the specified TagOption.listResourcesForTagOption
(ListResourcesForTagOptionRequest listResourcesForTagOptionRequest) Lists the resources associated with the specified TagOption.listResourcesForTagOptionPaginator
(Consumer<ListResourcesForTagOptionRequest.Builder> listResourcesForTagOptionRequest) This is a variant oflistResourcesForTagOption(software.amazon.awssdk.services.servicecatalog.model.ListResourcesForTagOptionRequest)
operation.listResourcesForTagOptionPaginator
(ListResourcesForTagOptionRequest listResourcesForTagOptionRequest) This is a variant oflistResourcesForTagOption(software.amazon.awssdk.services.servicecatalog.model.ListResourcesForTagOptionRequest)
operation.Lists all self-service actions.listServiceActions
(Consumer<ListServiceActionsRequest.Builder> listServiceActionsRequest) Lists all self-service actions.listServiceActions
(ListServiceActionsRequest listServiceActionsRequest) Lists all self-service actions.listServiceActionsForProvisioningArtifact
(Consumer<ListServiceActionsForProvisioningArtifactRequest.Builder> listServiceActionsForProvisioningArtifactRequest) Returns a paginated list of self-service actions associated with the specified Product ID and Provisioning Artifact ID.listServiceActionsForProvisioningArtifact
(ListServiceActionsForProvisioningArtifactRequest listServiceActionsForProvisioningArtifactRequest) Returns a paginated list of self-service actions associated with the specified Product ID and Provisioning Artifact ID.listServiceActionsForProvisioningArtifactPaginator
(Consumer<ListServiceActionsForProvisioningArtifactRequest.Builder> listServiceActionsForProvisioningArtifactRequest) listServiceActionsForProvisioningArtifactPaginator
(ListServiceActionsForProvisioningArtifactRequest listServiceActionsForProvisioningArtifactRequest) default ListServiceActionsPublisher
This is a variant oflistServiceActions(software.amazon.awssdk.services.servicecatalog.model.ListServiceActionsRequest)
operation.default ListServiceActionsPublisher
listServiceActionsPaginator
(Consumer<ListServiceActionsRequest.Builder> listServiceActionsRequest) This is a variant oflistServiceActions(software.amazon.awssdk.services.servicecatalog.model.ListServiceActionsRequest)
operation.default ListServiceActionsPublisher
listServiceActionsPaginator
(ListServiceActionsRequest listServiceActionsRequest) This is a variant oflistServiceActions(software.amazon.awssdk.services.servicecatalog.model.ListServiceActionsRequest)
operation.listStackInstancesForProvisionedProduct
(Consumer<ListStackInstancesForProvisionedProductRequest.Builder> listStackInstancesForProvisionedProductRequest) Returns summary information about stack instances that are associated with the specifiedCFN_STACKSET
type provisioned product.listStackInstancesForProvisionedProduct
(ListStackInstancesForProvisionedProductRequest listStackInstancesForProvisionedProductRequest) Returns summary information about stack instances that are associated with the specifiedCFN_STACKSET
type provisioned product.default CompletableFuture
<ListTagOptionsResponse> Lists the specified TagOptions or all TagOptions.default CompletableFuture
<ListTagOptionsResponse> listTagOptions
(Consumer<ListTagOptionsRequest.Builder> listTagOptionsRequest) Lists the specified TagOptions or all TagOptions.default CompletableFuture
<ListTagOptionsResponse> listTagOptions
(ListTagOptionsRequest listTagOptionsRequest) Lists the specified TagOptions or all TagOptions.default ListTagOptionsPublisher
This is a variant oflistTagOptions(software.amazon.awssdk.services.servicecatalog.model.ListTagOptionsRequest)
operation.default ListTagOptionsPublisher
listTagOptionsPaginator
(Consumer<ListTagOptionsRequest.Builder> listTagOptionsRequest) This is a variant oflistTagOptions(software.amazon.awssdk.services.servicecatalog.model.ListTagOptionsRequest)
operation.default ListTagOptionsPublisher
listTagOptionsPaginator
(ListTagOptionsRequest listTagOptionsRequest) This is a variant oflistTagOptions(software.amazon.awssdk.services.servicecatalog.model.ListTagOptionsRequest)
operation.notifyProvisionProductEngineWorkflowResult
(Consumer<NotifyProvisionProductEngineWorkflowResultRequest.Builder> notifyProvisionProductEngineWorkflowResultRequest) Notifies the result of the provisioning engine execution.notifyProvisionProductEngineWorkflowResult
(NotifyProvisionProductEngineWorkflowResultRequest notifyProvisionProductEngineWorkflowResultRequest) Notifies the result of the provisioning engine execution.notifyTerminateProvisionedProductEngineWorkflowResult
(Consumer<NotifyTerminateProvisionedProductEngineWorkflowResultRequest.Builder> notifyTerminateProvisionedProductEngineWorkflowResultRequest) Notifies the result of the terminate engine execution.notifyTerminateProvisionedProductEngineWorkflowResult
(NotifyTerminateProvisionedProductEngineWorkflowResultRequest notifyTerminateProvisionedProductEngineWorkflowResultRequest) Notifies the result of the terminate engine execution.notifyUpdateProvisionedProductEngineWorkflowResult
(Consumer<NotifyUpdateProvisionedProductEngineWorkflowResultRequest.Builder> notifyUpdateProvisionedProductEngineWorkflowResultRequest) Notifies the result of the update engine execution.notifyUpdateProvisionedProductEngineWorkflowResult
(NotifyUpdateProvisionedProductEngineWorkflowResultRequest notifyUpdateProvisionedProductEngineWorkflowResultRequest) Notifies the result of the update engine execution.provisionProduct
(Consumer<ProvisionProductRequest.Builder> provisionProductRequest) Provisions the specified product.provisionProduct
(ProvisionProductRequest provisionProductRequest) Provisions the specified product.rejectPortfolioShare
(Consumer<RejectPortfolioShareRequest.Builder> rejectPortfolioShareRequest) Rejects an offer to share the specified portfolio.rejectPortfolioShare
(RejectPortfolioShareRequest rejectPortfolioShareRequest) Rejects an offer to share the specified portfolio.Lists the provisioned products that are available (not terminated).scanProvisionedProducts
(Consumer<ScanProvisionedProductsRequest.Builder> scanProvisionedProductsRequest) Lists the provisioned products that are available (not terminated).scanProvisionedProducts
(ScanProvisionedProductsRequest scanProvisionedProductsRequest) Lists the provisioned products that are available (not terminated).default CompletableFuture
<SearchProductsResponse> Gets information about the products to which the caller has access.default CompletableFuture
<SearchProductsResponse> searchProducts
(Consumer<SearchProductsRequest.Builder> searchProductsRequest) Gets information about the products to which the caller has access.default CompletableFuture
<SearchProductsResponse> searchProducts
(SearchProductsRequest searchProductsRequest) Gets information about the products to which the caller has access.Gets information about the products for the specified portfolio or all products.searchProductsAsAdmin
(Consumer<SearchProductsAsAdminRequest.Builder> searchProductsAsAdminRequest) Gets information about the products for the specified portfolio or all products.searchProductsAsAdmin
(SearchProductsAsAdminRequest searchProductsAsAdminRequest) Gets information about the products for the specified portfolio or all products.default SearchProductsAsAdminPublisher
This is a variant ofsearchProductsAsAdmin(software.amazon.awssdk.services.servicecatalog.model.SearchProductsAsAdminRequest)
operation.default SearchProductsAsAdminPublisher
searchProductsAsAdminPaginator
(Consumer<SearchProductsAsAdminRequest.Builder> searchProductsAsAdminRequest) This is a variant ofsearchProductsAsAdmin(software.amazon.awssdk.services.servicecatalog.model.SearchProductsAsAdminRequest)
operation.default SearchProductsAsAdminPublisher
searchProductsAsAdminPaginator
(SearchProductsAsAdminRequest searchProductsAsAdminRequest) This is a variant ofsearchProductsAsAdmin(software.amazon.awssdk.services.servicecatalog.model.SearchProductsAsAdminRequest)
operation.default SearchProductsPublisher
This is a variant ofsearchProducts(software.amazon.awssdk.services.servicecatalog.model.SearchProductsRequest)
operation.default SearchProductsPublisher
searchProductsPaginator
(Consumer<SearchProductsRequest.Builder> searchProductsRequest) This is a variant ofsearchProducts(software.amazon.awssdk.services.servicecatalog.model.SearchProductsRequest)
operation.default SearchProductsPublisher
searchProductsPaginator
(SearchProductsRequest searchProductsRequest) This is a variant ofsearchProducts(software.amazon.awssdk.services.servicecatalog.model.SearchProductsRequest)
operation.Gets information about the provisioned products that meet the specified criteria.searchProvisionedProducts
(Consumer<SearchProvisionedProductsRequest.Builder> searchProvisionedProductsRequest) Gets information about the provisioned products that meet the specified criteria.searchProvisionedProducts
(SearchProvisionedProductsRequest searchProvisionedProductsRequest) Gets information about the provisioned products that meet the specified criteria.This is a variant ofsearchProvisionedProducts(software.amazon.awssdk.services.servicecatalog.model.SearchProvisionedProductsRequest)
operation.searchProvisionedProductsPaginator
(Consumer<SearchProvisionedProductsRequest.Builder> searchProvisionedProductsRequest) This is a variant ofsearchProvisionedProducts(software.amazon.awssdk.services.servicecatalog.model.SearchProvisionedProductsRequest)
operation.searchProvisionedProductsPaginator
(SearchProvisionedProductsRequest searchProvisionedProductsRequest) This is a variant ofsearchProvisionedProducts(software.amazon.awssdk.services.servicecatalog.model.SearchProvisionedProductsRequest)
operation.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationterminateProvisionedProduct
(Consumer<TerminateProvisionedProductRequest.Builder> terminateProvisionedProductRequest) Terminates the specified provisioned product.terminateProvisionedProduct
(TerminateProvisionedProductRequest terminateProvisionedProductRequest) Terminates the specified provisioned product.updateConstraint
(Consumer<UpdateConstraintRequest.Builder> updateConstraintRequest) Updates the specified constraint.updateConstraint
(UpdateConstraintRequest updateConstraintRequest) Updates the specified constraint.default CompletableFuture
<UpdatePortfolioResponse> updatePortfolio
(Consumer<UpdatePortfolioRequest.Builder> updatePortfolioRequest) Updates the specified portfolio.default CompletableFuture
<UpdatePortfolioResponse> updatePortfolio
(UpdatePortfolioRequest updatePortfolioRequest) Updates the specified portfolio.updatePortfolioShare
(Consumer<UpdatePortfolioShareRequest.Builder> updatePortfolioShareRequest) Updates the specified portfolio share.updatePortfolioShare
(UpdatePortfolioShareRequest updatePortfolioShareRequest) Updates the specified portfolio share.default CompletableFuture
<UpdateProductResponse> updateProduct
(Consumer<UpdateProductRequest.Builder> updateProductRequest) Updates the specified product.default CompletableFuture
<UpdateProductResponse> updateProduct
(UpdateProductRequest updateProductRequest) Updates the specified product.updateProvisionedProduct
(Consumer<UpdateProvisionedProductRequest.Builder> updateProvisionedProductRequest) Requests updates to the configuration of the specified provisioned product.updateProvisionedProduct
(UpdateProvisionedProductRequest updateProvisionedProductRequest) Requests updates to the configuration of the specified provisioned product.updateProvisionedProductProperties
(Consumer<UpdateProvisionedProductPropertiesRequest.Builder> updateProvisionedProductPropertiesRequest) Requests updates to the properties of the specified provisioned product.updateProvisionedProductProperties
(UpdateProvisionedProductPropertiesRequest updateProvisionedProductPropertiesRequest) Requests updates to the properties of the specified provisioned product.updateProvisioningArtifact
(Consumer<UpdateProvisioningArtifactRequest.Builder> updateProvisioningArtifactRequest) Updates the specified provisioning artifact (also known as a version) for the specified product.updateProvisioningArtifact
(UpdateProvisioningArtifactRequest updateProvisioningArtifactRequest) Updates the specified provisioning artifact (also known as a version) for the specified product.updateServiceAction
(Consumer<UpdateServiceActionRequest.Builder> updateServiceActionRequest) Updates a self-service action.updateServiceAction
(UpdateServiceActionRequest updateServiceActionRequest) Updates a self-service action.default CompletableFuture
<UpdateTagOptionResponse> updateTagOption
(Consumer<UpdateTagOptionRequest.Builder> updateTagOptionRequest) Updates the specified TagOption.default CompletableFuture
<UpdateTagOptionResponse> updateTagOption
(UpdateTagOptionRequest updateTagOptionRequest) Updates the specified TagOption.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
associateBudgetWithResource
default CompletableFuture<AssociateBudgetWithResourceResponse> associateBudgetWithResource(AssociateBudgetWithResourceRequest associateBudgetWithResourceRequest) Associates the specified budget with the specified resource.
- Parameters:
associateBudgetWithResourceRequest
-- Returns:
- A Java Future containing the result of the AssociateBudgetWithResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- DuplicateResourceException The specified resource is a duplicate.
- LimitExceededException The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.
- 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.
- See Also:
-
associateBudgetWithResource
default CompletableFuture<AssociateBudgetWithResourceResponse> associateBudgetWithResource(Consumer<AssociateBudgetWithResourceRequest.Builder> associateBudgetWithResourceRequest) Associates the specified budget with the specified resource.
This is a convenience which creates an instance of the
AssociateBudgetWithResourceRequest.Builder
avoiding the need to create one manually viaAssociateBudgetWithResourceRequest.builder()
- Parameters:
associateBudgetWithResourceRequest
- AConsumer
that will call methods onAssociateBudgetWithResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AssociateBudgetWithResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- DuplicateResourceException The specified resource is a duplicate.
- LimitExceededException The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.
- 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.
- See Also:
-
associatePrincipalWithPortfolio
default CompletableFuture<AssociatePrincipalWithPortfolioResponse> associatePrincipalWithPortfolio(AssociatePrincipalWithPortfolioRequest associatePrincipalWithPortfolioRequest) Associates the specified principal ARN with the specified portfolio.
If you share the portfolio with principal name sharing enabled, the
PrincipalARN
association is included in the share.The
PortfolioID
,PrincipalARN
, andPrincipalType
parameters are required.You can associate a maximum of 10 Principals with a portfolio using
PrincipalType
asIAM_PATTERN
.When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is then shared with other accounts. For a user in a recipient account who is not an Service Catalog Admin, but still has the ability to create Principals (Users/Groups/Roles), that user could create a role that matches a principal name association for the portfolio. Although this user may not know which principal names are associated through Service Catalog, they may be able to guess the user. If this potential escalation path is a concern, then Service Catalog recommends using
PrincipalType
asIAM
. With this configuration, thePrincipalARN
must already exist in the recipient account before it can be associated.- Parameters:
associatePrincipalWithPortfolioRequest
-- Returns:
- A Java Future containing the result of the AssociatePrincipalWithPortfolio operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- ResourceNotFoundException The specified resource was not found.
- LimitExceededException The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.
- 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.
- See Also:
-
associatePrincipalWithPortfolio
default CompletableFuture<AssociatePrincipalWithPortfolioResponse> associatePrincipalWithPortfolio(Consumer<AssociatePrincipalWithPortfolioRequest.Builder> associatePrincipalWithPortfolioRequest) Associates the specified principal ARN with the specified portfolio.
If you share the portfolio with principal name sharing enabled, the
PrincipalARN
association is included in the share.The
PortfolioID
,PrincipalARN
, andPrincipalType
parameters are required.You can associate a maximum of 10 Principals with a portfolio using
PrincipalType
asIAM_PATTERN
.When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is then shared with other accounts. For a user in a recipient account who is not an Service Catalog Admin, but still has the ability to create Principals (Users/Groups/Roles), that user could create a role that matches a principal name association for the portfolio. Although this user may not know which principal names are associated through Service Catalog, they may be able to guess the user. If this potential escalation path is a concern, then Service Catalog recommends using
PrincipalType
asIAM
. With this configuration, thePrincipalARN
must already exist in the recipient account before it can be associated.
This is a convenience which creates an instance of the
AssociatePrincipalWithPortfolioRequest.Builder
avoiding the need to create one manually viaAssociatePrincipalWithPortfolioRequest.builder()
- Parameters:
associatePrincipalWithPortfolioRequest
- AConsumer
that will call methods onAssociatePrincipalWithPortfolioRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AssociatePrincipalWithPortfolio operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- ResourceNotFoundException The specified resource was not found.
- LimitExceededException The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.
- 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.
- See Also:
-
associateProductWithPortfolio
default CompletableFuture<AssociateProductWithPortfolioResponse> associateProductWithPortfolio(AssociateProductWithPortfolioRequest associateProductWithPortfolioRequest) Associates the specified product with the specified portfolio.
A delegated admin is authorized to invoke this command.
- Parameters:
associateProductWithPortfolioRequest
-- Returns:
- A Java Future containing the result of the AssociateProductWithPortfolio operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- ResourceNotFoundException The specified resource was not found.
- LimitExceededException The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.
- 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.
- See Also:
-
associateProductWithPortfolio
default CompletableFuture<AssociateProductWithPortfolioResponse> associateProductWithPortfolio(Consumer<AssociateProductWithPortfolioRequest.Builder> associateProductWithPortfolioRequest) Associates the specified product with the specified portfolio.
A delegated admin is authorized to invoke this command.
This is a convenience which creates an instance of the
AssociateProductWithPortfolioRequest.Builder
avoiding the need to create one manually viaAssociateProductWithPortfolioRequest.builder()
- Parameters:
associateProductWithPortfolioRequest
- AConsumer
that will call methods onAssociateProductWithPortfolioRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AssociateProductWithPortfolio operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- ResourceNotFoundException The specified resource was not found.
- LimitExceededException The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.
- 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.
- See Also:
-
associateServiceActionWithProvisioningArtifact
default CompletableFuture<AssociateServiceActionWithProvisioningArtifactResponse> associateServiceActionWithProvisioningArtifact(AssociateServiceActionWithProvisioningArtifactRequest associateServiceActionWithProvisioningArtifactRequest) Associates a self-service action with a provisioning artifact.
- Parameters:
associateServiceActionWithProvisioningArtifactRequest
-- Returns:
- A Java Future containing the result of the AssociateServiceActionWithProvisioningArtifact operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- DuplicateResourceException The specified resource is a duplicate.
- LimitExceededException The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
associateServiceActionWithProvisioningArtifact
default CompletableFuture<AssociateServiceActionWithProvisioningArtifactResponse> associateServiceActionWithProvisioningArtifact(Consumer<AssociateServiceActionWithProvisioningArtifactRequest.Builder> associateServiceActionWithProvisioningArtifactRequest) Associates a self-service action with a provisioning artifact.
This is a convenience which creates an instance of the
AssociateServiceActionWithProvisioningArtifactRequest.Builder
avoiding the need to create one manually viaAssociateServiceActionWithProvisioningArtifactRequest.builder()
- Parameters:
associateServiceActionWithProvisioningArtifactRequest
- AConsumer
that will call methods onAssociateServiceActionWithProvisioningArtifactRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AssociateServiceActionWithProvisioningArtifact operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- DuplicateResourceException The specified resource is a duplicate.
- LimitExceededException The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
associateTagOptionWithResource
default CompletableFuture<AssociateTagOptionWithResourceResponse> associateTagOptionWithResource(AssociateTagOptionWithResourceRequest associateTagOptionWithResourceRequest) Associate the specified TagOption with the specified portfolio or product.
- Parameters:
associateTagOptionWithResourceRequest
-- Returns:
- A Java Future containing the result of the AssociateTagOptionWithResource operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TagOptionNotMigratedException An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.
- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- LimitExceededException The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.
- DuplicateResourceException The specified resource is a duplicate.
- InvalidStateException An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.
- 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.
- See Also:
-
associateTagOptionWithResource
default CompletableFuture<AssociateTagOptionWithResourceResponse> associateTagOptionWithResource(Consumer<AssociateTagOptionWithResourceRequest.Builder> associateTagOptionWithResourceRequest) Associate the specified TagOption with the specified portfolio or product.
This is a convenience which creates an instance of the
AssociateTagOptionWithResourceRequest.Builder
avoiding the need to create one manually viaAssociateTagOptionWithResourceRequest.builder()
- Parameters:
associateTagOptionWithResourceRequest
- AConsumer
that will call methods onAssociateTagOptionWithResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AssociateTagOptionWithResource operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TagOptionNotMigratedException An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.
- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- LimitExceededException The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.
- DuplicateResourceException The specified resource is a duplicate.
- InvalidStateException An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.
- 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.
- See Also:
-
batchAssociateServiceActionWithProvisioningArtifact
default CompletableFuture<BatchAssociateServiceActionWithProvisioningArtifactResponse> batchAssociateServiceActionWithProvisioningArtifact(BatchAssociateServiceActionWithProvisioningArtifactRequest batchAssociateServiceActionWithProvisioningArtifactRequest) Associates multiple self-service actions with provisioning artifacts.
- Parameters:
batchAssociateServiceActionWithProvisioningArtifactRequest
-- Returns:
- A Java Future containing the result of the BatchAssociateServiceActionWithProvisioningArtifact operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
batchAssociateServiceActionWithProvisioningArtifact
default CompletableFuture<BatchAssociateServiceActionWithProvisioningArtifactResponse> batchAssociateServiceActionWithProvisioningArtifact(Consumer<BatchAssociateServiceActionWithProvisioningArtifactRequest.Builder> batchAssociateServiceActionWithProvisioningArtifactRequest) Associates multiple self-service actions with provisioning artifacts.
This is a convenience which creates an instance of the
BatchAssociateServiceActionWithProvisioningArtifactRequest.Builder
avoiding the need to create one manually viaBatchAssociateServiceActionWithProvisioningArtifactRequest.builder()
- Parameters:
batchAssociateServiceActionWithProvisioningArtifactRequest
- AConsumer
that will call methods onBatchAssociateServiceActionWithProvisioningArtifactRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchAssociateServiceActionWithProvisioningArtifact operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
batchDisassociateServiceActionFromProvisioningArtifact
default CompletableFuture<BatchDisassociateServiceActionFromProvisioningArtifactResponse> batchDisassociateServiceActionFromProvisioningArtifact(BatchDisassociateServiceActionFromProvisioningArtifactRequest batchDisassociateServiceActionFromProvisioningArtifactRequest) Disassociates a batch of self-service actions from the specified provisioning artifact.
- Parameters:
batchDisassociateServiceActionFromProvisioningArtifactRequest
-- Returns:
- A Java Future containing the result of the BatchDisassociateServiceActionFromProvisioningArtifact
operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
batchDisassociateServiceActionFromProvisioningArtifact
default CompletableFuture<BatchDisassociateServiceActionFromProvisioningArtifactResponse> batchDisassociateServiceActionFromProvisioningArtifact(Consumer<BatchDisassociateServiceActionFromProvisioningArtifactRequest.Builder> batchDisassociateServiceActionFromProvisioningArtifactRequest) Disassociates a batch of self-service actions from the specified provisioning artifact.
This is a convenience which creates an instance of the
BatchDisassociateServiceActionFromProvisioningArtifactRequest.Builder
avoiding the need to create one manually viaBatchDisassociateServiceActionFromProvisioningArtifactRequest.builder()
- Parameters:
batchDisassociateServiceActionFromProvisioningArtifactRequest
- AConsumer
that will call methods onBatchDisassociateServiceActionFromProvisioningArtifactRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchDisassociateServiceActionFromProvisioningArtifact
operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
copyProduct
Copies the specified source product to the specified target product or a new product.
You can copy a product to the same account or another account. You can copy a product to the same Region or another Region. If you copy a product to another account, you must first share the product in a portfolio using CreatePortfolioShare.
This operation is performed asynchronously. To track the progress of the operation, use DescribeCopyProductStatus.
- Parameters:
copyProductRequest
-- Returns:
- A Java Future containing the result of the CopyProduct operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
copyProduct
default CompletableFuture<CopyProductResponse> copyProduct(Consumer<CopyProductRequest.Builder> copyProductRequest) Copies the specified source product to the specified target product or a new product.
You can copy a product to the same account or another account. You can copy a product to the same Region or another Region. If you copy a product to another account, you must first share the product in a portfolio using CreatePortfolioShare.
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 viaCopyProductRequest.builder()
- Parameters:
copyProductRequest
- AConsumer
that will call methods onCopyProductRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CopyProduct operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
createConstraint
default CompletableFuture<CreateConstraintResponse> createConstraint(CreateConstraintRequest createConstraintRequest) Creates a constraint.
A delegated admin is authorized to invoke this command.
- Parameters:
createConstraintRequest
-- Returns:
- A Java Future containing the result of the CreateConstraint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- LimitExceededException The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.
- DuplicateResourceException The specified resource is a duplicate.
- 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.
- See Also:
-
createConstraint
default CompletableFuture<CreateConstraintResponse> createConstraint(Consumer<CreateConstraintRequest.Builder> createConstraintRequest) Creates a constraint.
A delegated admin is authorized to invoke this command.
This is a convenience which creates an instance of the
CreateConstraintRequest.Builder
avoiding the need to create one manually viaCreateConstraintRequest.builder()
- Parameters:
createConstraintRequest
- AConsumer
that will call methods onCreateConstraintRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateConstraint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- LimitExceededException The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.
- DuplicateResourceException The specified resource is a duplicate.
- 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.
- See Also:
-
createPortfolio
default CompletableFuture<CreatePortfolioResponse> createPortfolio(CreatePortfolioRequest createPortfolioRequest) Creates a portfolio.
A delegated admin is authorized to invoke this command.
- Parameters:
createPortfolioRequest
-- Returns:
- A Java Future containing the result of the CreatePortfolio operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- LimitExceededException The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.
- TagOptionNotMigratedException An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management 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.
- See Also:
-
createPortfolio
default CompletableFuture<CreatePortfolioResponse> createPortfolio(Consumer<CreatePortfolioRequest.Builder> createPortfolioRequest) Creates a portfolio.
A delegated admin is authorized to invoke this command.
This is a convenience which creates an instance of the
CreatePortfolioRequest.Builder
avoiding the need to create one manually viaCreatePortfolioRequest.builder()
- Parameters:
createPortfolioRequest
- AConsumer
that will call methods onCreatePortfolioRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreatePortfolio operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- LimitExceededException The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.
- TagOptionNotMigratedException An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management 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.
- See Also:
-
createProduct
default CompletableFuture<CreateProductResponse> createProduct(CreateProductRequest createProductRequest) Creates a product.
A delegated admin is authorized to invoke this command.
The user or role that performs this operation must have the
cloudformation:GetTemplate
IAM policy permission. This policy permission is required when using theImportFromPhysicalId
template source in the information data section.- Parameters:
createProductRequest
-- Returns:
- A Java Future containing the result of the CreateProduct operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- LimitExceededException The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.
- TagOptionNotMigratedException An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management 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.
- See Also:
-
createProduct
default CompletableFuture<CreateProductResponse> createProduct(Consumer<CreateProductRequest.Builder> createProductRequest) Creates a product.
A delegated admin is authorized to invoke this command.
The user or role that performs this operation must have the
cloudformation:GetTemplate
IAM policy permission. This policy permission is required when using theImportFromPhysicalId
template source in the information data section.
This is a convenience which creates an instance of the
CreateProductRequest.Builder
avoiding the need to create one manually viaCreateProductRequest.builder()
- Parameters:
createProductRequest
- AConsumer
that will call methods onCreateProductRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateProduct operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- LimitExceededException The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.
- TagOptionNotMigratedException An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management 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.
- See Also:
-
createProvisionedProductPlan
default CompletableFuture<CreateProvisionedProductPlanResponse> createProvisionedProductPlan(CreateProvisionedProductPlanRequest createProvisionedProductPlanRequest) Creates a plan.
A plan includes the list of resources to be created (when provisioning a new product) or modified (when updating a provisioned product) when the plan is executed.
You can create one plan for each provisioned product. To create a plan for an existing provisioned product, the product status must be AVAILABLE or TAINTED.
To view the resource changes in the change set, use DescribeProvisionedProductPlan. To create or modify the provisioned product, use ExecuteProvisionedProductPlan.
- Parameters:
createProvisionedProductPlanRequest
-- Returns:
- A Java Future containing the result of the CreateProvisionedProductPlan operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- ResourceNotFoundException The specified resource was not found.
- InvalidStateException An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.
- 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.
- See Also:
-
createProvisionedProductPlan
default CompletableFuture<CreateProvisionedProductPlanResponse> createProvisionedProductPlan(Consumer<CreateProvisionedProductPlanRequest.Builder> createProvisionedProductPlanRequest) Creates a plan.
A plan includes the list of resources to be created (when provisioning a new product) or modified (when updating a provisioned product) when the plan is executed.
You can create one plan for each provisioned product. To create a plan for an existing provisioned product, the product status must be AVAILABLE or TAINTED.
To view the resource changes in the change set, use DescribeProvisionedProductPlan. To create or modify the provisioned product, use ExecuteProvisionedProductPlan.
This is a convenience which creates an instance of the
CreateProvisionedProductPlanRequest.Builder
avoiding the need to create one manually viaCreateProvisionedProductPlanRequest.builder()
- Parameters:
createProvisionedProductPlanRequest
- AConsumer
that will call methods onCreateProvisionedProductPlanRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateProvisionedProductPlan operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- ResourceNotFoundException The specified resource was not found.
- InvalidStateException An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.
- 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.
- See Also:
-
createProvisioningArtifact
default CompletableFuture<CreateProvisioningArtifactResponse> createProvisioningArtifact(CreateProvisioningArtifactRequest createProvisioningArtifactRequest) Creates a provisioning artifact (also known as a version) for the specified product.
You cannot create a provisioning artifact for a product that was shared with you.
The user or role that performs this operation must have the
cloudformation:GetTemplate
IAM policy permission. This policy permission is required when using theImportFromPhysicalId
template source in the information data section.- Parameters:
createProvisioningArtifactRequest
-- Returns:
- A Java Future containing the result of the CreateProvisioningArtifact operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- LimitExceededException The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.
- 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.
- See Also:
-
createProvisioningArtifact
default CompletableFuture<CreateProvisioningArtifactResponse> createProvisioningArtifact(Consumer<CreateProvisioningArtifactRequest.Builder> createProvisioningArtifactRequest) Creates a provisioning artifact (also known as a version) for the specified product.
You cannot create a provisioning artifact for a product that was shared with you.
The user or role that performs this operation must have the
cloudformation:GetTemplate
IAM policy permission. This policy permission is required when using theImportFromPhysicalId
template source in the information data section.
This is a convenience which creates an instance of the
CreateProvisioningArtifactRequest.Builder
avoiding the need to create one manually viaCreateProvisioningArtifactRequest.builder()
- Parameters:
createProvisioningArtifactRequest
- AConsumer
that will call methods onCreateProvisioningArtifactRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateProvisioningArtifact operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- LimitExceededException The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.
- 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.
- See Also:
-
createServiceAction
default CompletableFuture<CreateServiceActionResponse> createServiceAction(CreateServiceActionRequest createServiceActionRequest) Creates a self-service action.
- Parameters:
createServiceActionRequest
-- Returns:
- A Java Future containing the result of the CreateServiceAction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- LimitExceededException The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.
- 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.
- See Also:
-
createServiceAction
default CompletableFuture<CreateServiceActionResponse> createServiceAction(Consumer<CreateServiceActionRequest.Builder> createServiceActionRequest) Creates a self-service action.
This is a convenience which creates an instance of the
CreateServiceActionRequest.Builder
avoiding the need to create one manually viaCreateServiceActionRequest.builder()
- Parameters:
createServiceActionRequest
- AConsumer
that will call methods onCreateServiceActionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateServiceAction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- LimitExceededException The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.
- 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.
- See Also:
-
createTagOption
default CompletableFuture<CreateTagOptionResponse> createTagOption(CreateTagOptionRequest createTagOptionRequest) Creates a TagOption.
- Parameters:
createTagOptionRequest
-- Returns:
- A Java Future containing the result of the CreateTagOption operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TagOptionNotMigratedException An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.
- DuplicateResourceException The specified resource is a duplicate.
- LimitExceededException The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.
- 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.
- See Also:
-
createTagOption
default CompletableFuture<CreateTagOptionResponse> createTagOption(Consumer<CreateTagOptionRequest.Builder> createTagOptionRequest) Creates a TagOption.
This is a convenience which creates an instance of the
CreateTagOptionRequest.Builder
avoiding the need to create one manually viaCreateTagOptionRequest.builder()
- Parameters:
createTagOptionRequest
- AConsumer
that will call methods onCreateTagOptionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateTagOption operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TagOptionNotMigratedException An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.
- DuplicateResourceException The specified resource is a duplicate.
- LimitExceededException The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.
- 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.
- See Also:
-
deleteConstraint
default CompletableFuture<DeleteConstraintResponse> deleteConstraint(DeleteConstraintRequest deleteConstraintRequest) Deletes the specified constraint.
A delegated admin is authorized to invoke this command.
- Parameters:
deleteConstraintRequest
-- Returns:
- A Java Future containing the result of the DeleteConstraint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
deleteConstraint
default CompletableFuture<DeleteConstraintResponse> deleteConstraint(Consumer<DeleteConstraintRequest.Builder> deleteConstraintRequest) Deletes the specified constraint.
A delegated admin is authorized to invoke this command.
This is a convenience which creates an instance of the
DeleteConstraintRequest.Builder
avoiding the need to create one manually viaDeleteConstraintRequest.builder()
- Parameters:
deleteConstraintRequest
- AConsumer
that will call methods onDeleteConstraintRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteConstraint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
deletePortfolio
default CompletableFuture<DeletePortfolioResponse> deletePortfolio(DeletePortfolioRequest deletePortfolioRequest) Deletes the specified portfolio.
You cannot delete a portfolio if it was shared with you or if it has associated products, users, constraints, or shared accounts.
A delegated admin is authorized to invoke this command.
- Parameters:
deletePortfolioRequest
-- Returns:
- A Java Future containing the result of the DeletePortfolio operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- ResourceInUseException A resource that is currently in use. Ensure that the resource is not in use and retry the operation.
- TagOptionNotMigratedException An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management 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.
- See Also:
-
deletePortfolio
default CompletableFuture<DeletePortfolioResponse> deletePortfolio(Consumer<DeletePortfolioRequest.Builder> deletePortfolioRequest) Deletes the specified portfolio.
You cannot delete a portfolio if it was shared with you or if it has associated products, users, constraints, or shared accounts.
A delegated admin is authorized to invoke this command.
This is a convenience which creates an instance of the
DeletePortfolioRequest.Builder
avoiding the need to create one manually viaDeletePortfolioRequest.builder()
- Parameters:
deletePortfolioRequest
- AConsumer
that will call methods onDeletePortfolioRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeletePortfolio operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- ResourceInUseException A resource that is currently in use. Ensure that the resource is not in use and retry the operation.
- TagOptionNotMigratedException An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management 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.
- See Also:
-
deleteProduct
default CompletableFuture<DeleteProductResponse> deleteProduct(DeleteProductRequest deleteProductRequest) Deletes the specified product.
You cannot delete a product if it was shared with you or is associated with a portfolio.
A delegated admin is authorized to invoke this command.
- Parameters:
deleteProductRequest
-- Returns:
- A Java Future containing the result of the DeleteProduct operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ResourceInUseException A resource that is currently in use. Ensure that the resource is not in use and retry the operation.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- TagOptionNotMigratedException An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management 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.
- See Also:
-
deleteProduct
default CompletableFuture<DeleteProductResponse> deleteProduct(Consumer<DeleteProductRequest.Builder> deleteProductRequest) Deletes the specified product.
You cannot delete a product if it was shared with you or is associated with a portfolio.
A delegated admin is authorized to invoke this command.
This is a convenience which creates an instance of the
DeleteProductRequest.Builder
avoiding the need to create one manually viaDeleteProductRequest.builder()
- Parameters:
deleteProductRequest
- AConsumer
that will call methods onDeleteProductRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteProduct operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ResourceInUseException A resource that is currently in use. Ensure that the resource is not in use and retry the operation.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- TagOptionNotMigratedException An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management 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.
- See Also:
-
deleteProvisionedProductPlan
default CompletableFuture<DeleteProvisionedProductPlanResponse> deleteProvisionedProductPlan(DeleteProvisionedProductPlanRequest deleteProvisionedProductPlanRequest) Deletes the specified plan.
- Parameters:
deleteProvisionedProductPlanRequest
-- Returns:
- A Java Future containing the result of the DeleteProvisionedProductPlan operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
deleteProvisionedProductPlan
default CompletableFuture<DeleteProvisionedProductPlanResponse> deleteProvisionedProductPlan(Consumer<DeleteProvisionedProductPlanRequest.Builder> deleteProvisionedProductPlanRequest) Deletes the specified plan.
This is a convenience which creates an instance of the
DeleteProvisionedProductPlanRequest.Builder
avoiding the need to create one manually viaDeleteProvisionedProductPlanRequest.builder()
- Parameters:
deleteProvisionedProductPlanRequest
- AConsumer
that will call methods onDeleteProvisionedProductPlanRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteProvisionedProductPlan operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
deleteProvisioningArtifact
default CompletableFuture<DeleteProvisioningArtifactResponse> deleteProvisioningArtifact(DeleteProvisioningArtifactRequest deleteProvisioningArtifactRequest) Deletes the specified provisioning artifact (also known as a version) for the specified product.
You cannot delete a provisioning artifact associated with a product that was shared with you. You cannot delete the last provisioning artifact for a product, because a product must have at least one provisioning artifact.
- Parameters:
deleteProvisioningArtifactRequest
-- Returns:
- A Java Future containing the result of the DeleteProvisioningArtifact operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ResourceInUseException A resource that is currently in use. Ensure that the resource is not in use and retry the operation.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
deleteProvisioningArtifact
default CompletableFuture<DeleteProvisioningArtifactResponse> deleteProvisioningArtifact(Consumer<DeleteProvisioningArtifactRequest.Builder> deleteProvisioningArtifactRequest) Deletes the specified provisioning artifact (also known as a version) for the specified product.
You cannot delete a provisioning artifact associated with a product that was shared with you. You cannot delete the last provisioning artifact for a product, because a product must have at least one provisioning artifact.
This is a convenience which creates an instance of the
DeleteProvisioningArtifactRequest.Builder
avoiding the need to create one manually viaDeleteProvisioningArtifactRequest.builder()
- Parameters:
deleteProvisioningArtifactRequest
- AConsumer
that will call methods onDeleteProvisioningArtifactRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteProvisioningArtifact operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ResourceInUseException A resource that is currently in use. Ensure that the resource is not in use and retry the operation.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
deleteServiceAction
default CompletableFuture<DeleteServiceActionResponse> deleteServiceAction(DeleteServiceActionRequest deleteServiceActionRequest) Deletes a self-service action.
- Parameters:
deleteServiceActionRequest
-- Returns:
- A Java Future containing the result of the DeleteServiceAction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ResourceInUseException A resource that is currently in use. Ensure that the resource is not in use and retry the operation.
- 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.
- See Also:
-
deleteServiceAction
default CompletableFuture<DeleteServiceActionResponse> deleteServiceAction(Consumer<DeleteServiceActionRequest.Builder> deleteServiceActionRequest) Deletes a self-service action.
This is a convenience which creates an instance of the
DeleteServiceActionRequest.Builder
avoiding the need to create one manually viaDeleteServiceActionRequest.builder()
- Parameters:
deleteServiceActionRequest
- AConsumer
that will call methods onDeleteServiceActionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteServiceAction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ResourceInUseException A resource that is currently in use. Ensure that the resource is not in use and retry the operation.
- 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.
- See Also:
-
deleteTagOption
default CompletableFuture<DeleteTagOptionResponse> deleteTagOption(DeleteTagOptionRequest deleteTagOptionRequest) Deletes the specified TagOption.
You cannot delete a TagOption if it is associated with a product or portfolio.
- Parameters:
deleteTagOptionRequest
-- Returns:
- A Java Future containing the result of the DeleteTagOption operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TagOptionNotMigratedException An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.
- ResourceInUseException A resource that is currently in use. Ensure that the resource is not in use and retry the operation.
- ResourceNotFoundException The specified resource was not found.
- 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.
- See Also:
-
deleteTagOption
default CompletableFuture<DeleteTagOptionResponse> deleteTagOption(Consumer<DeleteTagOptionRequest.Builder> deleteTagOptionRequest) Deletes the specified TagOption.
You cannot delete a TagOption if it is associated with a product or portfolio.
This is a convenience which creates an instance of the
DeleteTagOptionRequest.Builder
avoiding the need to create one manually viaDeleteTagOptionRequest.builder()
- Parameters:
deleteTagOptionRequest
- AConsumer
that will call methods onDeleteTagOptionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteTagOption operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TagOptionNotMigratedException An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.
- ResourceInUseException A resource that is currently in use. Ensure that the resource is not in use and retry the operation.
- ResourceNotFoundException The specified resource was not found.
- 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.
- See Also:
-
describeConstraint
default CompletableFuture<DescribeConstraintResponse> describeConstraint(DescribeConstraintRequest describeConstraintRequest) Gets information about the specified constraint.
- Parameters:
describeConstraintRequest
-- Returns:
- A Java Future containing the result of the DescribeConstraint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeConstraint
default CompletableFuture<DescribeConstraintResponse> describeConstraint(Consumer<DescribeConstraintRequest.Builder> describeConstraintRequest) Gets information about the specified constraint.
This is a convenience which creates an instance of the
DescribeConstraintRequest.Builder
avoiding the need to create one manually viaDescribeConstraintRequest.builder()
- Parameters:
describeConstraintRequest
- AConsumer
that will call methods onDescribeConstraintRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeConstraint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeCopyProductStatus
default CompletableFuture<DescribeCopyProductStatusResponse> describeCopyProductStatus(DescribeCopyProductStatusRequest describeCopyProductStatusRequest) Gets the status of the specified copy product operation.
- Parameters:
describeCopyProductStatusRequest
-- Returns:
- A Java Future containing the result of the DescribeCopyProductStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeCopyProductStatus
default CompletableFuture<DescribeCopyProductStatusResponse> describeCopyProductStatus(Consumer<DescribeCopyProductStatusRequest.Builder> describeCopyProductStatusRequest) Gets 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 viaDescribeCopyProductStatusRequest.builder()
- Parameters:
describeCopyProductStatusRequest
- AConsumer
that will call methods onDescribeCopyProductStatusRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeCopyProductStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describePortfolio
default CompletableFuture<DescribePortfolioResponse> describePortfolio(DescribePortfolioRequest describePortfolioRequest) Gets information about the specified portfolio.
A delegated admin is authorized to invoke this command.
- Parameters:
describePortfolioRequest
-- Returns:
- A Java Future containing the result of the DescribePortfolio operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describePortfolio
default CompletableFuture<DescribePortfolioResponse> describePortfolio(Consumer<DescribePortfolioRequest.Builder> describePortfolioRequest) Gets information about the specified portfolio.
A delegated admin is authorized to invoke this command.
This is a convenience which creates an instance of the
DescribePortfolioRequest.Builder
avoiding the need to create one manually viaDescribePortfolioRequest.builder()
- Parameters:
describePortfolioRequest
- AConsumer
that will call methods onDescribePortfolioRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribePortfolio operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeProduct
default CompletableFuture<DescribeProductResponse> describeProduct(DescribeProductRequest describeProductRequest) Gets information about the specified product.
Running this operation with administrator access results in a failure. DescribeProductAsAdmin should be used instead.
- Parameters:
describeProductRequest
-- Returns:
- A Java Future containing the result of the DescribeProduct operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
describeProduct
default CompletableFuture<DescribeProductResponse> describeProduct(Consumer<DescribeProductRequest.Builder> describeProductRequest) Gets information about the specified product.
Running this operation with administrator access results in a failure. DescribeProductAsAdmin should be used instead.
This is a convenience which creates an instance of the
DescribeProductRequest.Builder
avoiding the need to create one manually viaDescribeProductRequest.builder()
- Parameters:
describeProductRequest
- AConsumer
that will call methods onDescribeProductRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeProduct operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
describeProductAsAdmin
default CompletableFuture<DescribeProductAsAdminResponse> describeProductAsAdmin(DescribeProductAsAdminRequest describeProductAsAdminRequest) Gets information about the specified product. This operation is run with administrator access.
- Parameters:
describeProductAsAdminRequest
-- Returns:
- A Java Future containing the result of the DescribeProductAsAdmin operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
describeProductAsAdmin
default CompletableFuture<DescribeProductAsAdminResponse> describeProductAsAdmin(Consumer<DescribeProductAsAdminRequest.Builder> describeProductAsAdminRequest) Gets information about the specified product. This operation is run with administrator access.
This is a convenience which creates an instance of the
DescribeProductAsAdminRequest.Builder
avoiding the need to create one manually viaDescribeProductAsAdminRequest.builder()
- Parameters:
describeProductAsAdminRequest
- AConsumer
that will call methods onDescribeProductAsAdminRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeProductAsAdmin operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
describeProductView
default CompletableFuture<DescribeProductViewResponse> describeProductView(DescribeProductViewRequest describeProductViewRequest) Gets information about the specified product.
- Parameters:
describeProductViewRequest
-- Returns:
- A Java Future containing the result of the DescribeProductView operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
describeProductView
default CompletableFuture<DescribeProductViewResponse> describeProductView(Consumer<DescribeProductViewRequest.Builder> describeProductViewRequest) Gets information about the specified product.
This is a convenience which creates an instance of the
DescribeProductViewRequest.Builder
avoiding the need to create one manually viaDescribeProductViewRequest.builder()
- Parameters:
describeProductViewRequest
- AConsumer
that will call methods onDescribeProductViewRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeProductView operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
describeProvisionedProduct
default CompletableFuture<DescribeProvisionedProductResponse> describeProvisionedProduct(DescribeProvisionedProductRequest describeProvisionedProductRequest) Gets information about the specified provisioned product.
- Parameters:
describeProvisionedProductRequest
- DescribeProvisionedProductAPI input structure. AcceptLanguage - [Optional] The language code for localization. Id - [Optional] The provisioned product identifier. Name - [Optional] Another provisioned product identifier. Customers must provide either Id or Name.- Returns:
- A Java Future containing the result of the DescribeProvisionedProduct operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
describeProvisionedProduct
default CompletableFuture<DescribeProvisionedProductResponse> describeProvisionedProduct(Consumer<DescribeProvisionedProductRequest.Builder> describeProvisionedProductRequest) Gets information about the specified provisioned product.
This is a convenience which creates an instance of the
DescribeProvisionedProductRequest.Builder
avoiding the need to create one manually viaDescribeProvisionedProductRequest.builder()
- Parameters:
describeProvisionedProductRequest
- AConsumer
that will call methods onDescribeProvisionedProductRequest.Builder
to create a request. DescribeProvisionedProductAPI input structure. AcceptLanguage - [Optional] The language code for localization. Id - [Optional] The provisioned product identifier. Name - [Optional] Another provisioned product identifier. Customers must provide either Id or Name.- Returns:
- A Java Future containing the result of the DescribeProvisionedProduct operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
describeProvisionedProductPlan
default CompletableFuture<DescribeProvisionedProductPlanResponse> describeProvisionedProductPlan(DescribeProvisionedProductPlanRequest describeProvisionedProductPlanRequest) Gets information about the resource changes for the specified plan.
- Parameters:
describeProvisionedProductPlanRequest
-- Returns:
- A Java Future containing the result of the DescribeProvisionedProductPlan operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
describeProvisionedProductPlan
default CompletableFuture<DescribeProvisionedProductPlanResponse> describeProvisionedProductPlan(Consumer<DescribeProvisionedProductPlanRequest.Builder> describeProvisionedProductPlanRequest) Gets information about the resource changes for the specified plan.
This is a convenience which creates an instance of the
DescribeProvisionedProductPlanRequest.Builder
avoiding the need to create one manually viaDescribeProvisionedProductPlanRequest.builder()
- Parameters:
describeProvisionedProductPlanRequest
- AConsumer
that will call methods onDescribeProvisionedProductPlanRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeProvisionedProductPlan operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
describeProvisioningArtifact
default CompletableFuture<DescribeProvisioningArtifactResponse> describeProvisioningArtifact(DescribeProvisioningArtifactRequest describeProvisioningArtifactRequest) Gets information about the specified provisioning artifact (also known as a version) for the specified product.
- Parameters:
describeProvisioningArtifactRequest
-- Returns:
- A Java Future containing the result of the DescribeProvisioningArtifact operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
describeProvisioningArtifact
default CompletableFuture<DescribeProvisioningArtifactResponse> describeProvisioningArtifact(Consumer<DescribeProvisioningArtifactRequest.Builder> describeProvisioningArtifactRequest) Gets information about the specified provisioning artifact (also known as a version) for the specified product.
This is a convenience which creates an instance of the
DescribeProvisioningArtifactRequest.Builder
avoiding the need to create one manually viaDescribeProvisioningArtifactRequest.builder()
- Parameters:
describeProvisioningArtifactRequest
- AConsumer
that will call methods onDescribeProvisioningArtifactRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeProvisioningArtifact operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
describeProvisioningParameters
default CompletableFuture<DescribeProvisioningParametersResponse> describeProvisioningParameters(DescribeProvisioningParametersRequest describeProvisioningParametersRequest) Gets information about the configuration required to provision the specified product using the specified provisioning artifact.
If the output contains a TagOption key with an empty list of values, there is a TagOption conflict for that key. The end user cannot take action to fix the conflict, and launch is not blocked. In subsequent calls to ProvisionProduct, do not include conflicted TagOption keys as tags, or this causes the error "Parameter validation failed: Missing required parameter in Tags[N]:Value". Tag the provisioned product with the value
sc-tagoption-conflict-portfolioId-productId
.- Parameters:
describeProvisioningParametersRequest
-- Returns:
- A Java Future containing the result of the DescribeProvisioningParameters operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
describeProvisioningParameters
default CompletableFuture<DescribeProvisioningParametersResponse> describeProvisioningParameters(Consumer<DescribeProvisioningParametersRequest.Builder> describeProvisioningParametersRequest) Gets information about the configuration required to provision the specified product using the specified provisioning artifact.
If the output contains a TagOption key with an empty list of values, there is a TagOption conflict for that key. The end user cannot take action to fix the conflict, and launch is not blocked. In subsequent calls to ProvisionProduct, do not include conflicted TagOption keys as tags, or this causes the error "Parameter validation failed: Missing required parameter in Tags[N]:Value". Tag the provisioned product with the value
sc-tagoption-conflict-portfolioId-productId
.
This is a convenience which creates an instance of the
DescribeProvisioningParametersRequest.Builder
avoiding the need to create one manually viaDescribeProvisioningParametersRequest.builder()
- Parameters:
describeProvisioningParametersRequest
- AConsumer
that will call methods onDescribeProvisioningParametersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeProvisioningParameters operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
describeRecord
default CompletableFuture<DescribeRecordResponse> describeRecord(DescribeRecordRequest describeRecordRequest) Gets information about the specified request operation.
Use this operation after calling a request operation (for example, ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct).
If a provisioned product was transferred to a new owner using UpdateProvisionedProductProperties, the new owner will be able to describe all past records for that product. The previous owner will no longer be able to describe the records, but will be able to use ListRecordHistory to see the product's history from when he was the owner.
- Parameters:
describeRecordRequest
-- Returns:
- A Java Future containing the result of the DescribeRecord operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeRecord
default CompletableFuture<DescribeRecordResponse> describeRecord(Consumer<DescribeRecordRequest.Builder> describeRecordRequest) Gets information about the specified request operation.
Use this operation after calling a request operation (for example, ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct).
If a provisioned product was transferred to a new owner using UpdateProvisionedProductProperties, the new owner will be able to describe all past records for that product. The previous owner will no longer be able to describe the records, but will be able to use ListRecordHistory to see the product's history from when he was the owner.
This is a convenience which creates an instance of the
DescribeRecordRequest.Builder
avoiding the need to create one manually viaDescribeRecordRequest.builder()
- Parameters:
describeRecordRequest
- AConsumer
that will call methods onDescribeRecordRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeRecord operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeServiceAction
default CompletableFuture<DescribeServiceActionResponse> describeServiceAction(DescribeServiceActionRequest describeServiceActionRequest) Describes a self-service action.
- Parameters:
describeServiceActionRequest
-- Returns:
- A Java Future containing the result of the DescribeServiceAction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeServiceAction
default CompletableFuture<DescribeServiceActionResponse> describeServiceAction(Consumer<DescribeServiceActionRequest.Builder> describeServiceActionRequest) Describes a self-service action.
This is a convenience which creates an instance of the
DescribeServiceActionRequest.Builder
avoiding the need to create one manually viaDescribeServiceActionRequest.builder()
- Parameters:
describeServiceActionRequest
- AConsumer
that will call methods onDescribeServiceActionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeServiceAction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeServiceActionExecutionParameters
default CompletableFuture<DescribeServiceActionExecutionParametersResponse> describeServiceActionExecutionParameters(DescribeServiceActionExecutionParametersRequest describeServiceActionExecutionParametersRequest) Finds the default parameters for a specific self-service action on a specific provisioned product and returns a map of the results to the user.
- Parameters:
describeServiceActionExecutionParametersRequest
-- Returns:
- A Java Future containing the result of the DescribeServiceActionExecutionParameters operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
describeServiceActionExecutionParameters
default CompletableFuture<DescribeServiceActionExecutionParametersResponse> describeServiceActionExecutionParameters(Consumer<DescribeServiceActionExecutionParametersRequest.Builder> describeServiceActionExecutionParametersRequest) Finds the default parameters for a specific self-service action on a specific provisioned product and returns a map of the results to the user.
This is a convenience which creates an instance of the
DescribeServiceActionExecutionParametersRequest.Builder
avoiding the need to create one manually viaDescribeServiceActionExecutionParametersRequest.builder()
- Parameters:
describeServiceActionExecutionParametersRequest
- AConsumer
that will call methods onDescribeServiceActionExecutionParametersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeServiceActionExecutionParameters operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
describeTagOption
default CompletableFuture<DescribeTagOptionResponse> describeTagOption(DescribeTagOptionRequest describeTagOptionRequest) Gets information about the specified TagOption.
- Parameters:
describeTagOptionRequest
-- Returns:
- A Java Future containing the result of the DescribeTagOption operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TagOptionNotMigratedException An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management 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.
- See Also:
-
describeTagOption
default CompletableFuture<DescribeTagOptionResponse> describeTagOption(Consumer<DescribeTagOptionRequest.Builder> describeTagOptionRequest) Gets information about the specified TagOption.
This is a convenience which creates an instance of the
DescribeTagOptionRequest.Builder
avoiding the need to create one manually viaDescribeTagOptionRequest.builder()
- Parameters:
describeTagOptionRequest
- AConsumer
that will call methods onDescribeTagOptionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeTagOption operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TagOptionNotMigratedException An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management 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.
- See Also:
-
disableAWSOrganizationsAccess
default CompletableFuture<DisableAwsOrganizationsAccessResponse> disableAWSOrganizationsAccess(DisableAwsOrganizationsAccessRequest disableAwsOrganizationsAccessRequest) Disable portfolio sharing through the Organizations service. This command will not delete your current shares, but prevents you from creating new shares throughout your organization. Current shares are not kept in sync with your organization structure if the structure changes after calling this API. Only the management account in the organization can call this API.
You cannot call this API if there are active delegated administrators in the organization.
Note that a delegated administrator is not authorized to invoke
DisableAWSOrganizationsAccess
.If you share an Service Catalog portfolio in an organization within Organizations, and then disable Organizations access for Service Catalog, the portfolio access permissions will not sync with the latest changes to the organization structure. Specifically, accounts that you removed from the organization after disabling Service Catalog access will retain access to the previously shared portfolio.
- Parameters:
disableAwsOrganizationsAccessRequest
-- Returns:
- A Java Future containing the result of the DisableAWSOrganizationsAccess operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidStateException An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.
- OperationNotSupportedException The operation is not supported.
- 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.
- See Also:
-
disableAWSOrganizationsAccess
default CompletableFuture<DisableAwsOrganizationsAccessResponse> disableAWSOrganizationsAccess(Consumer<DisableAwsOrganizationsAccessRequest.Builder> disableAwsOrganizationsAccessRequest) Disable portfolio sharing through the Organizations service. This command will not delete your current shares, but prevents you from creating new shares throughout your organization. Current shares are not kept in sync with your organization structure if the structure changes after calling this API. Only the management account in the organization can call this API.
You cannot call this API if there are active delegated administrators in the organization.
Note that a delegated administrator is not authorized to invoke
DisableAWSOrganizationsAccess
.If you share an Service Catalog portfolio in an organization within Organizations, and then disable Organizations access for Service Catalog, the portfolio access permissions will not sync with the latest changes to the organization structure. Specifically, accounts that you removed from the organization after disabling Service Catalog access will retain access to the previously shared portfolio.
This is a convenience which creates an instance of the
DisableAwsOrganizationsAccessRequest.Builder
avoiding the need to create one manually viaDisableAwsOrganizationsAccessRequest.builder()
- Parameters:
disableAwsOrganizationsAccessRequest
- AConsumer
that will call methods onDisableAwsOrganizationsAccessRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisableAWSOrganizationsAccess operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidStateException An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.
- OperationNotSupportedException The operation is not supported.
- 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.
- See Also:
-
disassociateBudgetFromResource
default CompletableFuture<DisassociateBudgetFromResourceResponse> disassociateBudgetFromResource(DisassociateBudgetFromResourceRequest disassociateBudgetFromResourceRequest) Disassociates the specified budget from the specified resource.
- Parameters:
disassociateBudgetFromResourceRequest
-- Returns:
- A Java Future containing the result of the DisassociateBudgetFromResource operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
disassociateBudgetFromResource
default CompletableFuture<DisassociateBudgetFromResourceResponse> disassociateBudgetFromResource(Consumer<DisassociateBudgetFromResourceRequest.Builder> disassociateBudgetFromResourceRequest) Disassociates the specified budget from the specified resource.
This is a convenience which creates an instance of the
DisassociateBudgetFromResourceRequest.Builder
avoiding the need to create one manually viaDisassociateBudgetFromResourceRequest.builder()
- Parameters:
disassociateBudgetFromResourceRequest
- AConsumer
that will call methods onDisassociateBudgetFromResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisassociateBudgetFromResource operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
disassociatePrincipalFromPortfolio
default CompletableFuture<DisassociatePrincipalFromPortfolioResponse> disassociatePrincipalFromPortfolio(DisassociatePrincipalFromPortfolioRequest disassociatePrincipalFromPortfolioRequest) Disassociates a previously associated principal ARN from a specified portfolio.
The
PrincipalType
andPrincipalARN
must match theAssociatePrincipalWithPortfolio
call request details. For example, to disassociate an association created with aPrincipalARN
ofPrincipalType
IAM you must use thePrincipalType
IAM when callingDisassociatePrincipalFromPortfolio
.For portfolios that have been shared with principal name sharing enabled: after disassociating a principal, share recipient accounts will no longer be able to provision products in this portfolio using a role matching the name of the associated principal.
For more information, review associate-principal-with-portfolio in the Amazon Web Services CLI Command Reference.
If you disassociate a principal from a portfolio, with PrincipalType as
IAM
, the same principal will still have access to the portfolio if it matches one of the associated principals of typeIAM_PATTERN
. To fully remove access for a principal, verify all the associated Principals of typeIAM_PATTERN
, and then ensure you disassociate anyIAM_PATTERN
principals that match the principal whose access you are removing.- Parameters:
disassociatePrincipalFromPortfolioRequest
-- Returns:
- A Java Future containing the result of the DisassociatePrincipalFromPortfolio operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
disassociatePrincipalFromPortfolio
default CompletableFuture<DisassociatePrincipalFromPortfolioResponse> disassociatePrincipalFromPortfolio(Consumer<DisassociatePrincipalFromPortfolioRequest.Builder> disassociatePrincipalFromPortfolioRequest) Disassociates a previously associated principal ARN from a specified portfolio.
The
PrincipalType
andPrincipalARN
must match theAssociatePrincipalWithPortfolio
call request details. For example, to disassociate an association created with aPrincipalARN
ofPrincipalType
IAM you must use thePrincipalType
IAM when callingDisassociatePrincipalFromPortfolio
.For portfolios that have been shared with principal name sharing enabled: after disassociating a principal, share recipient accounts will no longer be able to provision products in this portfolio using a role matching the name of the associated principal.
For more information, review associate-principal-with-portfolio in the Amazon Web Services CLI Command Reference.
If you disassociate a principal from a portfolio, with PrincipalType as
IAM
, the same principal will still have access to the portfolio if it matches one of the associated principals of typeIAM_PATTERN
. To fully remove access for a principal, verify all the associated Principals of typeIAM_PATTERN
, and then ensure you disassociate anyIAM_PATTERN
principals that match the principal whose access you are removing.
This is a convenience which creates an instance of the
DisassociatePrincipalFromPortfolioRequest.Builder
avoiding the need to create one manually viaDisassociatePrincipalFromPortfolioRequest.builder()
- Parameters:
disassociatePrincipalFromPortfolioRequest
- AConsumer
that will call methods onDisassociatePrincipalFromPortfolioRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisassociatePrincipalFromPortfolio operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
disassociateProductFromPortfolio
default CompletableFuture<DisassociateProductFromPortfolioResponse> disassociateProductFromPortfolio(DisassociateProductFromPortfolioRequest disassociateProductFromPortfolioRequest) Disassociates the specified product from the specified portfolio.
A delegated admin is authorized to invoke this command.
- Parameters:
disassociateProductFromPortfolioRequest
-- Returns:
- A Java Future containing the result of the DisassociateProductFromPortfolio operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ResourceInUseException A resource that is currently in use. Ensure that the resource is not in use and retry the operation.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
disassociateProductFromPortfolio
default CompletableFuture<DisassociateProductFromPortfolioResponse> disassociateProductFromPortfolio(Consumer<DisassociateProductFromPortfolioRequest.Builder> disassociateProductFromPortfolioRequest) Disassociates the specified product from the specified portfolio.
A delegated admin is authorized to invoke this command.
This is a convenience which creates an instance of the
DisassociateProductFromPortfolioRequest.Builder
avoiding the need to create one manually viaDisassociateProductFromPortfolioRequest.builder()
- Parameters:
disassociateProductFromPortfolioRequest
- AConsumer
that will call methods onDisassociateProductFromPortfolioRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisassociateProductFromPortfolio operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ResourceInUseException A resource that is currently in use. Ensure that the resource is not in use and retry the operation.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
disassociateServiceActionFromProvisioningArtifact
default CompletableFuture<DisassociateServiceActionFromProvisioningArtifactResponse> disassociateServiceActionFromProvisioningArtifact(DisassociateServiceActionFromProvisioningArtifactRequest disassociateServiceActionFromProvisioningArtifactRequest) Disassociates the specified self-service action association from the specified provisioning artifact.
- Parameters:
disassociateServiceActionFromProvisioningArtifactRequest
-- Returns:
- A Java Future containing the result of the DisassociateServiceActionFromProvisioningArtifact operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
disassociateServiceActionFromProvisioningArtifact
default CompletableFuture<DisassociateServiceActionFromProvisioningArtifactResponse> disassociateServiceActionFromProvisioningArtifact(Consumer<DisassociateServiceActionFromProvisioningArtifactRequest.Builder> disassociateServiceActionFromProvisioningArtifactRequest) Disassociates the specified self-service action association from the specified provisioning artifact.
This is a convenience which creates an instance of the
DisassociateServiceActionFromProvisioningArtifactRequest.Builder
avoiding the need to create one manually viaDisassociateServiceActionFromProvisioningArtifactRequest.builder()
- Parameters:
disassociateServiceActionFromProvisioningArtifactRequest
- AConsumer
that will call methods onDisassociateServiceActionFromProvisioningArtifactRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisassociateServiceActionFromProvisioningArtifact operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
disassociateTagOptionFromResource
default CompletableFuture<DisassociateTagOptionFromResourceResponse> disassociateTagOptionFromResource(DisassociateTagOptionFromResourceRequest disassociateTagOptionFromResourceRequest) Disassociates the specified TagOption from the specified resource.
- Parameters:
disassociateTagOptionFromResourceRequest
-- Returns:
- A Java Future containing the result of the DisassociateTagOptionFromResource operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TagOptionNotMigratedException An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management 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.
- See Also:
-
disassociateTagOptionFromResource
default CompletableFuture<DisassociateTagOptionFromResourceResponse> disassociateTagOptionFromResource(Consumer<DisassociateTagOptionFromResourceRequest.Builder> disassociateTagOptionFromResourceRequest) Disassociates the specified TagOption from the specified resource.
This is a convenience which creates an instance of the
DisassociateTagOptionFromResourceRequest.Builder
avoiding the need to create one manually viaDisassociateTagOptionFromResourceRequest.builder()
- Parameters:
disassociateTagOptionFromResourceRequest
- AConsumer
that will call methods onDisassociateTagOptionFromResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisassociateTagOptionFromResource operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TagOptionNotMigratedException An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management 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.
- See Also:
-
enableAWSOrganizationsAccess
default CompletableFuture<EnableAwsOrganizationsAccessResponse> enableAWSOrganizationsAccess(EnableAwsOrganizationsAccessRequest enableAwsOrganizationsAccessRequest) Enable portfolio sharing feature through Organizations. This API will allow Service Catalog to receive updates on your organization in order to sync your shares with the current structure. This API can only be called by the management account in the organization.
When you call this API, Service Catalog calls
organizations:EnableAWSServiceAccess
on your behalf so that your shares stay in sync with any changes in your Organizations structure.Note that a delegated administrator is not authorized to invoke
EnableAWSOrganizationsAccess
.If you have previously disabled Organizations access for Service Catalog, and then enable access again, the portfolio access permissions might not sync with the latest changes to the organization structure. Specifically, accounts that you removed from the organization after disabling Service Catalog access, and before you enabled access again, can retain access to the previously shared portfolio. As a result, an account that has been removed from the organization might still be able to create or manage Amazon Web Services resources when it is no longer authorized to do so. Amazon Web Services is working to resolve this issue.
- Parameters:
enableAwsOrganizationsAccessRequest
-- Returns:
- A Java Future containing the result of the EnableAWSOrganizationsAccess operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidStateException An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.
- OperationNotSupportedException The operation is not supported.
- 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.
- See Also:
-
enableAWSOrganizationsAccess
default CompletableFuture<EnableAwsOrganizationsAccessResponse> enableAWSOrganizationsAccess(Consumer<EnableAwsOrganizationsAccessRequest.Builder> enableAwsOrganizationsAccessRequest) Enable portfolio sharing feature through Organizations. This API will allow Service Catalog to receive updates on your organization in order to sync your shares with the current structure. This API can only be called by the management account in the organization.
When you call this API, Service Catalog calls
organizations:EnableAWSServiceAccess
on your behalf so that your shares stay in sync with any changes in your Organizations structure.Note that a delegated administrator is not authorized to invoke
EnableAWSOrganizationsAccess
.If you have previously disabled Organizations access for Service Catalog, and then enable access again, the portfolio access permissions might not sync with the latest changes to the organization structure. Specifically, accounts that you removed from the organization after disabling Service Catalog access, and before you enabled access again, can retain access to the previously shared portfolio. As a result, an account that has been removed from the organization might still be able to create or manage Amazon Web Services resources when it is no longer authorized to do so. Amazon Web Services is working to resolve this issue.
This is a convenience which creates an instance of the
EnableAwsOrganizationsAccessRequest.Builder
avoiding the need to create one manually viaEnableAwsOrganizationsAccessRequest.builder()
- Parameters:
enableAwsOrganizationsAccessRequest
- AConsumer
that will call methods onEnableAwsOrganizationsAccessRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the EnableAWSOrganizationsAccess operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidStateException An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.
- OperationNotSupportedException The operation is not supported.
- 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.
- See Also:
-
executeProvisionedProductPlan
default CompletableFuture<ExecuteProvisionedProductPlanResponse> executeProvisionedProductPlan(ExecuteProvisionedProductPlanRequest executeProvisionedProductPlanRequest) Provisions or modifies a product based on the resource changes for the specified plan.
- Parameters:
executeProvisionedProductPlanRequest
-- Returns:
- A Java Future containing the result of the ExecuteProvisionedProductPlan operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- ResourceNotFoundException The specified resource was not found.
- InvalidStateException An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.
- 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.
- See Also:
-
executeProvisionedProductPlan
default CompletableFuture<ExecuteProvisionedProductPlanResponse> executeProvisionedProductPlan(Consumer<ExecuteProvisionedProductPlanRequest.Builder> executeProvisionedProductPlanRequest) Provisions or modifies a product based on the resource changes for the specified plan.
This is a convenience which creates an instance of the
ExecuteProvisionedProductPlanRequest.Builder
avoiding the need to create one manually viaExecuteProvisionedProductPlanRequest.builder()
- Parameters:
executeProvisionedProductPlanRequest
- AConsumer
that will call methods onExecuteProvisionedProductPlanRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ExecuteProvisionedProductPlan operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- ResourceNotFoundException The specified resource was not found.
- InvalidStateException An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.
- 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.
- See Also:
-
executeProvisionedProductServiceAction
default CompletableFuture<ExecuteProvisionedProductServiceActionResponse> executeProvisionedProductServiceAction(ExecuteProvisionedProductServiceActionRequest executeProvisionedProductServiceActionRequest) Executes a self-service action against a provisioned product.
- Parameters:
executeProvisionedProductServiceActionRequest
-- Returns:
- A Java Future containing the result of the ExecuteProvisionedProductServiceAction operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- ResourceNotFoundException The specified resource was not found.
- InvalidStateException An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.
- 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.
- See Also:
-
executeProvisionedProductServiceAction
default CompletableFuture<ExecuteProvisionedProductServiceActionResponse> executeProvisionedProductServiceAction(Consumer<ExecuteProvisionedProductServiceActionRequest.Builder> executeProvisionedProductServiceActionRequest) Executes a self-service action against a provisioned product.
This is a convenience which creates an instance of the
ExecuteProvisionedProductServiceActionRequest.Builder
avoiding the need to create one manually viaExecuteProvisionedProductServiceActionRequest.builder()
- Parameters:
executeProvisionedProductServiceActionRequest
- AConsumer
that will call methods onExecuteProvisionedProductServiceActionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ExecuteProvisionedProductServiceAction operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- ResourceNotFoundException The specified resource was not found.
- InvalidStateException An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.
- 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.
- See Also:
-
getAWSOrganizationsAccessStatus
default CompletableFuture<GetAwsOrganizationsAccessStatusResponse> getAWSOrganizationsAccessStatus(GetAwsOrganizationsAccessStatusRequest getAwsOrganizationsAccessStatusRequest) Get the Access Status for Organizations portfolio share feature. This API can only be called by the management account in the organization or by a delegated admin.
- Parameters:
getAwsOrganizationsAccessStatusRequest
-- Returns:
- A Java Future containing the result of the GetAWSOrganizationsAccessStatus operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- OperationNotSupportedException The operation is not supported.
- 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.
- See Also:
-
getAWSOrganizationsAccessStatus
default CompletableFuture<GetAwsOrganizationsAccessStatusResponse> getAWSOrganizationsAccessStatus(Consumer<GetAwsOrganizationsAccessStatusRequest.Builder> getAwsOrganizationsAccessStatusRequest) Get the Access Status for Organizations portfolio share feature. This API can only be called by the management account in the organization or by a delegated admin.
This is a convenience which creates an instance of the
GetAwsOrganizationsAccessStatusRequest.Builder
avoiding the need to create one manually viaGetAwsOrganizationsAccessStatusRequest.builder()
- Parameters:
getAwsOrganizationsAccessStatusRequest
- AConsumer
that will call methods onGetAwsOrganizationsAccessStatusRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetAWSOrganizationsAccessStatus operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- OperationNotSupportedException The operation is not supported.
- 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.
- See Also:
-
getAWSOrganizationsAccessStatus
default CompletableFuture<GetAwsOrganizationsAccessStatusResponse> getAWSOrganizationsAccessStatus()Get the Access Status for Organizations portfolio share feature. This API can only be called by the management account in the organization or by a delegated admin.
- Returns:
- A Java Future containing the result of the GetAWSOrganizationsAccessStatus operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- OperationNotSupportedException The operation is not supported.
- 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.
- See Also:
-
getProvisionedProductOutputs
default CompletableFuture<GetProvisionedProductOutputsResponse> getProvisionedProductOutputs(GetProvisionedProductOutputsRequest getProvisionedProductOutputsRequest) This API takes either a
ProvisonedProductId
or aProvisionedProductName
, along with a list of one or more output keys, and responds with the key/value pairs of those outputs.- Parameters:
getProvisionedProductOutputsRequest
-- Returns:
- A Java Future containing the result of the GetProvisionedProductOutputs operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
getProvisionedProductOutputs
default CompletableFuture<GetProvisionedProductOutputsResponse> getProvisionedProductOutputs(Consumer<GetProvisionedProductOutputsRequest.Builder> getProvisionedProductOutputsRequest) This API takes either a
ProvisonedProductId
or aProvisionedProductName
, along with a list of one or more output keys, and responds with the key/value pairs of those outputs.
This is a convenience which creates an instance of the
GetProvisionedProductOutputsRequest.Builder
avoiding the need to create one manually viaGetProvisionedProductOutputsRequest.builder()
- Parameters:
getProvisionedProductOutputsRequest
- AConsumer
that will call methods onGetProvisionedProductOutputsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetProvisionedProductOutputs operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
getProvisionedProductOutputsPaginator
default GetProvisionedProductOutputsPublisher getProvisionedProductOutputsPaginator(GetProvisionedProductOutputsRequest getProvisionedProductOutputsRequest) This is a variant of
getProvisionedProductOutputs(software.amazon.awssdk.services.servicecatalog.model.GetProvisionedProductOutputsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.servicecatalog.paginators.GetProvisionedProductOutputsPublisher publisher = client.getProvisionedProductOutputsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.servicecatalog.paginators.GetProvisionedProductOutputsPublisher publisher = client.getProvisionedProductOutputsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicecatalog.model.GetProvisionedProductOutputsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.servicecatalog.model.GetProvisionedProductOutputsResponse response) { //... }; });
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getProvisionedProductOutputs(software.amazon.awssdk.services.servicecatalog.model.GetProvisionedProductOutputsRequest)
operation.- Parameters:
getProvisionedProductOutputsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
getProvisionedProductOutputsPaginator
default GetProvisionedProductOutputsPublisher getProvisionedProductOutputsPaginator(Consumer<GetProvisionedProductOutputsRequest.Builder> getProvisionedProductOutputsRequest) This is a variant of
getProvisionedProductOutputs(software.amazon.awssdk.services.servicecatalog.model.GetProvisionedProductOutputsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.servicecatalog.paginators.GetProvisionedProductOutputsPublisher publisher = client.getProvisionedProductOutputsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.servicecatalog.paginators.GetProvisionedProductOutputsPublisher publisher = client.getProvisionedProductOutputsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicecatalog.model.GetProvisionedProductOutputsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.servicecatalog.model.GetProvisionedProductOutputsResponse response) { //... }; });
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getProvisionedProductOutputs(software.amazon.awssdk.services.servicecatalog.model.GetProvisionedProductOutputsRequest)
operation.
This is a convenience which creates an instance of the
GetProvisionedProductOutputsRequest.Builder
avoiding the need to create one manually viaGetProvisionedProductOutputsRequest.builder()
- Parameters:
getProvisionedProductOutputsRequest
- AConsumer
that will call methods onGetProvisionedProductOutputsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
importAsProvisionedProduct
default CompletableFuture<ImportAsProvisionedProductResponse> importAsProvisionedProduct(ImportAsProvisionedProductRequest importAsProvisionedProductRequest) Requests the import of a resource as an Service Catalog provisioned product that is associated to an Service Catalog product and provisioning artifact. Once imported, all supported governance actions are supported on the provisioned product.
Resource import only supports CloudFormation stack ARNs. CloudFormation StackSets, and non-root nested stacks, are not supported.
The CloudFormation stack must have one of the following statuses to be imported:
CREATE_COMPLETE
,UPDATE_COMPLETE
,UPDATE_ROLLBACK_COMPLETE
,IMPORT_COMPLETE
, andIMPORT_ROLLBACK_COMPLETE
.Import of the resource requires that the CloudFormation stack template matches the associated Service Catalog product provisioning artifact.
When you import an existing CloudFormation stack into a portfolio, Service Catalog does not apply the product's associated constraints during the import process. Service Catalog applies the constraints after you call
UpdateProvisionedProduct
for the provisioned product.The user or role that performs this operation must have the
cloudformation:GetTemplate
andcloudformation:DescribeStacks
IAM policy permissions.You can only import one provisioned product at a time. The product's CloudFormation stack must have the
IMPORT_COMPLETE
status before you import another.- Parameters:
importAsProvisionedProductRequest
-- Returns:
- A Java Future containing the result of the ImportAsProvisionedProduct operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DuplicateResourceException The specified resource is a duplicate.
- InvalidStateException An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.
- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
importAsProvisionedProduct
default CompletableFuture<ImportAsProvisionedProductResponse> importAsProvisionedProduct(Consumer<ImportAsProvisionedProductRequest.Builder> importAsProvisionedProductRequest) Requests the import of a resource as an Service Catalog provisioned product that is associated to an Service Catalog product and provisioning artifact. Once imported, all supported governance actions are supported on the provisioned product.
Resource import only supports CloudFormation stack ARNs. CloudFormation StackSets, and non-root nested stacks, are not supported.
The CloudFormation stack must have one of the following statuses to be imported:
CREATE_COMPLETE
,UPDATE_COMPLETE
,UPDATE_ROLLBACK_COMPLETE
,IMPORT_COMPLETE
, andIMPORT_ROLLBACK_COMPLETE
.Import of the resource requires that the CloudFormation stack template matches the associated Service Catalog product provisioning artifact.
When you import an existing CloudFormation stack into a portfolio, Service Catalog does not apply the product's associated constraints during the import process. Service Catalog applies the constraints after you call
UpdateProvisionedProduct
for the provisioned product.The user or role that performs this operation must have the
cloudformation:GetTemplate
andcloudformation:DescribeStacks
IAM policy permissions.You can only import one provisioned product at a time. The product's CloudFormation stack must have the
IMPORT_COMPLETE
status before you import another.
This is a convenience which creates an instance of the
ImportAsProvisionedProductRequest.Builder
avoiding the need to create one manually viaImportAsProvisionedProductRequest.builder()
- Parameters:
importAsProvisionedProductRequest
- AConsumer
that will call methods onImportAsProvisionedProductRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ImportAsProvisionedProduct operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DuplicateResourceException The specified resource is a duplicate.
- InvalidStateException An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.
- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listBudgetsForResource
default CompletableFuture<ListBudgetsForResourceResponse> listBudgetsForResource(ListBudgetsForResourceRequest listBudgetsForResourceRequest) Lists all the budgets associated to the specified resource.
- Parameters:
listBudgetsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListBudgetsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listBudgetsForResource
default CompletableFuture<ListBudgetsForResourceResponse> listBudgetsForResource(Consumer<ListBudgetsForResourceRequest.Builder> listBudgetsForResourceRequest) Lists all the budgets associated to the specified resource.
This is a convenience which creates an instance of the
ListBudgetsForResourceRequest.Builder
avoiding the need to create one manually viaListBudgetsForResourceRequest.builder()
- Parameters:
listBudgetsForResourceRequest
- AConsumer
that will call methods onListBudgetsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListBudgetsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listBudgetsForResourcePaginator
default ListBudgetsForResourcePublisher listBudgetsForResourcePaginator(ListBudgetsForResourceRequest listBudgetsForResourceRequest) This is a variant of
listBudgetsForResource(software.amazon.awssdk.services.servicecatalog.model.ListBudgetsForResourceRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.servicecatalog.paginators.ListBudgetsForResourcePublisher publisher = client.listBudgetsForResourcePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.servicecatalog.paginators.ListBudgetsForResourcePublisher publisher = client.listBudgetsForResourcePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicecatalog.model.ListBudgetsForResourceResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.servicecatalog.model.ListBudgetsForResourceResponse response) { //... }; });
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBudgetsForResource(software.amazon.awssdk.services.servicecatalog.model.ListBudgetsForResourceRequest)
operation.- Parameters:
listBudgetsForResourceRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listBudgetsForResourcePaginator
default ListBudgetsForResourcePublisher listBudgetsForResourcePaginator(Consumer<ListBudgetsForResourceRequest.Builder> listBudgetsForResourceRequest) This is a variant of
listBudgetsForResource(software.amazon.awssdk.services.servicecatalog.model.ListBudgetsForResourceRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.servicecatalog.paginators.ListBudgetsForResourcePublisher publisher = client.listBudgetsForResourcePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.servicecatalog.paginators.ListBudgetsForResourcePublisher publisher = client.listBudgetsForResourcePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicecatalog.model.ListBudgetsForResourceResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.servicecatalog.model.ListBudgetsForResourceResponse response) { //... }; });
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBudgetsForResource(software.amazon.awssdk.services.servicecatalog.model.ListBudgetsForResourceRequest)
operation.
This is a convenience which creates an instance of the
ListBudgetsForResourceRequest.Builder
avoiding the need to create one manually viaListBudgetsForResourceRequest.builder()
- Parameters:
listBudgetsForResourceRequest
- AConsumer
that will call methods onListBudgetsForResourceRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listConstraintsForPortfolio
default CompletableFuture<ListConstraintsForPortfolioResponse> listConstraintsForPortfolio(ListConstraintsForPortfolioRequest listConstraintsForPortfolioRequest) Lists the constraints for the specified portfolio and product.
- Parameters:
listConstraintsForPortfolioRequest
-- Returns:
- A Java Future containing the result of the ListConstraintsForPortfolio operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listConstraintsForPortfolio
default CompletableFuture<ListConstraintsForPortfolioResponse> listConstraintsForPortfolio(Consumer<ListConstraintsForPortfolioRequest.Builder> listConstraintsForPortfolioRequest) Lists the constraints 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 viaListConstraintsForPortfolioRequest.builder()
- Parameters:
listConstraintsForPortfolioRequest
- AConsumer
that will call methods onListConstraintsForPortfolioRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListConstraintsForPortfolio operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listConstraintsForPortfolioPaginator
default ListConstraintsForPortfolioPublisher listConstraintsForPortfolioPaginator(ListConstraintsForPortfolioRequest listConstraintsForPortfolioRequest) This is a variant of
listConstraintsForPortfolio(software.amazon.awssdk.services.servicecatalog.model.ListConstraintsForPortfolioRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.servicecatalog.paginators.ListConstraintsForPortfolioPublisher publisher = client.listConstraintsForPortfolioPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.servicecatalog.paginators.ListConstraintsForPortfolioPublisher publisher = client.listConstraintsForPortfolioPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicecatalog.model.ListConstraintsForPortfolioResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.servicecatalog.model.ListConstraintsForPortfolioResponse response) { //... }; });
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listConstraintsForPortfolio(software.amazon.awssdk.services.servicecatalog.model.ListConstraintsForPortfolioRequest)
operation.- Parameters:
listConstraintsForPortfolioRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listConstraintsForPortfolioPaginator
default ListConstraintsForPortfolioPublisher listConstraintsForPortfolioPaginator(Consumer<ListConstraintsForPortfolioRequest.Builder> listConstraintsForPortfolioRequest) This is a variant of
listConstraintsForPortfolio(software.amazon.awssdk.services.servicecatalog.model.ListConstraintsForPortfolioRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.servicecatalog.paginators.ListConstraintsForPortfolioPublisher publisher = client.listConstraintsForPortfolioPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.servicecatalog.paginators.ListConstraintsForPortfolioPublisher publisher = client.listConstraintsForPortfolioPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicecatalog.model.ListConstraintsForPortfolioResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.servicecatalog.model.ListConstraintsForPortfolioResponse response) { //... }; });
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 viaListConstraintsForPortfolioRequest.builder()
- Parameters:
listConstraintsForPortfolioRequest
- AConsumer
that will call methods onListConstraintsForPortfolioRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listLaunchPaths
default CompletableFuture<ListLaunchPathsResponse> listLaunchPaths(ListLaunchPathsRequest listLaunchPathsRequest) Lists the paths to the specified product. A path describes how the user gets access to a specified product and is necessary when provisioning a product. A path also determines the constraints that are put on a product. A path is dependent on a specific product, porfolio, and principal.
When provisioning a product that's been added to a portfolio, you must grant your user, group, or role access to the portfolio. For more information, see Granting users access in the Service Catalog User Guide.
- Parameters:
listLaunchPathsRequest
-- Returns:
- A Java Future containing the result of the ListLaunchPaths operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listLaunchPaths
default CompletableFuture<ListLaunchPathsResponse> listLaunchPaths(Consumer<ListLaunchPathsRequest.Builder> listLaunchPathsRequest) Lists the paths to the specified product. A path describes how the user gets access to a specified product and is necessary when provisioning a product. A path also determines the constraints that are put on a product. A path is dependent on a specific product, porfolio, and principal.
When provisioning a product that's been added to a portfolio, you must grant your user, group, or role access to the portfolio. For more information, see Granting users access in the Service Catalog User Guide.
This is a convenience which creates an instance of the
ListLaunchPathsRequest.Builder
avoiding the need to create one manually viaListLaunchPathsRequest.builder()
- Parameters:
listLaunchPathsRequest
- AConsumer
that will call methods onListLaunchPathsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListLaunchPaths operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listLaunchPathsPaginator
default ListLaunchPathsPublisher listLaunchPathsPaginator(ListLaunchPathsRequest listLaunchPathsRequest) This is a variant of
listLaunchPaths(software.amazon.awssdk.services.servicecatalog.model.ListLaunchPathsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.servicecatalog.paginators.ListLaunchPathsPublisher publisher = client.listLaunchPathsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.servicecatalog.paginators.ListLaunchPathsPublisher publisher = client.listLaunchPathsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicecatalog.model.ListLaunchPathsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.servicecatalog.model.ListLaunchPathsResponse response) { //... }; });
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listLaunchPaths(software.amazon.awssdk.services.servicecatalog.model.ListLaunchPathsRequest)
operation.- Parameters:
listLaunchPathsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listLaunchPathsPaginator
default ListLaunchPathsPublisher listLaunchPathsPaginator(Consumer<ListLaunchPathsRequest.Builder> listLaunchPathsRequest) This is a variant of
listLaunchPaths(software.amazon.awssdk.services.servicecatalog.model.ListLaunchPathsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.servicecatalog.paginators.ListLaunchPathsPublisher publisher = client.listLaunchPathsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.servicecatalog.paginators.ListLaunchPathsPublisher publisher = client.listLaunchPathsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicecatalog.model.ListLaunchPathsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.servicecatalog.model.ListLaunchPathsResponse response) { //... }; });
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 viaListLaunchPathsRequest.builder()
- Parameters:
listLaunchPathsRequest
- AConsumer
that will call methods onListLaunchPathsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listOrganizationPortfolioAccess
default CompletableFuture<ListOrganizationPortfolioAccessResponse> listOrganizationPortfolioAccess(ListOrganizationPortfolioAccessRequest listOrganizationPortfolioAccessRequest) Lists the organization nodes that have access to the specified portfolio. This API can only be called by the management account in the organization or by a delegated admin.
If a delegated admin is de-registered, they can no longer perform this operation.
- Parameters:
listOrganizationPortfolioAccessRequest
-- Returns:
- A Java Future containing the result of the ListOrganizationPortfolioAccess operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- OperationNotSupportedException The operation is not supported.
- 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.
- See Also:
-
listOrganizationPortfolioAccess
default CompletableFuture<ListOrganizationPortfolioAccessResponse> listOrganizationPortfolioAccess(Consumer<ListOrganizationPortfolioAccessRequest.Builder> listOrganizationPortfolioAccessRequest) Lists the organization nodes that have access to the specified portfolio. This API can only be called by the management account in the organization or by a delegated admin.
If a delegated admin is de-registered, they can no longer perform this operation.
This is a convenience which creates an instance of the
ListOrganizationPortfolioAccessRequest.Builder
avoiding the need to create one manually viaListOrganizationPortfolioAccessRequest.builder()
- Parameters:
listOrganizationPortfolioAccessRequest
- AConsumer
that will call methods onListOrganizationPortfolioAccessRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListOrganizationPortfolioAccess operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- OperationNotSupportedException The operation is not supported.
- 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.
- See Also:
-
listOrganizationPortfolioAccessPaginator
default ListOrganizationPortfolioAccessPublisher listOrganizationPortfolioAccessPaginator(ListOrganizationPortfolioAccessRequest listOrganizationPortfolioAccessRequest) This is a variant of
listOrganizationPortfolioAccess(software.amazon.awssdk.services.servicecatalog.model.ListOrganizationPortfolioAccessRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.servicecatalog.paginators.ListOrganizationPortfolioAccessPublisher publisher = client.listOrganizationPortfolioAccessPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.servicecatalog.paginators.ListOrganizationPortfolioAccessPublisher publisher = client.listOrganizationPortfolioAccessPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicecatalog.model.ListOrganizationPortfolioAccessResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.servicecatalog.model.ListOrganizationPortfolioAccessResponse response) { //... }; });
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listOrganizationPortfolioAccess(software.amazon.awssdk.services.servicecatalog.model.ListOrganizationPortfolioAccessRequest)
operation.- Parameters:
listOrganizationPortfolioAccessRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- OperationNotSupportedException The operation is not supported.
- 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.
- See Also:
-
listOrganizationPortfolioAccessPaginator
default ListOrganizationPortfolioAccessPublisher listOrganizationPortfolioAccessPaginator(Consumer<ListOrganizationPortfolioAccessRequest.Builder> listOrganizationPortfolioAccessRequest) This is a variant of
listOrganizationPortfolioAccess(software.amazon.awssdk.services.servicecatalog.model.ListOrganizationPortfolioAccessRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.servicecatalog.paginators.ListOrganizationPortfolioAccessPublisher publisher = client.listOrganizationPortfolioAccessPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.servicecatalog.paginators.ListOrganizationPortfolioAccessPublisher publisher = client.listOrganizationPortfolioAccessPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicecatalog.model.ListOrganizationPortfolioAccessResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.servicecatalog.model.ListOrganizationPortfolioAccessResponse response) { //... }; });
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listOrganizationPortfolioAccess(software.amazon.awssdk.services.servicecatalog.model.ListOrganizationPortfolioAccessRequest)
operation.
This is a convenience which creates an instance of the
ListOrganizationPortfolioAccessRequest.Builder
avoiding the need to create one manually viaListOrganizationPortfolioAccessRequest.builder()
- Parameters:
listOrganizationPortfolioAccessRequest
- AConsumer
that will call methods onListOrganizationPortfolioAccessRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- OperationNotSupportedException The operation is not supported.
- 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.
- See Also:
-
listPortfolioAccess
default CompletableFuture<ListPortfolioAccessResponse> listPortfolioAccess(ListPortfolioAccessRequest listPortfolioAccessRequest) Lists the account IDs that have access to the specified portfolio.
A delegated admin can list the accounts that have access to the shared portfolio. Note that if a delegated admin is de-registered, they can no longer perform this operation.
- Parameters:
listPortfolioAccessRequest
-- Returns:
- A Java Future containing the result of the ListPortfolioAccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listPortfolioAccess
default CompletableFuture<ListPortfolioAccessResponse> listPortfolioAccess(Consumer<ListPortfolioAccessRequest.Builder> listPortfolioAccessRequest) Lists the account IDs that have access to the specified portfolio.
A delegated admin can list the accounts that have access to the shared portfolio. Note that if a delegated admin is de-registered, they can no longer perform this operation.
This is a convenience which creates an instance of the
ListPortfolioAccessRequest.Builder
avoiding the need to create one manually viaListPortfolioAccessRequest.builder()
- Parameters:
listPortfolioAccessRequest
- AConsumer
that will call methods onListPortfolioAccessRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListPortfolioAccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listPortfolioAccessPaginator
default ListPortfolioAccessPublisher listPortfolioAccessPaginator(ListPortfolioAccessRequest listPortfolioAccessRequest) This is a variant of
listPortfolioAccess(software.amazon.awssdk.services.servicecatalog.model.ListPortfolioAccessRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.servicecatalog.paginators.ListPortfolioAccessPublisher publisher = client.listPortfolioAccessPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.servicecatalog.paginators.ListPortfolioAccessPublisher publisher = client.listPortfolioAccessPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicecatalog.model.ListPortfolioAccessResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.servicecatalog.model.ListPortfolioAccessResponse response) { //... }; });
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPortfolioAccess(software.amazon.awssdk.services.servicecatalog.model.ListPortfolioAccessRequest)
operation.- Parameters:
listPortfolioAccessRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listPortfolioAccessPaginator
default ListPortfolioAccessPublisher listPortfolioAccessPaginator(Consumer<ListPortfolioAccessRequest.Builder> listPortfolioAccessRequest) This is a variant of
listPortfolioAccess(software.amazon.awssdk.services.servicecatalog.model.ListPortfolioAccessRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.servicecatalog.paginators.ListPortfolioAccessPublisher publisher = client.listPortfolioAccessPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.servicecatalog.paginators.ListPortfolioAccessPublisher publisher = client.listPortfolioAccessPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicecatalog.model.ListPortfolioAccessResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.servicecatalog.model.ListPortfolioAccessResponse response) { //... }; });
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPortfolioAccess(software.amazon.awssdk.services.servicecatalog.model.ListPortfolioAccessRequest)
operation.
This is a convenience which creates an instance of the
ListPortfolioAccessRequest.Builder
avoiding the need to create one manually viaListPortfolioAccessRequest.builder()
- Parameters:
listPortfolioAccessRequest
- AConsumer
that will call methods onListPortfolioAccessRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listPortfolios
default CompletableFuture<ListPortfoliosResponse> listPortfolios(ListPortfoliosRequest listPortfoliosRequest) Lists all portfolios in the catalog.
- Parameters:
listPortfoliosRequest
-- Returns:
- A Java Future containing the result of the ListPortfolios operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listPortfolios
default CompletableFuture<ListPortfoliosResponse> listPortfolios(Consumer<ListPortfoliosRequest.Builder> listPortfoliosRequest) 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 viaListPortfoliosRequest.builder()
- Parameters:
listPortfoliosRequest
- AConsumer
that will call methods onListPortfoliosRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListPortfolios operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listPortfolios
Lists all portfolios in the catalog.
- Returns:
- A Java Future containing the result of the ListPortfolios operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listPortfoliosForProduct
default CompletableFuture<ListPortfoliosForProductResponse> listPortfoliosForProduct(ListPortfoliosForProductRequest listPortfoliosForProductRequest) Lists all portfolios that the specified product is associated with.
- Parameters:
listPortfoliosForProductRequest
-- Returns:
- A Java Future containing the result of the ListPortfoliosForProduct operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listPortfoliosForProduct
default CompletableFuture<ListPortfoliosForProductResponse> listPortfoliosForProduct(Consumer<ListPortfoliosForProductRequest.Builder> listPortfoliosForProductRequest) 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 viaListPortfoliosForProductRequest.builder()
- Parameters:
listPortfoliosForProductRequest
- AConsumer
that will call methods onListPortfoliosForProductRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListPortfoliosForProduct operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listPortfoliosForProductPaginator
default ListPortfoliosForProductPublisher listPortfoliosForProductPaginator(ListPortfoliosForProductRequest listPortfoliosForProductRequest) This is a variant of
listPortfoliosForProduct(software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosForProductRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.servicecatalog.paginators.ListPortfoliosForProductPublisher publisher = client.listPortfoliosForProductPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.servicecatalog.paginators.ListPortfoliosForProductPublisher publisher = client.listPortfoliosForProductPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosForProductResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosForProductResponse response) { //... }; });
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPortfoliosForProduct(software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosForProductRequest)
operation.- Parameters:
listPortfoliosForProductRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listPortfoliosForProductPaginator
default ListPortfoliosForProductPublisher listPortfoliosForProductPaginator(Consumer<ListPortfoliosForProductRequest.Builder> listPortfoliosForProductRequest) This is a variant of
listPortfoliosForProduct(software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosForProductRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.servicecatalog.paginators.ListPortfoliosForProductPublisher publisher = client.listPortfoliosForProductPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.servicecatalog.paginators.ListPortfoliosForProductPublisher publisher = client.listPortfoliosForProductPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosForProductResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosForProductResponse response) { //... }; });
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 viaListPortfoliosForProductRequest.builder()
- Parameters:
listPortfoliosForProductRequest
- AConsumer
that will call methods onListPortfoliosForProductRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listPortfoliosPaginator
This is a variant of
listPortfolios(software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.servicecatalog.paginators.ListPortfoliosPublisher publisher = client.listPortfoliosPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.servicecatalog.paginators.ListPortfoliosPublisher publisher = client.listPortfoliosPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosResponse response) { //... }; });
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPortfolios(software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listPortfoliosPaginator
default ListPortfoliosPublisher listPortfoliosPaginator(ListPortfoliosRequest listPortfoliosRequest) This is a variant of
listPortfolios(software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.servicecatalog.paginators.ListPortfoliosPublisher publisher = client.listPortfoliosPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.servicecatalog.paginators.ListPortfoliosPublisher publisher = client.listPortfoliosPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosResponse response) { //... }; });
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPortfolios(software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosRequest)
operation.- Parameters:
listPortfoliosRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listPortfoliosPaginator
default ListPortfoliosPublisher listPortfoliosPaginator(Consumer<ListPortfoliosRequest.Builder> listPortfoliosRequest) This is a variant of
listPortfolios(software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.servicecatalog.paginators.ListPortfoliosPublisher publisher = client.listPortfoliosPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.servicecatalog.paginators.ListPortfoliosPublisher publisher = client.listPortfoliosPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosResponse response) { //... }; });
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPortfolios(software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosRequest)
operation.
This is a convenience which creates an instance of the
ListPortfoliosRequest.Builder
avoiding the need to create one manually viaListPortfoliosRequest.builder()
- Parameters:
listPortfoliosRequest
- AConsumer
that will call methods onListPortfoliosRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listPrincipalsForPortfolio
default CompletableFuture<ListPrincipalsForPortfolioResponse> listPrincipalsForPortfolio(ListPrincipalsForPortfolioRequest listPrincipalsForPortfolioRequest) Lists all
PrincipalARN
s and correspondingPrincipalType
s associated with the specified portfolio.- Parameters:
listPrincipalsForPortfolioRequest
-- Returns:
- A Java Future containing the result of the ListPrincipalsForPortfolio operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listPrincipalsForPortfolio
default CompletableFuture<ListPrincipalsForPortfolioResponse> listPrincipalsForPortfolio(Consumer<ListPrincipalsForPortfolioRequest.Builder> listPrincipalsForPortfolioRequest) Lists all
PrincipalARN
s and correspondingPrincipalType
s associated with the specified portfolio.
This is a convenience which creates an instance of the
ListPrincipalsForPortfolioRequest.Builder
avoiding the need to create one manually viaListPrincipalsForPortfolioRequest.builder()
- Parameters:
listPrincipalsForPortfolioRequest
- AConsumer
that will call methods onListPrincipalsForPortfolioRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListPrincipalsForPortfolio operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listPrincipalsForPortfolioPaginator
default ListPrincipalsForPortfolioPublisher listPrincipalsForPortfolioPaginator(ListPrincipalsForPortfolioRequest listPrincipalsForPortfolioRequest) This is a variant of
listPrincipalsForPortfolio(software.amazon.awssdk.services.servicecatalog.model.ListPrincipalsForPortfolioRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.servicecatalog.paginators.ListPrincipalsForPortfolioPublisher publisher = client.listPrincipalsForPortfolioPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.servicecatalog.paginators.ListPrincipalsForPortfolioPublisher publisher = client.listPrincipalsForPortfolioPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicecatalog.model.ListPrincipalsForPortfolioResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.servicecatalog.model.ListPrincipalsForPortfolioResponse response) { //... }; });
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPrincipalsForPortfolio(software.amazon.awssdk.services.servicecatalog.model.ListPrincipalsForPortfolioRequest)
operation.- Parameters:
listPrincipalsForPortfolioRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listPrincipalsForPortfolioPaginator
default ListPrincipalsForPortfolioPublisher listPrincipalsForPortfolioPaginator(Consumer<ListPrincipalsForPortfolioRequest.Builder> listPrincipalsForPortfolioRequest) This is a variant of
listPrincipalsForPortfolio(software.amazon.awssdk.services.servicecatalog.model.ListPrincipalsForPortfolioRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.servicecatalog.paginators.ListPrincipalsForPortfolioPublisher publisher = client.listPrincipalsForPortfolioPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.servicecatalog.paginators.ListPrincipalsForPortfolioPublisher publisher = client.listPrincipalsForPortfolioPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicecatalog.model.ListPrincipalsForPortfolioResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.servicecatalog.model.ListPrincipalsForPortfolioResponse response) { //... }; });
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 viaListPrincipalsForPortfolioRequest.builder()
- Parameters:
listPrincipalsForPortfolioRequest
- AConsumer
that will call methods onListPrincipalsForPortfolioRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listProvisionedProductPlans
default CompletableFuture<ListProvisionedProductPlansResponse> listProvisionedProductPlans(ListProvisionedProductPlansRequest listProvisionedProductPlansRequest) Lists the plans for the specified provisioned product or all plans to which the user has access.
- Parameters:
listProvisionedProductPlansRequest
-- Returns:
- A Java Future containing the result of the ListProvisionedProductPlans operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listProvisionedProductPlans
default CompletableFuture<ListProvisionedProductPlansResponse> listProvisionedProductPlans(Consumer<ListProvisionedProductPlansRequest.Builder> listProvisionedProductPlansRequest) Lists the plans for the specified provisioned product or all plans to which the user has access.
This is a convenience which creates an instance of the
ListProvisionedProductPlansRequest.Builder
avoiding the need to create one manually viaListProvisionedProductPlansRequest.builder()
- Parameters:
listProvisionedProductPlansRequest
- AConsumer
that will call methods onListProvisionedProductPlansRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListProvisionedProductPlans operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listProvisionedProductPlans
Lists the plans for the specified provisioned product or all plans to which the user has access.
- Returns:
- A Java Future containing the result of the ListProvisionedProductPlans operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listProvisioningArtifacts
default CompletableFuture<ListProvisioningArtifactsResponse> listProvisioningArtifacts(ListProvisioningArtifactsRequest listProvisioningArtifactsRequest) Lists all provisioning artifacts (also known as versions) for the specified product.
- Parameters:
listProvisioningArtifactsRequest
-- Returns:
- A Java Future containing the result of the ListProvisioningArtifacts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listProvisioningArtifacts
default CompletableFuture<ListProvisioningArtifactsResponse> listProvisioningArtifacts(Consumer<ListProvisioningArtifactsRequest.Builder> listProvisioningArtifactsRequest) Lists all provisioning artifacts (also known as versions) for the specified product.
This is a convenience which creates an instance of the
ListProvisioningArtifactsRequest.Builder
avoiding the need to create one manually viaListProvisioningArtifactsRequest.builder()
- Parameters:
listProvisioningArtifactsRequest
- AConsumer
that will call methods onListProvisioningArtifactsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListProvisioningArtifacts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listProvisioningArtifactsForServiceAction
default CompletableFuture<ListProvisioningArtifactsForServiceActionResponse> listProvisioningArtifactsForServiceAction(ListProvisioningArtifactsForServiceActionRequest listProvisioningArtifactsForServiceActionRequest) Lists all provisioning artifacts (also known as versions) for the specified self-service action.
- Parameters:
listProvisioningArtifactsForServiceActionRequest
-- Returns:
- A Java Future containing the result of the ListProvisioningArtifactsForServiceAction operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listProvisioningArtifactsForServiceAction
default CompletableFuture<ListProvisioningArtifactsForServiceActionResponse> listProvisioningArtifactsForServiceAction(Consumer<ListProvisioningArtifactsForServiceActionRequest.Builder> listProvisioningArtifactsForServiceActionRequest) Lists all provisioning artifacts (also known as versions) for the specified self-service action.
This is a convenience which creates an instance of the
ListProvisioningArtifactsForServiceActionRequest.Builder
avoiding the need to create one manually viaListProvisioningArtifactsForServiceActionRequest.builder()
- Parameters:
listProvisioningArtifactsForServiceActionRequest
- AConsumer
that will call methods onListProvisioningArtifactsForServiceActionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListProvisioningArtifactsForServiceAction operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listProvisioningArtifactsForServiceActionPaginator
default ListProvisioningArtifactsForServiceActionPublisher listProvisioningArtifactsForServiceActionPaginator(ListProvisioningArtifactsForServiceActionRequest listProvisioningArtifactsForServiceActionRequest) This is a variant of
listProvisioningArtifactsForServiceAction(software.amazon.awssdk.services.servicecatalog.model.ListProvisioningArtifactsForServiceActionRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.servicecatalog.paginators.ListProvisioningArtifactsForServiceActionPublisher publisher = client.listProvisioningArtifactsForServiceActionPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.servicecatalog.paginators.ListProvisioningArtifactsForServiceActionPublisher publisher = client.listProvisioningArtifactsForServiceActionPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicecatalog.model.ListProvisioningArtifactsForServiceActionResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.servicecatalog.model.ListProvisioningArtifactsForServiceActionResponse response) { //... }; });
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProvisioningArtifactsForServiceAction(software.amazon.awssdk.services.servicecatalog.model.ListProvisioningArtifactsForServiceActionRequest)
operation.- Parameters:
listProvisioningArtifactsForServiceActionRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listProvisioningArtifactsForServiceActionPaginator
default ListProvisioningArtifactsForServiceActionPublisher listProvisioningArtifactsForServiceActionPaginator(Consumer<ListProvisioningArtifactsForServiceActionRequest.Builder> listProvisioningArtifactsForServiceActionRequest) This is a variant of
listProvisioningArtifactsForServiceAction(software.amazon.awssdk.services.servicecatalog.model.ListProvisioningArtifactsForServiceActionRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.servicecatalog.paginators.ListProvisioningArtifactsForServiceActionPublisher publisher = client.listProvisioningArtifactsForServiceActionPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.servicecatalog.paginators.ListProvisioningArtifactsForServiceActionPublisher publisher = client.listProvisioningArtifactsForServiceActionPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicecatalog.model.ListProvisioningArtifactsForServiceActionResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.servicecatalog.model.ListProvisioningArtifactsForServiceActionResponse response) { //... }; });
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProvisioningArtifactsForServiceAction(software.amazon.awssdk.services.servicecatalog.model.ListProvisioningArtifactsForServiceActionRequest)
operation.
This is a convenience which creates an instance of the
ListProvisioningArtifactsForServiceActionRequest.Builder
avoiding the need to create one manually viaListProvisioningArtifactsForServiceActionRequest.builder()
- Parameters:
listProvisioningArtifactsForServiceActionRequest
- AConsumer
that will call methods onListProvisioningArtifactsForServiceActionRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listRecordHistory
default CompletableFuture<ListRecordHistoryResponse> listRecordHistory(ListRecordHistoryRequest listRecordHistoryRequest) Lists the specified requests or all performed requests.
- Parameters:
listRecordHistoryRequest
-- Returns:
- A Java Future containing the result of the ListRecordHistory operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listRecordHistory
default CompletableFuture<ListRecordHistoryResponse> listRecordHistory(Consumer<ListRecordHistoryRequest.Builder> listRecordHistoryRequest) Lists the specified requests or all performed requests.
This is a convenience which creates an instance of the
ListRecordHistoryRequest.Builder
avoiding the need to create one manually viaListRecordHistoryRequest.builder()
- Parameters:
listRecordHistoryRequest
- AConsumer
that will call methods onListRecordHistoryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListRecordHistory operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listRecordHistory
Lists the specified requests or all performed requests.
- Returns:
- A Java Future containing the result of the ListRecordHistory operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listResourcesForTagOption
default CompletableFuture<ListResourcesForTagOptionResponse> listResourcesForTagOption(ListResourcesForTagOptionRequest listResourcesForTagOptionRequest) Lists the resources associated with the specified TagOption.
- Parameters:
listResourcesForTagOptionRequest
-- Returns:
- A Java Future containing the result of the ListResourcesForTagOption operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TagOptionNotMigratedException An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.
- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listResourcesForTagOption
default CompletableFuture<ListResourcesForTagOptionResponse> listResourcesForTagOption(Consumer<ListResourcesForTagOptionRequest.Builder> listResourcesForTagOptionRequest) Lists the resources associated with the specified TagOption.
This is a convenience which creates an instance of the
ListResourcesForTagOptionRequest.Builder
avoiding the need to create one manually viaListResourcesForTagOptionRequest.builder()
- Parameters:
listResourcesForTagOptionRequest
- AConsumer
that will call methods onListResourcesForTagOptionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListResourcesForTagOption operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TagOptionNotMigratedException An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.
- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listResourcesForTagOptionPaginator
default ListResourcesForTagOptionPublisher listResourcesForTagOptionPaginator(ListResourcesForTagOptionRequest listResourcesForTagOptionRequest) This is a variant of
listResourcesForTagOption(software.amazon.awssdk.services.servicecatalog.model.ListResourcesForTagOptionRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.servicecatalog.paginators.ListResourcesForTagOptionPublisher publisher = client.listResourcesForTagOptionPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.servicecatalog.paginators.ListResourcesForTagOptionPublisher publisher = client.listResourcesForTagOptionPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicecatalog.model.ListResourcesForTagOptionResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.servicecatalog.model.ListResourcesForTagOptionResponse response) { //... }; });
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResourcesForTagOption(software.amazon.awssdk.services.servicecatalog.model.ListResourcesForTagOptionRequest)
operation.- Parameters:
listResourcesForTagOptionRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TagOptionNotMigratedException An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.
- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listResourcesForTagOptionPaginator
default ListResourcesForTagOptionPublisher listResourcesForTagOptionPaginator(Consumer<ListResourcesForTagOptionRequest.Builder> listResourcesForTagOptionRequest) This is a variant of
listResourcesForTagOption(software.amazon.awssdk.services.servicecatalog.model.ListResourcesForTagOptionRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.servicecatalog.paginators.ListResourcesForTagOptionPublisher publisher = client.listResourcesForTagOptionPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.servicecatalog.paginators.ListResourcesForTagOptionPublisher publisher = client.listResourcesForTagOptionPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicecatalog.model.ListResourcesForTagOptionResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.servicecatalog.model.ListResourcesForTagOptionResponse response) { //... }; });
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResourcesForTagOption(software.amazon.awssdk.services.servicecatalog.model.ListResourcesForTagOptionRequest)
operation.
This is a convenience which creates an instance of the
ListResourcesForTagOptionRequest.Builder
avoiding the need to create one manually viaListResourcesForTagOptionRequest.builder()
- Parameters:
listResourcesForTagOptionRequest
- AConsumer
that will call methods onListResourcesForTagOptionRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TagOptionNotMigratedException An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.
- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listServiceActions
default CompletableFuture<ListServiceActionsResponse> listServiceActions(ListServiceActionsRequest listServiceActionsRequest) Lists all self-service actions.
- Parameters:
listServiceActionsRequest
-- Returns:
- A Java Future containing the result of the ListServiceActions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listServiceActions
default CompletableFuture<ListServiceActionsResponse> listServiceActions(Consumer<ListServiceActionsRequest.Builder> listServiceActionsRequest) Lists all self-service actions.
This is a convenience which creates an instance of the
ListServiceActionsRequest.Builder
avoiding the need to create one manually viaListServiceActionsRequest.builder()
- Parameters:
listServiceActionsRequest
- AConsumer
that will call methods onListServiceActionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListServiceActions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listServiceActions
Lists all self-service actions.
- Returns:
- A Java Future containing the result of the ListServiceActions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listServiceActionsForProvisioningArtifact
default CompletableFuture<ListServiceActionsForProvisioningArtifactResponse> listServiceActionsForProvisioningArtifact(ListServiceActionsForProvisioningArtifactRequest listServiceActionsForProvisioningArtifactRequest) Returns a paginated list of self-service actions associated with the specified Product ID and Provisioning Artifact ID.
- Parameters:
listServiceActionsForProvisioningArtifactRequest
-- Returns:
- A Java Future containing the result of the ListServiceActionsForProvisioningArtifact operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listServiceActionsForProvisioningArtifact
default CompletableFuture<ListServiceActionsForProvisioningArtifactResponse> listServiceActionsForProvisioningArtifact(Consumer<ListServiceActionsForProvisioningArtifactRequest.Builder> listServiceActionsForProvisioningArtifactRequest) Returns a paginated list of self-service actions associated with the specified Product ID and Provisioning Artifact ID.
This is a convenience which creates an instance of the
ListServiceActionsForProvisioningArtifactRequest.Builder
avoiding the need to create one manually viaListServiceActionsForProvisioningArtifactRequest.builder()
- Parameters:
listServiceActionsForProvisioningArtifactRequest
- AConsumer
that will call methods onListServiceActionsForProvisioningArtifactRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListServiceActionsForProvisioningArtifact operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listServiceActionsForProvisioningArtifactPaginator
default ListServiceActionsForProvisioningArtifactPublisher listServiceActionsForProvisioningArtifactPaginator(ListServiceActionsForProvisioningArtifactRequest listServiceActionsForProvisioningArtifactRequest) This is a variant of
listServiceActionsForProvisioningArtifact(software.amazon.awssdk.services.servicecatalog.model.ListServiceActionsForProvisioningArtifactRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.servicecatalog.paginators.ListServiceActionsForProvisioningArtifactPublisher publisher = client.listServiceActionsForProvisioningArtifactPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.servicecatalog.paginators.ListServiceActionsForProvisioningArtifactPublisher publisher = client.listServiceActionsForProvisioningArtifactPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicecatalog.model.ListServiceActionsForProvisioningArtifactResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.servicecatalog.model.ListServiceActionsForProvisioningArtifactResponse response) { //... }; });
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listServiceActionsForProvisioningArtifact(software.amazon.awssdk.services.servicecatalog.model.ListServiceActionsForProvisioningArtifactRequest)
operation.- Parameters:
listServiceActionsForProvisioningArtifactRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listServiceActionsForProvisioningArtifactPaginator
default ListServiceActionsForProvisioningArtifactPublisher listServiceActionsForProvisioningArtifactPaginator(Consumer<ListServiceActionsForProvisioningArtifactRequest.Builder> listServiceActionsForProvisioningArtifactRequest) This is a variant of
listServiceActionsForProvisioningArtifact(software.amazon.awssdk.services.servicecatalog.model.ListServiceActionsForProvisioningArtifactRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.servicecatalog.paginators.ListServiceActionsForProvisioningArtifactPublisher publisher = client.listServiceActionsForProvisioningArtifactPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.servicecatalog.paginators.ListServiceActionsForProvisioningArtifactPublisher publisher = client.listServiceActionsForProvisioningArtifactPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicecatalog.model.ListServiceActionsForProvisioningArtifactResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.servicecatalog.model.ListServiceActionsForProvisioningArtifactResponse response) { //... }; });
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listServiceActionsForProvisioningArtifact(software.amazon.awssdk.services.servicecatalog.model.ListServiceActionsForProvisioningArtifactRequest)
operation.
This is a convenience which creates an instance of the
ListServiceActionsForProvisioningArtifactRequest.Builder
avoiding the need to create one manually viaListServiceActionsForProvisioningArtifactRequest.builder()
- Parameters:
listServiceActionsForProvisioningArtifactRequest
- AConsumer
that will call methods onListServiceActionsForProvisioningArtifactRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listServiceActionsPaginator
This is a variant of
listServiceActions(software.amazon.awssdk.services.servicecatalog.model.ListServiceActionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.servicecatalog.paginators.ListServiceActionsPublisher publisher = client.listServiceActionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.servicecatalog.paginators.ListServiceActionsPublisher publisher = client.listServiceActionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicecatalog.model.ListServiceActionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.servicecatalog.model.ListServiceActionsResponse response) { //... }; });
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listServiceActions(software.amazon.awssdk.services.servicecatalog.model.ListServiceActionsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listServiceActionsPaginator
default ListServiceActionsPublisher listServiceActionsPaginator(ListServiceActionsRequest listServiceActionsRequest) This is a variant of
listServiceActions(software.amazon.awssdk.services.servicecatalog.model.ListServiceActionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.servicecatalog.paginators.ListServiceActionsPublisher publisher = client.listServiceActionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.servicecatalog.paginators.ListServiceActionsPublisher publisher = client.listServiceActionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicecatalog.model.ListServiceActionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.servicecatalog.model.ListServiceActionsResponse response) { //... }; });
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listServiceActions(software.amazon.awssdk.services.servicecatalog.model.ListServiceActionsRequest)
operation.- Parameters:
listServiceActionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listServiceActionsPaginator
default ListServiceActionsPublisher listServiceActionsPaginator(Consumer<ListServiceActionsRequest.Builder> listServiceActionsRequest) This is a variant of
listServiceActions(software.amazon.awssdk.services.servicecatalog.model.ListServiceActionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.servicecatalog.paginators.ListServiceActionsPublisher publisher = client.listServiceActionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.servicecatalog.paginators.ListServiceActionsPublisher publisher = client.listServiceActionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicecatalog.model.ListServiceActionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.servicecatalog.model.ListServiceActionsResponse response) { //... }; });
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listServiceActions(software.amazon.awssdk.services.servicecatalog.model.ListServiceActionsRequest)
operation.
This is a convenience which creates an instance of the
ListServiceActionsRequest.Builder
avoiding the need to create one manually viaListServiceActionsRequest.builder()
- Parameters:
listServiceActionsRequest
- AConsumer
that will call methods onListServiceActionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listStackInstancesForProvisionedProduct
default CompletableFuture<ListStackInstancesForProvisionedProductResponse> listStackInstancesForProvisionedProduct(ListStackInstancesForProvisionedProductRequest listStackInstancesForProvisionedProductRequest) Returns summary information about stack instances that are associated with the specified
CFN_STACKSET
type provisioned product. You can filter for stack instances that are associated with a specific Amazon Web Services account name or Region.- Parameters:
listStackInstancesForProvisionedProductRequest
-- Returns:
- A Java Future containing the result of the ListStackInstancesForProvisionedProduct operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listStackInstancesForProvisionedProduct
default CompletableFuture<ListStackInstancesForProvisionedProductResponse> listStackInstancesForProvisionedProduct(Consumer<ListStackInstancesForProvisionedProductRequest.Builder> listStackInstancesForProvisionedProductRequest) Returns summary information about stack instances that are associated with the specified
CFN_STACKSET
type provisioned product. You can filter for stack instances that are associated with a specific Amazon Web Services account name or Region.
This is a convenience which creates an instance of the
ListStackInstancesForProvisionedProductRequest.Builder
avoiding the need to create one manually viaListStackInstancesForProvisionedProductRequest.builder()
- Parameters:
listStackInstancesForProvisionedProductRequest
- AConsumer
that will call methods onListStackInstancesForProvisionedProductRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListStackInstancesForProvisionedProduct operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listTagOptions
default CompletableFuture<ListTagOptionsResponse> listTagOptions(ListTagOptionsRequest listTagOptionsRequest) Lists the specified TagOptions or all TagOptions.
- Parameters:
listTagOptionsRequest
-- Returns:
- A Java Future containing the result of the ListTagOptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TagOptionNotMigratedException An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listTagOptions
default CompletableFuture<ListTagOptionsResponse> listTagOptions(Consumer<ListTagOptionsRequest.Builder> listTagOptionsRequest) Lists the specified TagOptions or all TagOptions.
This is a convenience which creates an instance of the
ListTagOptionsRequest.Builder
avoiding the need to create one manually viaListTagOptionsRequest.builder()
- Parameters:
listTagOptionsRequest
- AConsumer
that will call methods onListTagOptionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagOptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TagOptionNotMigratedException An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listTagOptions
Lists the specified TagOptions or all TagOptions.
- Returns:
- A Java Future containing the result of the ListTagOptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TagOptionNotMigratedException An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listTagOptionsPaginator
This is a variant of
listTagOptions(software.amazon.awssdk.services.servicecatalog.model.ListTagOptionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.servicecatalog.paginators.ListTagOptionsPublisher publisher = client.listTagOptionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.servicecatalog.paginators.ListTagOptionsPublisher publisher = client.listTagOptionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicecatalog.model.ListTagOptionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.servicecatalog.model.ListTagOptionsResponse response) { //... }; });
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagOptions(software.amazon.awssdk.services.servicecatalog.model.ListTagOptionsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TagOptionNotMigratedException An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listTagOptionsPaginator
default ListTagOptionsPublisher listTagOptionsPaginator(ListTagOptionsRequest listTagOptionsRequest) This is a variant of
listTagOptions(software.amazon.awssdk.services.servicecatalog.model.ListTagOptionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.servicecatalog.paginators.ListTagOptionsPublisher publisher = client.listTagOptionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.servicecatalog.paginators.ListTagOptionsPublisher publisher = client.listTagOptionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicecatalog.model.ListTagOptionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.servicecatalog.model.ListTagOptionsResponse response) { //... }; });
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagOptions(software.amazon.awssdk.services.servicecatalog.model.ListTagOptionsRequest)
operation.- Parameters:
listTagOptionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TagOptionNotMigratedException An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
listTagOptionsPaginator
default ListTagOptionsPublisher listTagOptionsPaginator(Consumer<ListTagOptionsRequest.Builder> listTagOptionsRequest) This is a variant of
listTagOptions(software.amazon.awssdk.services.servicecatalog.model.ListTagOptionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.servicecatalog.paginators.ListTagOptionsPublisher publisher = client.listTagOptionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.servicecatalog.paginators.ListTagOptionsPublisher publisher = client.listTagOptionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicecatalog.model.ListTagOptionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.servicecatalog.model.ListTagOptionsResponse response) { //... }; });
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagOptions(software.amazon.awssdk.services.servicecatalog.model.ListTagOptionsRequest)
operation.
This is a convenience which creates an instance of the
ListTagOptionsRequest.Builder
avoiding the need to create one manually viaListTagOptionsRequest.builder()
- Parameters:
listTagOptionsRequest
- AConsumer
that will call methods onListTagOptionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TagOptionNotMigratedException An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
notifyProvisionProductEngineWorkflowResult
default CompletableFuture<NotifyProvisionProductEngineWorkflowResultResponse> notifyProvisionProductEngineWorkflowResult(NotifyProvisionProductEngineWorkflowResultRequest notifyProvisionProductEngineWorkflowResultRequest) Notifies the result of the provisioning engine execution.
- Parameters:
notifyProvisionProductEngineWorkflowResultRequest
-- Returns:
- A Java Future containing the result of the NotifyProvisionProductEngineWorkflowResult operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
notifyProvisionProductEngineWorkflowResult
default CompletableFuture<NotifyProvisionProductEngineWorkflowResultResponse> notifyProvisionProductEngineWorkflowResult(Consumer<NotifyProvisionProductEngineWorkflowResultRequest.Builder> notifyProvisionProductEngineWorkflowResultRequest) Notifies the result of the provisioning engine execution.
This is a convenience which creates an instance of the
NotifyProvisionProductEngineWorkflowResultRequest.Builder
avoiding the need to create one manually viaNotifyProvisionProductEngineWorkflowResultRequest.builder()
- Parameters:
notifyProvisionProductEngineWorkflowResultRequest
- AConsumer
that will call methods onNotifyProvisionProductEngineWorkflowResultRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the NotifyProvisionProductEngineWorkflowResult operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
notifyTerminateProvisionedProductEngineWorkflowResult
default CompletableFuture<NotifyTerminateProvisionedProductEngineWorkflowResultResponse> notifyTerminateProvisionedProductEngineWorkflowResult(NotifyTerminateProvisionedProductEngineWorkflowResultRequest notifyTerminateProvisionedProductEngineWorkflowResultRequest) Notifies the result of the terminate engine execution.
- Parameters:
notifyTerminateProvisionedProductEngineWorkflowResultRequest
-- Returns:
- A Java Future containing the result of the NotifyTerminateProvisionedProductEngineWorkflowResult
operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
notifyTerminateProvisionedProductEngineWorkflowResult
default CompletableFuture<NotifyTerminateProvisionedProductEngineWorkflowResultResponse> notifyTerminateProvisionedProductEngineWorkflowResult(Consumer<NotifyTerminateProvisionedProductEngineWorkflowResultRequest.Builder> notifyTerminateProvisionedProductEngineWorkflowResultRequest) Notifies the result of the terminate engine execution.
This is a convenience which creates an instance of the
NotifyTerminateProvisionedProductEngineWorkflowResultRequest.Builder
avoiding the need to create one manually viaNotifyTerminateProvisionedProductEngineWorkflowResultRequest.builder()
- Parameters:
notifyTerminateProvisionedProductEngineWorkflowResultRequest
- AConsumer
that will call methods onNotifyTerminateProvisionedProductEngineWorkflowResultRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the NotifyTerminateProvisionedProductEngineWorkflowResult
operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
notifyUpdateProvisionedProductEngineWorkflowResult
default CompletableFuture<NotifyUpdateProvisionedProductEngineWorkflowResultResponse> notifyUpdateProvisionedProductEngineWorkflowResult(NotifyUpdateProvisionedProductEngineWorkflowResultRequest notifyUpdateProvisionedProductEngineWorkflowResultRequest) Notifies the result of the update engine execution.
- Parameters:
notifyUpdateProvisionedProductEngineWorkflowResultRequest
-- Returns:
- A Java Future containing the result of the NotifyUpdateProvisionedProductEngineWorkflowResult operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
notifyUpdateProvisionedProductEngineWorkflowResult
default CompletableFuture<NotifyUpdateProvisionedProductEngineWorkflowResultResponse> notifyUpdateProvisionedProductEngineWorkflowResult(Consumer<NotifyUpdateProvisionedProductEngineWorkflowResultRequest.Builder> notifyUpdateProvisionedProductEngineWorkflowResultRequest) Notifies the result of the update engine execution.
This is a convenience which creates an instance of the
NotifyUpdateProvisionedProductEngineWorkflowResultRequest.Builder
avoiding the need to create one manually viaNotifyUpdateProvisionedProductEngineWorkflowResultRequest.builder()
- Parameters:
notifyUpdateProvisionedProductEngineWorkflowResultRequest
- AConsumer
that will call methods onNotifyUpdateProvisionedProductEngineWorkflowResultRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the NotifyUpdateProvisionedProductEngineWorkflowResult operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
provisionProduct
default CompletableFuture<ProvisionProductResponse> provisionProduct(ProvisionProductRequest provisionProductRequest) Provisions the specified product.
A provisioned product is a resourced instance of a product. For example, provisioning a product that's based on an CloudFormation template launches an CloudFormation stack and its underlying resources. You can check the status of this request using DescribeRecord.
If the request contains a tag key with an empty list of values, there's a tag conflict for that key. Don't include conflicted keys as tags, or this will cause the error "Parameter validation failed: Missing required parameter in Tags[N]:Value".
When provisioning a product that's been added to a portfolio, you must grant your user, group, or role access to the portfolio. For more information, see Granting users access in the Service Catalog User Guide.
- Parameters:
provisionProductRequest
-- Returns:
- A Java Future containing the result of the ProvisionProduct operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- ResourceNotFoundException The specified resource was not found.
- DuplicateResourceException The specified resource is a duplicate.
- 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.
- See Also:
-
provisionProduct
default CompletableFuture<ProvisionProductResponse> provisionProduct(Consumer<ProvisionProductRequest.Builder> provisionProductRequest) Provisions the specified product.
A provisioned product is a resourced instance of a product. For example, provisioning a product that's based on an CloudFormation template launches an CloudFormation stack and its underlying resources. You can check the status of this request using DescribeRecord.
If the request contains a tag key with an empty list of values, there's a tag conflict for that key. Don't include conflicted keys as tags, or this will cause the error "Parameter validation failed: Missing required parameter in Tags[N]:Value".
When provisioning a product that's been added to a portfolio, you must grant your user, group, or role access to the portfolio. For more information, see Granting users access in the Service Catalog User Guide.
This is a convenience which creates an instance of the
ProvisionProductRequest.Builder
avoiding the need to create one manually viaProvisionProductRequest.builder()
- Parameters:
provisionProductRequest
- AConsumer
that will call methods onProvisionProductRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ProvisionProduct operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- ResourceNotFoundException The specified resource was not found.
- DuplicateResourceException The specified resource is a duplicate.
- 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.
- See Also:
-
scanProvisionedProducts
default CompletableFuture<ScanProvisionedProductsResponse> scanProvisionedProducts(ScanProvisionedProductsRequest scanProvisionedProductsRequest) Lists the provisioned products that are available (not terminated).
To use additional filtering, see SearchProvisionedProducts.
- Parameters:
scanProvisionedProductsRequest
-- Returns:
- A Java Future containing the result of the ScanProvisionedProducts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
scanProvisionedProducts
default CompletableFuture<ScanProvisionedProductsResponse> scanProvisionedProducts(Consumer<ScanProvisionedProductsRequest.Builder> scanProvisionedProductsRequest) Lists the provisioned products that are available (not terminated).
To use additional filtering, see SearchProvisionedProducts.
This is a convenience which creates an instance of the
ScanProvisionedProductsRequest.Builder
avoiding the need to create one manually viaScanProvisionedProductsRequest.builder()
- Parameters:
scanProvisionedProductsRequest
- AConsumer
that will call methods onScanProvisionedProductsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ScanProvisionedProducts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
scanProvisionedProducts
Lists the provisioned products that are available (not terminated).
To use additional filtering, see SearchProvisionedProducts.
- Returns:
- A Java Future containing the result of the ScanProvisionedProducts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
searchProducts
default CompletableFuture<SearchProductsResponse> searchProducts(SearchProductsRequest searchProductsRequest) Gets information about the products to which the caller has access.
- Parameters:
searchProductsRequest
-- Returns:
- A Java Future containing the result of the SearchProducts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
searchProducts
default CompletableFuture<SearchProductsResponse> searchProducts(Consumer<SearchProductsRequest.Builder> searchProductsRequest) Gets information about the products to which the caller has access.
This is a convenience which creates an instance of the
SearchProductsRequest.Builder
avoiding the need to create one manually viaSearchProductsRequest.builder()
- Parameters:
searchProductsRequest
- AConsumer
that will call methods onSearchProductsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SearchProducts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
searchProducts
Gets information about the products to which the caller has access.
- Returns:
- A Java Future containing the result of the SearchProducts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
searchProductsAsAdmin
default CompletableFuture<SearchProductsAsAdminResponse> searchProductsAsAdmin(SearchProductsAsAdminRequest searchProductsAsAdminRequest) Gets information about the products for the specified portfolio or all products.
- Parameters:
searchProductsAsAdminRequest
-- Returns:
- A Java Future containing the result of the SearchProductsAsAdmin operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
searchProductsAsAdmin
default CompletableFuture<SearchProductsAsAdminResponse> searchProductsAsAdmin(Consumer<SearchProductsAsAdminRequest.Builder> searchProductsAsAdminRequest) Gets information about the products for the specified portfolio or all products.
This is a convenience which creates an instance of the
SearchProductsAsAdminRequest.Builder
avoiding the need to create one manually viaSearchProductsAsAdminRequest.builder()
- Parameters:
searchProductsAsAdminRequest
- AConsumer
that will call methods onSearchProductsAsAdminRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SearchProductsAsAdmin operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
searchProductsAsAdmin
Gets information about the products for the specified portfolio or all products.
- Returns:
- A Java Future containing the result of the SearchProductsAsAdmin operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
searchProductsAsAdminPaginator
This is a variant of
searchProductsAsAdmin(software.amazon.awssdk.services.servicecatalog.model.SearchProductsAsAdminRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.servicecatalog.paginators.SearchProductsAsAdminPublisher publisher = client.searchProductsAsAdminPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.servicecatalog.paginators.SearchProductsAsAdminPublisher publisher = client.searchProductsAsAdminPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicecatalog.model.SearchProductsAsAdminResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.servicecatalog.model.SearchProductsAsAdminResponse response) { //... }; });
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchProductsAsAdmin(software.amazon.awssdk.services.servicecatalog.model.SearchProductsAsAdminRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
searchProductsAsAdminPaginator
default SearchProductsAsAdminPublisher searchProductsAsAdminPaginator(SearchProductsAsAdminRequest searchProductsAsAdminRequest) This is a variant of
searchProductsAsAdmin(software.amazon.awssdk.services.servicecatalog.model.SearchProductsAsAdminRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.servicecatalog.paginators.SearchProductsAsAdminPublisher publisher = client.searchProductsAsAdminPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.servicecatalog.paginators.SearchProductsAsAdminPublisher publisher = client.searchProductsAsAdminPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicecatalog.model.SearchProductsAsAdminResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.servicecatalog.model.SearchProductsAsAdminResponse response) { //... }; });
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchProductsAsAdmin(software.amazon.awssdk.services.servicecatalog.model.SearchProductsAsAdminRequest)
operation.- Parameters:
searchProductsAsAdminRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
searchProductsAsAdminPaginator
default SearchProductsAsAdminPublisher searchProductsAsAdminPaginator(Consumer<SearchProductsAsAdminRequest.Builder> searchProductsAsAdminRequest) This is a variant of
searchProductsAsAdmin(software.amazon.awssdk.services.servicecatalog.model.SearchProductsAsAdminRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.servicecatalog.paginators.SearchProductsAsAdminPublisher publisher = client.searchProductsAsAdminPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.servicecatalog.paginators.SearchProductsAsAdminPublisher publisher = client.searchProductsAsAdminPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicecatalog.model.SearchProductsAsAdminResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.servicecatalog.model.SearchProductsAsAdminResponse response) { //... }; });
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchProductsAsAdmin(software.amazon.awssdk.services.servicecatalog.model.SearchProductsAsAdminRequest)
operation.
This is a convenience which creates an instance of the
SearchProductsAsAdminRequest.Builder
avoiding the need to create one manually viaSearchProductsAsAdminRequest.builder()
- Parameters:
searchProductsAsAdminRequest
- AConsumer
that will call methods onSearchProductsAsAdminRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
searchProductsPaginator
This is a variant of
searchProducts(software.amazon.awssdk.services.servicecatalog.model.SearchProductsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.servicecatalog.paginators.SearchProductsPublisher publisher = client.searchProductsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.servicecatalog.paginators.SearchProductsPublisher publisher = client.searchProductsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicecatalog.model.SearchProductsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.servicecatalog.model.SearchProductsResponse response) { //... }; });
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchProducts(software.amazon.awssdk.services.servicecatalog.model.SearchProductsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
searchProductsPaginator
default SearchProductsPublisher searchProductsPaginator(SearchProductsRequest searchProductsRequest) This is a variant of
searchProducts(software.amazon.awssdk.services.servicecatalog.model.SearchProductsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.servicecatalog.paginators.SearchProductsPublisher publisher = client.searchProductsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.servicecatalog.paginators.SearchProductsPublisher publisher = client.searchProductsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicecatalog.model.SearchProductsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.servicecatalog.model.SearchProductsResponse response) { //... }; });
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchProducts(software.amazon.awssdk.services.servicecatalog.model.SearchProductsRequest)
operation.- Parameters:
searchProductsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
searchProductsPaginator
default SearchProductsPublisher searchProductsPaginator(Consumer<SearchProductsRequest.Builder> searchProductsRequest) This is a variant of
searchProducts(software.amazon.awssdk.services.servicecatalog.model.SearchProductsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.servicecatalog.paginators.SearchProductsPublisher publisher = client.searchProductsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.servicecatalog.paginators.SearchProductsPublisher publisher = client.searchProductsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicecatalog.model.SearchProductsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.servicecatalog.model.SearchProductsResponse response) { //... }; });
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchProducts(software.amazon.awssdk.services.servicecatalog.model.SearchProductsRequest)
operation.
This is a convenience which creates an instance of the
SearchProductsRequest.Builder
avoiding the need to create one manually viaSearchProductsRequest.builder()
- Parameters:
searchProductsRequest
- AConsumer
that will call methods onSearchProductsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
searchProvisionedProducts
default CompletableFuture<SearchProvisionedProductsResponse> searchProvisionedProducts(SearchProvisionedProductsRequest searchProvisionedProductsRequest) Gets information about the provisioned products that meet the specified criteria.
- Parameters:
searchProvisionedProductsRequest
-- Returns:
- A Java Future containing the result of the SearchProvisionedProducts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
searchProvisionedProducts
default CompletableFuture<SearchProvisionedProductsResponse> searchProvisionedProducts(Consumer<SearchProvisionedProductsRequest.Builder> searchProvisionedProductsRequest) Gets information about the provisioned products that meet the specified criteria.
This is a convenience which creates an instance of the
SearchProvisionedProductsRequest.Builder
avoiding the need to create one manually viaSearchProvisionedProductsRequest.builder()
- Parameters:
searchProvisionedProductsRequest
- AConsumer
that will call methods onSearchProvisionedProductsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SearchProvisionedProducts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
searchProvisionedProducts
Gets information about the provisioned products that meet the specified criteria.
- Returns:
- A Java Future containing the result of the SearchProvisionedProducts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
searchProvisionedProductsPaginator
This is a variant of
searchProvisionedProducts(software.amazon.awssdk.services.servicecatalog.model.SearchProvisionedProductsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.servicecatalog.paginators.SearchProvisionedProductsPublisher publisher = client.searchProvisionedProductsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.servicecatalog.paginators.SearchProvisionedProductsPublisher publisher = client.searchProvisionedProductsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicecatalog.model.SearchProvisionedProductsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.servicecatalog.model.SearchProvisionedProductsResponse response) { //... }; });
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchProvisionedProducts(software.amazon.awssdk.services.servicecatalog.model.SearchProvisionedProductsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
searchProvisionedProductsPaginator
default SearchProvisionedProductsPublisher searchProvisionedProductsPaginator(SearchProvisionedProductsRequest searchProvisionedProductsRequest) This is a variant of
searchProvisionedProducts(software.amazon.awssdk.services.servicecatalog.model.SearchProvisionedProductsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.servicecatalog.paginators.SearchProvisionedProductsPublisher publisher = client.searchProvisionedProductsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.servicecatalog.paginators.SearchProvisionedProductsPublisher publisher = client.searchProvisionedProductsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicecatalog.model.SearchProvisionedProductsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.servicecatalog.model.SearchProvisionedProductsResponse response) { //... }; });
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchProvisionedProducts(software.amazon.awssdk.services.servicecatalog.model.SearchProvisionedProductsRequest)
operation.- Parameters:
searchProvisionedProductsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
searchProvisionedProductsPaginator
default SearchProvisionedProductsPublisher searchProvisionedProductsPaginator(Consumer<SearchProvisionedProductsRequest.Builder> searchProvisionedProductsRequest) This is a variant of
searchProvisionedProducts(software.amazon.awssdk.services.servicecatalog.model.SearchProvisionedProductsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.servicecatalog.paginators.SearchProvisionedProductsPublisher publisher = client.searchProvisionedProductsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.servicecatalog.paginators.SearchProvisionedProductsPublisher publisher = client.searchProvisionedProductsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicecatalog.model.SearchProvisionedProductsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.servicecatalog.model.SearchProvisionedProductsResponse response) { //... }; });
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchProvisionedProducts(software.amazon.awssdk.services.servicecatalog.model.SearchProvisionedProductsRequest)
operation.
This is a convenience which creates an instance of the
SearchProvisionedProductsRequest.Builder
avoiding the need to create one manually viaSearchProvisionedProductsRequest.builder()
- Parameters:
searchProvisionedProductsRequest
- AConsumer
that will call methods onSearchProvisionedProductsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
terminateProvisionedProduct
default CompletableFuture<TerminateProvisionedProductResponse> terminateProvisionedProduct(TerminateProvisionedProductRequest terminateProvisionedProductRequest) Terminates the specified provisioned product.
This operation does not delete any records associated with the provisioned product.
You can check the status of this request using DescribeRecord.
- Parameters:
terminateProvisionedProductRequest
-- Returns:
- A Java Future containing the result of the TerminateProvisionedProduct operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
terminateProvisionedProduct
default CompletableFuture<TerminateProvisionedProductResponse> terminateProvisionedProduct(Consumer<TerminateProvisionedProductRequest.Builder> terminateProvisionedProductRequest) Terminates the specified provisioned product.
This operation does not delete any records associated with the provisioned product.
You can check the status of this request using DescribeRecord.
This is a convenience which creates an instance of the
TerminateProvisionedProductRequest.Builder
avoiding the need to create one manually viaTerminateProvisionedProductRequest.builder()
- Parameters:
terminateProvisionedProductRequest
- AConsumer
that will call methods onTerminateProvisionedProductRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TerminateProvisionedProduct operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateConstraint
default CompletableFuture<UpdateConstraintResponse> updateConstraint(UpdateConstraintRequest updateConstraintRequest) Updates the specified constraint.
- Parameters:
updateConstraintRequest
-- Returns:
- A Java Future containing the result of the UpdateConstraint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
updateConstraint
default CompletableFuture<UpdateConstraintResponse> updateConstraint(Consumer<UpdateConstraintRequest.Builder> updateConstraintRequest) Updates the specified constraint.
This is a convenience which creates an instance of the
UpdateConstraintRequest.Builder
avoiding the need to create one manually viaUpdateConstraintRequest.builder()
- Parameters:
updateConstraintRequest
- AConsumer
that will call methods onUpdateConstraintRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateConstraint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
updatePortfolio
default CompletableFuture<UpdatePortfolioResponse> updatePortfolio(UpdatePortfolioRequest updatePortfolioRequest) Updates the specified portfolio.
You cannot update a product that was shared with you.
- Parameters:
updatePortfolioRequest
-- Returns:
- A Java Future containing the result of the UpdatePortfolio operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- ResourceNotFoundException The specified resource was not found.
- LimitExceededException The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.
- TagOptionNotMigratedException An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management 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.
- See Also:
-
updatePortfolio
default CompletableFuture<UpdatePortfolioResponse> updatePortfolio(Consumer<UpdatePortfolioRequest.Builder> updatePortfolioRequest) Updates the specified portfolio.
You cannot update a product that was shared with you.
This is a convenience which creates an instance of the
UpdatePortfolioRequest.Builder
avoiding the need to create one manually viaUpdatePortfolioRequest.builder()
- Parameters:
updatePortfolioRequest
- AConsumer
that will call methods onUpdatePortfolioRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdatePortfolio operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- ResourceNotFoundException The specified resource was not found.
- LimitExceededException The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.
- TagOptionNotMigratedException An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management 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.
- See Also:
-
updateProduct
default CompletableFuture<UpdateProductResponse> updateProduct(UpdateProductRequest updateProductRequest) Updates the specified product.
- Parameters:
updateProductRequest
-- Returns:
- A Java Future containing the result of the UpdateProduct operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- TagOptionNotMigratedException An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management 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.
- See Also:
-
updateProduct
default CompletableFuture<UpdateProductResponse> updateProduct(Consumer<UpdateProductRequest.Builder> updateProductRequest) Updates the specified product.
This is a convenience which creates an instance of the
UpdateProductRequest.Builder
avoiding the need to create one manually viaUpdateProductRequest.builder()
- Parameters:
updateProductRequest
- AConsumer
that will call methods onUpdateProductRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateProduct operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- TagOptionNotMigratedException An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management 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.
- See Also:
-
updateProvisionedProduct
default CompletableFuture<UpdateProvisionedProductResponse> updateProvisionedProduct(UpdateProvisionedProductRequest updateProvisionedProductRequest) Requests updates to the configuration of the specified provisioned product.
If there are tags associated with the object, they cannot be updated or added. Depending on the specific updates requested, this operation can update with no interruption, with some interruption, or replace the provisioned product entirely.
You can check the status of this request using DescribeRecord.
- Parameters:
updateProvisionedProductRequest
-- Returns:
- A Java Future containing the result of the UpdateProvisionedProduct operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
updateProvisionedProduct
default CompletableFuture<UpdateProvisionedProductResponse> updateProvisionedProduct(Consumer<UpdateProvisionedProductRequest.Builder> updateProvisionedProductRequest) Requests updates to the configuration of the specified provisioned product.
If there are tags associated with the object, they cannot be updated or added. Depending on the specific updates requested, this operation can update with no interruption, with some interruption, or replace the provisioned product entirely.
You can check the status of this request using DescribeRecord.
This is a convenience which creates an instance of the
UpdateProvisionedProductRequest.Builder
avoiding the need to create one manually viaUpdateProvisionedProductRequest.builder()
- Parameters:
updateProvisionedProductRequest
- AConsumer
that will call methods onUpdateProvisionedProductRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateProvisionedProduct operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
updateProvisionedProductProperties
default CompletableFuture<UpdateProvisionedProductPropertiesResponse> updateProvisionedProductProperties(UpdateProvisionedProductPropertiesRequest updateProvisionedProductPropertiesRequest) Requests updates to the properties of the specified provisioned product.
- Parameters:
updateProvisionedProductPropertiesRequest
-- Returns:
- A Java Future containing the result of the UpdateProvisionedProductProperties operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- ResourceNotFoundException The specified resource was not found.
- InvalidStateException An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.
- 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.
- See Also:
-
updateProvisionedProductProperties
default CompletableFuture<UpdateProvisionedProductPropertiesResponse> updateProvisionedProductProperties(Consumer<UpdateProvisionedProductPropertiesRequest.Builder> updateProvisionedProductPropertiesRequest) Requests updates to the properties of the specified provisioned product.
This is a convenience which creates an instance of the
UpdateProvisionedProductPropertiesRequest.Builder
avoiding the need to create one manually viaUpdateProvisionedProductPropertiesRequest.builder()
- Parameters:
updateProvisionedProductPropertiesRequest
- AConsumer
that will call methods onUpdateProvisionedProductPropertiesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateProvisionedProductProperties operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParametersException One or more parameters provided to the operation are not valid.
- ResourceNotFoundException The specified resource was not found.
- InvalidStateException An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.
- 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.
- See Also:
-
updateProvisioningArtifact
default CompletableFuture<UpdateProvisioningArtifactResponse> updateProvisioningArtifact(UpdateProvisioningArtifactRequest updateProvisioningArtifactRequest) Updates the specified provisioning artifact (also known as a version) for the specified product.
You cannot update a provisioning artifact for a product that was shared with you.
- Parameters:
updateProvisioningArtifactRequest
-- Returns:
- A Java Future containing the result of the UpdateProvisioningArtifact operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
updateProvisioningArtifact
default CompletableFuture<UpdateProvisioningArtifactResponse> updateProvisioningArtifact(Consumer<UpdateProvisioningArtifactRequest.Builder> updateProvisioningArtifactRequest) Updates the specified provisioning artifact (also known as a version) for the specified product.
You cannot update a provisioning artifact for a product that was shared with you.
This is a convenience which creates an instance of the
UpdateProvisioningArtifactRequest.Builder
avoiding the need to create one manually viaUpdateProvisioningArtifactRequest.builder()
- Parameters:
updateProvisioningArtifactRequest
- AConsumer
that will call methods onUpdateProvisioningArtifactRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateProvisioningArtifact operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
updateServiceAction
default CompletableFuture<UpdateServiceActionResponse> updateServiceAction(UpdateServiceActionRequest updateServiceActionRequest) Updates a self-service action.
- Parameters:
updateServiceActionRequest
-- Returns:
- A Java Future containing the result of the UpdateServiceAction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
updateServiceAction
default CompletableFuture<UpdateServiceActionResponse> updateServiceAction(Consumer<UpdateServiceActionRequest.Builder> updateServiceActionRequest) Updates a self-service action.
This is a convenience which creates an instance of the
UpdateServiceActionRequest.Builder
avoiding the need to create one manually viaUpdateServiceActionRequest.builder()
- Parameters:
updateServiceActionRequest
- AConsumer
that will call methods onUpdateServiceActionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateServiceAction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
updateTagOption
default CompletableFuture<UpdateTagOptionResponse> updateTagOption(UpdateTagOptionRequest updateTagOptionRequest) Updates the specified TagOption.
- Parameters:
updateTagOptionRequest
-- Returns:
- A Java Future containing the result of the UpdateTagOption operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TagOptionNotMigratedException An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.
- ResourceNotFoundException The specified resource was not found.
- DuplicateResourceException The specified resource is a duplicate.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
updateTagOption
default CompletableFuture<UpdateTagOptionResponse> updateTagOption(Consumer<UpdateTagOptionRequest.Builder> updateTagOptionRequest) Updates the specified TagOption.
This is a convenience which creates an instance of the
UpdateTagOptionRequest.Builder
avoiding the need to create one manually viaUpdateTagOptionRequest.builder()
- Parameters:
updateTagOptionRequest
- AConsumer
that will call methods onUpdateTagOptionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateTagOption operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TagOptionNotMigratedException An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.
- ResourceNotFoundException The specified resource was not found.
- DuplicateResourceException The specified resource is a duplicate.
- InvalidParametersException One or more parameters provided to the operation are not valid.
- 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.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aServiceCatalogAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aServiceCatalogAsyncClient
.