Interface ServiceCatalogClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface ServiceCatalogClient extends AwsClient
Service client for accessing AWS Service Catalog. This can be created using the staticbuilder()method.Service Catalog 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
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
acceptPortfolioShare
default AcceptPortfolioShareResponse acceptPortfolioShare(AcceptPortfolioShareRequest acceptPortfolioShareRequest) throws InvalidParametersException, ResourceNotFoundException, LimitExceededException, AwsServiceException, SdkClientException, ServiceCatalogException
Accepts an offer to share the specified portfolio.
- Parameters:
acceptPortfolioShareRequest-- Returns:
- Result of the AcceptPortfolioShare operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
acceptPortfolioShare
default AcceptPortfolioShareResponse acceptPortfolioShare(Consumer<AcceptPortfolioShareRequest.Builder> acceptPortfolioShareRequest) throws InvalidParametersException, ResourceNotFoundException, LimitExceededException, AwsServiceException, SdkClientException, ServiceCatalogException
Accepts an offer to share the specified portfolio.
This is a convenience which creates an instance of the
AcceptPortfolioShareRequest.Builderavoiding the need to create one manually viaAcceptPortfolioShareRequest.builder()- Parameters:
acceptPortfolioShareRequest- AConsumerthat will call methods onAcceptPortfolioShareRequest.Builderto create a request.- Returns:
- Result of the AcceptPortfolioShare operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
associateBudgetWithResource
default AssociateBudgetWithResourceResponse associateBudgetWithResource(AssociateBudgetWithResourceRequest associateBudgetWithResourceRequest) throws InvalidParametersException, DuplicateResourceException, LimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Associates the specified budget with the specified resource.
- Parameters:
associateBudgetWithResourceRequest-- Returns:
- Result of the AssociateBudgetWithResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
associateBudgetWithResource
default AssociateBudgetWithResourceResponse associateBudgetWithResource(Consumer<AssociateBudgetWithResourceRequest.Builder> associateBudgetWithResourceRequest) throws InvalidParametersException, DuplicateResourceException, LimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Associates the specified budget with the specified resource.
This is a convenience which creates an instance of the
AssociateBudgetWithResourceRequest.Builderavoiding the need to create one manually viaAssociateBudgetWithResourceRequest.builder()- Parameters:
associateBudgetWithResourceRequest- AConsumerthat will call methods onAssociateBudgetWithResourceRequest.Builderto create a request.- Returns:
- Result of the AssociateBudgetWithResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
associatePrincipalWithPortfolio
default AssociatePrincipalWithPortfolioResponse associatePrincipalWithPortfolio(AssociatePrincipalWithPortfolioRequest associatePrincipalWithPortfolioRequest) throws InvalidParametersException, ResourceNotFoundException, LimitExceededException, AwsServiceException, SdkClientException, ServiceCatalogException
Associates the specified principal ARN with the specified portfolio.
If you share the portfolio with principal name sharing enabled, the
PrincipalARNassociation is included in the share.The
PortfolioID,PrincipalARN, andPrincipalTypeparameters are required.You can associate a maximum of 10 Principals with a portfolio using
PrincipalTypeasIAM_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
PrincipalTypeasIAM. With this configuration, thePrincipalARNmust already exist in the recipient account before it can be associated.- Parameters:
associatePrincipalWithPortfolioRequest-- Returns:
- Result of the AssociatePrincipalWithPortfolio operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
associatePrincipalWithPortfolio
default AssociatePrincipalWithPortfolioResponse associatePrincipalWithPortfolio(Consumer<AssociatePrincipalWithPortfolioRequest.Builder> associatePrincipalWithPortfolioRequest) throws InvalidParametersException, ResourceNotFoundException, LimitExceededException, AwsServiceException, SdkClientException, ServiceCatalogException
Associates the specified principal ARN with the specified portfolio.
If you share the portfolio with principal name sharing enabled, the
PrincipalARNassociation is included in the share.The
PortfolioID,PrincipalARN, andPrincipalTypeparameters are required.You can associate a maximum of 10 Principals with a portfolio using
PrincipalTypeasIAM_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
PrincipalTypeasIAM. With this configuration, thePrincipalARNmust already exist in the recipient account before it can be associated.
This is a convenience which creates an instance of the
AssociatePrincipalWithPortfolioRequest.Builderavoiding the need to create one manually viaAssociatePrincipalWithPortfolioRequest.builder()- Parameters:
associatePrincipalWithPortfolioRequest- AConsumerthat will call methods onAssociatePrincipalWithPortfolioRequest.Builderto create a request.- Returns:
- Result of the AssociatePrincipalWithPortfolio operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
associateProductWithPortfolio
default AssociateProductWithPortfolioResponse associateProductWithPortfolio(AssociateProductWithPortfolioRequest associateProductWithPortfolioRequest) throws InvalidParametersException, ResourceNotFoundException, LimitExceededException, AwsServiceException, SdkClientException, ServiceCatalogException
Associates the specified product with the specified portfolio.
A delegated admin is authorized to invoke this command.
- Parameters:
associateProductWithPortfolioRequest-- Returns:
- Result of the AssociateProductWithPortfolio operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
associateProductWithPortfolio
default AssociateProductWithPortfolioResponse associateProductWithPortfolio(Consumer<AssociateProductWithPortfolioRequest.Builder> associateProductWithPortfolioRequest) throws InvalidParametersException, ResourceNotFoundException, LimitExceededException, AwsServiceException, SdkClientException, ServiceCatalogException
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.Builderavoiding the need to create one manually viaAssociateProductWithPortfolioRequest.builder()- Parameters:
associateProductWithPortfolioRequest- AConsumerthat will call methods onAssociateProductWithPortfolioRequest.Builderto create a request.- Returns:
- Result of the AssociateProductWithPortfolio operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
associateServiceActionWithProvisioningArtifact
default AssociateServiceActionWithProvisioningArtifactResponse associateServiceActionWithProvisioningArtifact(AssociateServiceActionWithProvisioningArtifactRequest associateServiceActionWithProvisioningArtifactRequest) throws ResourceNotFoundException, DuplicateResourceException, LimitExceededException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Associates a self-service action with a provisioning artifact.
- Parameters:
associateServiceActionWithProvisioningArtifactRequest-- Returns:
- Result of the AssociateServiceActionWithProvisioningArtifact operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
associateServiceActionWithProvisioningArtifact
default AssociateServiceActionWithProvisioningArtifactResponse associateServiceActionWithProvisioningArtifact(Consumer<AssociateServiceActionWithProvisioningArtifactRequest.Builder> associateServiceActionWithProvisioningArtifactRequest) throws ResourceNotFoundException, DuplicateResourceException, LimitExceededException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Associates a self-service action with a provisioning artifact.
This is a convenience which creates an instance of the
AssociateServiceActionWithProvisioningArtifactRequest.Builderavoiding the need to create one manually viaAssociateServiceActionWithProvisioningArtifactRequest.builder()- Parameters:
associateServiceActionWithProvisioningArtifactRequest- AConsumerthat will call methods onAssociateServiceActionWithProvisioningArtifactRequest.Builderto create a request.- Returns:
- Result of the AssociateServiceActionWithProvisioningArtifact operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
associateTagOptionWithResource
default AssociateTagOptionWithResourceResponse associateTagOptionWithResource(AssociateTagOptionWithResourceRequest associateTagOptionWithResourceRequest) throws TagOptionNotMigratedException, ResourceNotFoundException, InvalidParametersException, LimitExceededException, DuplicateResourceException, InvalidStateException, AwsServiceException, SdkClientException, ServiceCatalogException
Associate the specified TagOption with the specified portfolio or product.
- Parameters:
associateTagOptionWithResourceRequest-- Returns:
- Result of the AssociateTagOptionWithResource operation returned by the service.
- Throws:
TagOptionNotMigratedException- An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. 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.AwsServiceException- See Also:
- AWS API Documentation
-
associateTagOptionWithResource
default AssociateTagOptionWithResourceResponse associateTagOptionWithResource(Consumer<AssociateTagOptionWithResourceRequest.Builder> associateTagOptionWithResourceRequest) throws TagOptionNotMigratedException, ResourceNotFoundException, InvalidParametersException, LimitExceededException, DuplicateResourceException, InvalidStateException, AwsServiceException, SdkClientException, ServiceCatalogException
Associate the specified TagOption with the specified portfolio or product.
This is a convenience which creates an instance of the
AssociateTagOptionWithResourceRequest.Builderavoiding the need to create one manually viaAssociateTagOptionWithResourceRequest.builder()- Parameters:
associateTagOptionWithResourceRequest- AConsumerthat will call methods onAssociateTagOptionWithResourceRequest.Builderto create a request.- Returns:
- Result of the AssociateTagOptionWithResource operation returned by the service.
- Throws:
TagOptionNotMigratedException- An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. 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.AwsServiceException- See Also:
- AWS API Documentation
-
batchAssociateServiceActionWithProvisioningArtifact
default BatchAssociateServiceActionWithProvisioningArtifactResponse batchAssociateServiceActionWithProvisioningArtifact(BatchAssociateServiceActionWithProvisioningArtifactRequest batchAssociateServiceActionWithProvisioningArtifactRequest) throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Associates multiple self-service actions with provisioning artifacts.
- Parameters:
batchAssociateServiceActionWithProvisioningArtifactRequest-- Returns:
- Result of the BatchAssociateServiceActionWithProvisioningArtifact operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchAssociateServiceActionWithProvisioningArtifact
default BatchAssociateServiceActionWithProvisioningArtifactResponse batchAssociateServiceActionWithProvisioningArtifact(Consumer<BatchAssociateServiceActionWithProvisioningArtifactRequest.Builder> batchAssociateServiceActionWithProvisioningArtifactRequest) throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Associates multiple self-service actions with provisioning artifacts.
This is a convenience which creates an instance of the
BatchAssociateServiceActionWithProvisioningArtifactRequest.Builderavoiding the need to create one manually viaBatchAssociateServiceActionWithProvisioningArtifactRequest.builder()- Parameters:
batchAssociateServiceActionWithProvisioningArtifactRequest- AConsumerthat will call methods onBatchAssociateServiceActionWithProvisioningArtifactRequest.Builderto create a request.- Returns:
- Result of the BatchAssociateServiceActionWithProvisioningArtifact operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchDisassociateServiceActionFromProvisioningArtifact
default BatchDisassociateServiceActionFromProvisioningArtifactResponse batchDisassociateServiceActionFromProvisioningArtifact(BatchDisassociateServiceActionFromProvisioningArtifactRequest batchDisassociateServiceActionFromProvisioningArtifactRequest) throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Disassociates a batch of self-service actions from the specified provisioning artifact.
- Parameters:
batchDisassociateServiceActionFromProvisioningArtifactRequest-- Returns:
- Result of the BatchDisassociateServiceActionFromProvisioningArtifact operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchDisassociateServiceActionFromProvisioningArtifact
default BatchDisassociateServiceActionFromProvisioningArtifactResponse batchDisassociateServiceActionFromProvisioningArtifact(Consumer<BatchDisassociateServiceActionFromProvisioningArtifactRequest.Builder> batchDisassociateServiceActionFromProvisioningArtifactRequest) throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Disassociates a batch of self-service actions from the specified provisioning artifact.
This is a convenience which creates an instance of the
BatchDisassociateServiceActionFromProvisioningArtifactRequest.Builderavoiding the need to create one manually viaBatchDisassociateServiceActionFromProvisioningArtifactRequest.builder()- Parameters:
batchDisassociateServiceActionFromProvisioningArtifactRequest- AConsumerthat will call methods onBatchDisassociateServiceActionFromProvisioningArtifactRequest.Builderto create a request.- Returns:
- Result of the BatchDisassociateServiceActionFromProvisioningArtifact operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
copyProduct
default CopyProductResponse copyProduct(CopyProductRequest copyProductRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Copies the specified source product to the specified target product or a new product.
You can copy 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:
- Result of the CopyProduct operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource was not found.InvalidParametersException- One or more parameters provided to the operation are 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.AwsServiceException- See Also:
- AWS API Documentation
-
copyProduct
default CopyProductResponse copyProduct(Consumer<CopyProductRequest.Builder> copyProductRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Copies the specified source product to the specified target product or a new product.
You can copy 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.Builderavoiding the need to create one manually viaCopyProductRequest.builder()- Parameters:
copyProductRequest- AConsumerthat will call methods onCopyProductRequest.Builderto create a request.- Returns:
- Result of the CopyProduct operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource was not found.InvalidParametersException- One or more parameters provided to the operation are 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.AwsServiceException- See Also:
- AWS API Documentation
-
createConstraint
default CreateConstraintResponse createConstraint(CreateConstraintRequest createConstraintRequest) throws ResourceNotFoundException, InvalidParametersException, LimitExceededException, DuplicateResourceException, AwsServiceException, SdkClientException, ServiceCatalogException
Creates a constraint.
A delegated admin is authorized to invoke this command.
- Parameters:
createConstraintRequest-- Returns:
- Result of the CreateConstraint operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource was not found.InvalidParametersException- One or more parameters provided to the operation are 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.AwsServiceException- See Also:
- AWS API Documentation
-
createConstraint
default CreateConstraintResponse createConstraint(Consumer<CreateConstraintRequest.Builder> createConstraintRequest) throws ResourceNotFoundException, InvalidParametersException, LimitExceededException, DuplicateResourceException, AwsServiceException, SdkClientException, ServiceCatalogException
Creates a constraint.
A delegated admin is authorized to invoke this command.
This is a convenience which creates an instance of the
CreateConstraintRequest.Builderavoiding the need to create one manually viaCreateConstraintRequest.builder()- Parameters:
createConstraintRequest- AConsumerthat will call methods onCreateConstraintRequest.Builderto create a request.- Returns:
- Result of the CreateConstraint operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource was not found.InvalidParametersException- One or more parameters provided to the operation are 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.AwsServiceException- See Also:
- AWS API Documentation
-
createPortfolio
default CreatePortfolioResponse createPortfolio(CreatePortfolioRequest createPortfolioRequest) throws InvalidParametersException, LimitExceededException, TagOptionNotMigratedException, AwsServiceException, SdkClientException, ServiceCatalogException
Creates a portfolio.
A delegated admin is authorized to invoke this command.
- Parameters:
createPortfolioRequest-- Returns:
- Result of the CreatePortfolio operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createPortfolio
default CreatePortfolioResponse createPortfolio(Consumer<CreatePortfolioRequest.Builder> createPortfolioRequest) throws InvalidParametersException, LimitExceededException, TagOptionNotMigratedException, AwsServiceException, SdkClientException, ServiceCatalogException
Creates a portfolio.
A delegated admin is authorized to invoke this command.
This is a convenience which creates an instance of the
CreatePortfolioRequest.Builderavoiding the need to create one manually viaCreatePortfolioRequest.builder()- Parameters:
createPortfolioRequest- AConsumerthat will call methods onCreatePortfolioRequest.Builderto create a request.- Returns:
- Result of the CreatePortfolio operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createPortfolioShare
default CreatePortfolioShareResponse createPortfolioShare(CreatePortfolioShareRequest createPortfolioShareRequest) throws ResourceNotFoundException, LimitExceededException, InvalidParametersException, OperationNotSupportedException, InvalidStateException, AwsServiceException, SdkClientException, ServiceCatalogException
Shares the specified portfolio with the specified account or organization node. Shares to an organization node can only be created by the management account of an organization or by a delegated administrator. You can share portfolios to an organization, an organizational unit, or a specific account.
Note that if a delegated admin is de-registered, they can no longer create portfolio shares.
AWSOrganizationsAccessmust be enabled in order to create a portfolio share to an organization node.You can't share a shared resource, including portfolios that contain a shared product.
If the portfolio share with the specified account or organization node already exists, this action will have no effect and will not return an error. To update an existing share, you must use the
UpdatePortfolioShareAPI instead.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
PrincipalTypeasIAM. With this configuration, thePrincipalARNmust already exist in the recipient account before it can be associated.- Parameters:
createPortfolioShareRequest-- Returns:
- Result of the CreatePortfolioShare operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource was not found.LimitExceededException- The current limits of the service would have been exceeded by this operation. 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.OperationNotSupportedException- The operation is not supported.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.AwsServiceException- See Also:
- AWS API Documentation
-
createPortfolioShare
default CreatePortfolioShareResponse createPortfolioShare(Consumer<CreatePortfolioShareRequest.Builder> createPortfolioShareRequest) throws ResourceNotFoundException, LimitExceededException, InvalidParametersException, OperationNotSupportedException, InvalidStateException, AwsServiceException, SdkClientException, ServiceCatalogException
Shares the specified portfolio with the specified account or organization node. Shares to an organization node can only be created by the management account of an organization or by a delegated administrator. You can share portfolios to an organization, an organizational unit, or a specific account.
Note that if a delegated admin is de-registered, they can no longer create portfolio shares.
AWSOrganizationsAccessmust be enabled in order to create a portfolio share to an organization node.You can't share a shared resource, including portfolios that contain a shared product.
If the portfolio share with the specified account or organization node already exists, this action will have no effect and will not return an error. To update an existing share, you must use the
UpdatePortfolioShareAPI instead.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
PrincipalTypeasIAM. With this configuration, thePrincipalARNmust already exist in the recipient account before it can be associated.
This is a convenience which creates an instance of the
CreatePortfolioShareRequest.Builderavoiding the need to create one manually viaCreatePortfolioShareRequest.builder()- Parameters:
createPortfolioShareRequest- AConsumerthat will call methods onCreatePortfolioShareRequest.Builderto create a request.- Returns:
- Result of the CreatePortfolioShare operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource was not found.LimitExceededException- The current limits of the service would have been exceeded by this operation. 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.OperationNotSupportedException- The operation is not supported.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.AwsServiceException- See Also:
- AWS API Documentation
-
createProduct
default CreateProductResponse createProduct(CreateProductRequest createProductRequest) throws InvalidParametersException, LimitExceededException, TagOptionNotMigratedException, AwsServiceException, SdkClientException, ServiceCatalogException
Creates a product.
A delegated admin is authorized to invoke this command.
The user or role that performs this operation must have the
cloudformation:GetTemplateIAM policy permission. This policy permission is required when using theImportFromPhysicalIdtemplate source in the information data section.- Parameters:
createProductRequest-- Returns:
- Result of the CreateProduct operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createProduct
default CreateProductResponse createProduct(Consumer<CreateProductRequest.Builder> createProductRequest) throws InvalidParametersException, LimitExceededException, TagOptionNotMigratedException, AwsServiceException, SdkClientException, ServiceCatalogException
Creates a product.
A delegated admin is authorized to invoke this command.
The user or role that performs this operation must have the
cloudformation:GetTemplateIAM policy permission. This policy permission is required when using theImportFromPhysicalIdtemplate source in the information data section.
This is a convenience which creates an instance of the
CreateProductRequest.Builderavoiding the need to create one manually viaCreateProductRequest.builder()- Parameters:
createProductRequest- AConsumerthat will call methods onCreateProductRequest.Builderto create a request.- Returns:
- Result of the CreateProduct operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createProvisionedProductPlan
default CreateProvisionedProductPlanResponse createProvisionedProductPlan(CreateProvisionedProductPlanRequest createProvisionedProductPlanRequest) throws InvalidParametersException, ResourceNotFoundException, InvalidStateException, AwsServiceException, SdkClientException, ServiceCatalogException
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:
- Result of the CreateProvisionedProductPlan operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createProvisionedProductPlan
default CreateProvisionedProductPlanResponse createProvisionedProductPlan(Consumer<CreateProvisionedProductPlanRequest.Builder> createProvisionedProductPlanRequest) throws InvalidParametersException, ResourceNotFoundException, InvalidStateException, AwsServiceException, SdkClientException, ServiceCatalogException
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.Builderavoiding the need to create one manually viaCreateProvisionedProductPlanRequest.builder()- Parameters:
createProvisionedProductPlanRequest- AConsumerthat will call methods onCreateProvisionedProductPlanRequest.Builderto create a request.- Returns:
- Result of the CreateProvisionedProductPlan operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createProvisioningArtifact
default CreateProvisioningArtifactResponse createProvisioningArtifact(CreateProvisioningArtifactRequest createProvisioningArtifactRequest) throws ResourceNotFoundException, InvalidParametersException, LimitExceededException, AwsServiceException, SdkClientException, ServiceCatalogException
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:GetTemplateIAM policy permission. This policy permission is required when using theImportFromPhysicalIdtemplate source in the information data section.- Parameters:
createProvisioningArtifactRequest-- Returns:
- Result of the CreateProvisioningArtifact operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource was not found.InvalidParametersException- One or more parameters provided to the operation are 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.AwsServiceException- See Also:
- AWS API Documentation
-
createProvisioningArtifact
default CreateProvisioningArtifactResponse createProvisioningArtifact(Consumer<CreateProvisioningArtifactRequest.Builder> createProvisioningArtifactRequest) throws ResourceNotFoundException, InvalidParametersException, LimitExceededException, AwsServiceException, SdkClientException, ServiceCatalogException
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:GetTemplateIAM policy permission. This policy permission is required when using theImportFromPhysicalIdtemplate source in the information data section.
This is a convenience which creates an instance of the
CreateProvisioningArtifactRequest.Builderavoiding the need to create one manually viaCreateProvisioningArtifactRequest.builder()- Parameters:
createProvisioningArtifactRequest- AConsumerthat will call methods onCreateProvisioningArtifactRequest.Builderto create a request.- Returns:
- Result of the CreateProvisioningArtifact operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource was not found.InvalidParametersException- One or more parameters provided to the operation are 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.AwsServiceException- See Also:
- AWS API Documentation
-
createServiceAction
default CreateServiceActionResponse createServiceAction(CreateServiceActionRequest createServiceActionRequest) throws InvalidParametersException, LimitExceededException, AwsServiceException, SdkClientException, ServiceCatalogException
Creates a self-service action.
- Parameters:
createServiceActionRequest-- Returns:
- Result of the CreateServiceAction operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createServiceAction
default CreateServiceActionResponse createServiceAction(Consumer<CreateServiceActionRequest.Builder> createServiceActionRequest) throws InvalidParametersException, LimitExceededException, AwsServiceException, SdkClientException, ServiceCatalogException
Creates a self-service action.
This is a convenience which creates an instance of the
CreateServiceActionRequest.Builderavoiding the need to create one manually viaCreateServiceActionRequest.builder()- Parameters:
createServiceActionRequest- AConsumerthat will call methods onCreateServiceActionRequest.Builderto create a request.- Returns:
- Result of the CreateServiceAction operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createTagOption
default CreateTagOptionResponse createTagOption(CreateTagOptionRequest createTagOptionRequest) throws TagOptionNotMigratedException, DuplicateResourceException, LimitExceededException, AwsServiceException, SdkClientException, ServiceCatalogException
Creates a TagOption.
- Parameters:
createTagOptionRequest-- Returns:
- Result of the CreateTagOption operation returned by the service.
- Throws:
TagOptionNotMigratedException- An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. 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.AwsServiceException- See Also:
- AWS API Documentation
-
createTagOption
default CreateTagOptionResponse createTagOption(Consumer<CreateTagOptionRequest.Builder> createTagOptionRequest) throws TagOptionNotMigratedException, DuplicateResourceException, LimitExceededException, AwsServiceException, SdkClientException, ServiceCatalogException
Creates a TagOption.
This is a convenience which creates an instance of the
CreateTagOptionRequest.Builderavoiding the need to create one manually viaCreateTagOptionRequest.builder()- Parameters:
createTagOptionRequest- AConsumerthat will call methods onCreateTagOptionRequest.Builderto create a request.- Returns:
- Result of the CreateTagOption operation returned by the service.
- Throws:
TagOptionNotMigratedException- An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteConstraint
default DeleteConstraintResponse deleteConstraint(DeleteConstraintRequest deleteConstraintRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Deletes the specified constraint.
A delegated admin is authorized to invoke this command.
- Parameters:
deleteConstraintRequest-- Returns:
- Result of the DeleteConstraint operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource was not found.InvalidParametersException- One or more parameters provided to the operation are 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteConstraint
default DeleteConstraintResponse deleteConstraint(Consumer<DeleteConstraintRequest.Builder> deleteConstraintRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Deletes the specified constraint.
A delegated admin is authorized to invoke this command.
This is a convenience which creates an instance of the
DeleteConstraintRequest.Builderavoiding the need to create one manually viaDeleteConstraintRequest.builder()- Parameters:
deleteConstraintRequest- AConsumerthat will call methods onDeleteConstraintRequest.Builderto create a request.- Returns:
- Result of the DeleteConstraint operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource was not found.InvalidParametersException- One or more parameters provided to the operation are 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.AwsServiceException- See Also:
- AWS API Documentation
-
deletePortfolio
default DeletePortfolioResponse deletePortfolio(DeletePortfolioRequest deletePortfolioRequest) throws ResourceNotFoundException, InvalidParametersException, ResourceInUseException, TagOptionNotMigratedException, AwsServiceException, SdkClientException, ServiceCatalogException
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:
- Result of the DeletePortfolio operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource was not found.InvalidParametersException- One or more parameters provided to the operation are 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.AwsServiceException- See Also:
- AWS API Documentation
-
deletePortfolio
default DeletePortfolioResponse deletePortfolio(Consumer<DeletePortfolioRequest.Builder> deletePortfolioRequest) throws ResourceNotFoundException, InvalidParametersException, ResourceInUseException, TagOptionNotMigratedException, AwsServiceException, SdkClientException, ServiceCatalogException
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.Builderavoiding the need to create one manually viaDeletePortfolioRequest.builder()- Parameters:
deletePortfolioRequest- AConsumerthat will call methods onDeletePortfolioRequest.Builderto create a request.- Returns:
- Result of the DeletePortfolio operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource was not found.InvalidParametersException- One or more parameters provided to the operation are 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.AwsServiceException- See Also:
- AWS API Documentation
-
deletePortfolioShare
default DeletePortfolioShareResponse deletePortfolioShare(DeletePortfolioShareRequest deletePortfolioShareRequest) throws ResourceNotFoundException, InvalidParametersException, OperationNotSupportedException, InvalidStateException, AwsServiceException, SdkClientException, ServiceCatalogException
Stops sharing the specified portfolio with the specified account or organization node. Shares to an organization node can only be deleted by the management account of an organization or by a delegated administrator.
Note that if a delegated admin is de-registered, portfolio shares created from that account are removed.
- Parameters:
deletePortfolioShareRequest-- Returns:
- Result of the DeletePortfolioShare operation returned by the service.
- Throws:
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.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.AwsServiceException- See Also:
- AWS API Documentation
-
deletePortfolioShare
default DeletePortfolioShareResponse deletePortfolioShare(Consumer<DeletePortfolioShareRequest.Builder> deletePortfolioShareRequest) throws ResourceNotFoundException, InvalidParametersException, OperationNotSupportedException, InvalidStateException, AwsServiceException, SdkClientException, ServiceCatalogException
Stops sharing the specified portfolio with the specified account or organization node. Shares to an organization node can only be deleted by the management account of an organization or by a delegated administrator.
Note that if a delegated admin is de-registered, portfolio shares created from that account are removed.
This is a convenience which creates an instance of the
DeletePortfolioShareRequest.Builderavoiding the need to create one manually viaDeletePortfolioShareRequest.builder()- Parameters:
deletePortfolioShareRequest- AConsumerthat will call methods onDeletePortfolioShareRequest.Builderto create a request.- Returns:
- Result of the DeletePortfolioShare operation returned by the service.
- Throws:
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.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteProduct
default DeleteProductResponse deleteProduct(DeleteProductRequest deleteProductRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidParametersException, TagOptionNotMigratedException, AwsServiceException, SdkClientException, ServiceCatalogException
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:
- Result of the DeleteProduct operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteProduct
default DeleteProductResponse deleteProduct(Consumer<DeleteProductRequest.Builder> deleteProductRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidParametersException, TagOptionNotMigratedException, AwsServiceException, SdkClientException, ServiceCatalogException
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.Builderavoiding the need to create one manually viaDeleteProductRequest.builder()- Parameters:
deleteProductRequest- AConsumerthat will call methods onDeleteProductRequest.Builderto create a request.- Returns:
- Result of the DeleteProduct operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteProvisionedProductPlan
default DeleteProvisionedProductPlanResponse deleteProvisionedProductPlan(DeleteProvisionedProductPlanRequest deleteProvisionedProductPlanRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Deletes the specified plan.
- Parameters:
deleteProvisionedProductPlanRequest-- Returns:
- Result of the DeleteProvisionedProductPlan operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteProvisionedProductPlan
default DeleteProvisionedProductPlanResponse deleteProvisionedProductPlan(Consumer<DeleteProvisionedProductPlanRequest.Builder> deleteProvisionedProductPlanRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Deletes the specified plan.
This is a convenience which creates an instance of the
DeleteProvisionedProductPlanRequest.Builderavoiding the need to create one manually viaDeleteProvisionedProductPlanRequest.builder()- Parameters:
deleteProvisionedProductPlanRequest- AConsumerthat will call methods onDeleteProvisionedProductPlanRequest.Builderto create a request.- Returns:
- Result of the DeleteProvisionedProductPlan operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteProvisioningArtifact
default DeleteProvisioningArtifactResponse deleteProvisioningArtifact(DeleteProvisioningArtifactRequest deleteProvisioningArtifactRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
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:
- Result of the DeleteProvisioningArtifact operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteProvisioningArtifact
default DeleteProvisioningArtifactResponse deleteProvisioningArtifact(Consumer<DeleteProvisioningArtifactRequest.Builder> deleteProvisioningArtifactRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
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.Builderavoiding the need to create one manually viaDeleteProvisioningArtifactRequest.builder()- Parameters:
deleteProvisioningArtifactRequest- AConsumerthat will call methods onDeleteProvisioningArtifactRequest.Builderto create a request.- Returns:
- Result of the DeleteProvisioningArtifact operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteServiceAction
default DeleteServiceActionResponse deleteServiceAction(DeleteServiceActionRequest deleteServiceActionRequest) throws ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ServiceCatalogException
Deletes a self-service action.
- Parameters:
deleteServiceActionRequest-- Returns:
- Result of the DeleteServiceAction operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteServiceAction
default DeleteServiceActionResponse deleteServiceAction(Consumer<DeleteServiceActionRequest.Builder> deleteServiceActionRequest) throws ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ServiceCatalogException
Deletes a self-service action.
This is a convenience which creates an instance of the
DeleteServiceActionRequest.Builderavoiding the need to create one manually viaDeleteServiceActionRequest.builder()- Parameters:
deleteServiceActionRequest- AConsumerthat will call methods onDeleteServiceActionRequest.Builderto create a request.- Returns:
- Result of the DeleteServiceAction operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteTagOption
default DeleteTagOptionResponse deleteTagOption(DeleteTagOptionRequest deleteTagOptionRequest) throws TagOptionNotMigratedException, ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Deletes the specified TagOption.
You cannot delete a TagOption if it is associated with a product or portfolio.
- Parameters:
deleteTagOptionRequest-- Returns:
- Result of the DeleteTagOption operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteTagOption
default DeleteTagOptionResponse deleteTagOption(Consumer<DeleteTagOptionRequest.Builder> deleteTagOptionRequest) throws TagOptionNotMigratedException, ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
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.Builderavoiding the need to create one manually viaDeleteTagOptionRequest.builder()- Parameters:
deleteTagOptionRequest- AConsumerthat will call methods onDeleteTagOptionRequest.Builderto create a request.- Returns:
- Result of the DeleteTagOption operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeConstraint
default DescribeConstraintResponse describeConstraint(DescribeConstraintRequest describeConstraintRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Gets information about the specified constraint.
- Parameters:
describeConstraintRequest-- Returns:
- Result of the DescribeConstraint operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeConstraint
default DescribeConstraintResponse describeConstraint(Consumer<DescribeConstraintRequest.Builder> describeConstraintRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Gets information about the specified constraint.
This is a convenience which creates an instance of the
DescribeConstraintRequest.Builderavoiding the need to create one manually viaDescribeConstraintRequest.builder()- Parameters:
describeConstraintRequest- AConsumerthat will call methods onDescribeConstraintRequest.Builderto create a request.- Returns:
- Result of the DescribeConstraint operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeCopyProductStatus
default DescribeCopyProductStatusResponse describeCopyProductStatus(DescribeCopyProductStatusRequest describeCopyProductStatusRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Gets the status of the specified copy product operation.
- Parameters:
describeCopyProductStatusRequest-- Returns:
- Result of the DescribeCopyProductStatus operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource was not found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ServiceCatalogException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeCopyProductStatus
default DescribeCopyProductStatusResponse describeCopyProductStatus(Consumer<DescribeCopyProductStatusRequest.Builder> describeCopyProductStatusRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Gets the status of the specified copy product operation.
This is a convenience which creates an instance of the
DescribeCopyProductStatusRequest.Builderavoiding the need to create one manually viaDescribeCopyProductStatusRequest.builder()- Parameters:
describeCopyProductStatusRequest- AConsumerthat will call methods onDescribeCopyProductStatusRequest.Builderto create a request.- Returns:
- Result of the DescribeCopyProductStatus operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describePortfolio
default DescribePortfolioResponse describePortfolio(DescribePortfolioRequest describePortfolioRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Gets information about the specified portfolio.
A delegated admin is authorized to invoke this command.
- Parameters:
describePortfolioRequest-- Returns:
- Result of the DescribePortfolio operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describePortfolio
default DescribePortfolioResponse describePortfolio(Consumer<DescribePortfolioRequest.Builder> describePortfolioRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
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.Builderavoiding the need to create one manually viaDescribePortfolioRequest.builder()- Parameters:
describePortfolioRequest- AConsumerthat will call methods onDescribePortfolioRequest.Builderto create a request.- Returns:
- Result of the DescribePortfolio operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describePortfolioShareStatus
default DescribePortfolioShareStatusResponse describePortfolioShareStatus(DescribePortfolioShareStatusRequest describePortfolioShareStatusRequest) throws ResourceNotFoundException, InvalidParametersException, OperationNotSupportedException, AwsServiceException, SdkClientException, ServiceCatalogException
Gets the status of the specified portfolio share operation. This API can only be called by the management account in the organization or by a delegated admin.
- Parameters:
describePortfolioShareStatusRequest-- Returns:
- Result of the DescribePortfolioShareStatus operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describePortfolioShareStatus
default DescribePortfolioShareStatusResponse describePortfolioShareStatus(Consumer<DescribePortfolioShareStatusRequest.Builder> describePortfolioShareStatusRequest) throws ResourceNotFoundException, InvalidParametersException, OperationNotSupportedException, AwsServiceException, SdkClientException, ServiceCatalogException
Gets the status of the specified portfolio share operation. 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
DescribePortfolioShareStatusRequest.Builderavoiding the need to create one manually viaDescribePortfolioShareStatusRequest.builder()- Parameters:
describePortfolioShareStatusRequest- AConsumerthat will call methods onDescribePortfolioShareStatusRequest.Builderto create a request.- Returns:
- Result of the DescribePortfolioShareStatus operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describePortfolioShares
default DescribePortfolioSharesResponse describePortfolioShares(DescribePortfolioSharesRequest describePortfolioSharesRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Returns a summary of each of the portfolio shares that were created for the specified portfolio.
You can use this API to determine which accounts or organizational nodes this portfolio have been shared, whether the recipient entity has imported the share, and whether TagOptions are included with the share.
The
PortfolioIdandTypeparameters are both required.- Parameters:
describePortfolioSharesRequest-- Returns:
- Result of the DescribePortfolioShares operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describePortfolioShares
default DescribePortfolioSharesResponse describePortfolioShares(Consumer<DescribePortfolioSharesRequest.Builder> describePortfolioSharesRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Returns a summary of each of the portfolio shares that were created for the specified portfolio.
You can use this API to determine which accounts or organizational nodes this portfolio have been shared, whether the recipient entity has imported the share, and whether TagOptions are included with the share.
The
PortfolioIdandTypeparameters are both required.
This is a convenience which creates an instance of the
DescribePortfolioSharesRequest.Builderavoiding the need to create one manually viaDescribePortfolioSharesRequest.builder()- Parameters:
describePortfolioSharesRequest- AConsumerthat will call methods onDescribePortfolioSharesRequest.Builderto create a request.- Returns:
- Result of the DescribePortfolioShares operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describePortfolioSharesPaginator
default DescribePortfolioSharesIterable describePortfolioSharesPaginator(DescribePortfolioSharesRequest describePortfolioSharesRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
describePortfolioShares(software.amazon.awssdk.services.servicecatalog.model.DescribePortfolioSharesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.DescribePortfolioSharesIterable responses = client.describePortfolioSharesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.DescribePortfolioSharesIterable responses = client .describePortfolioSharesPaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.DescribePortfolioSharesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.DescribePortfolioSharesIterable responses = client.describePortfolioSharesPaginator(request); responses.iterator().forEachRemaining(....);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
describePortfolioShares(software.amazon.awssdk.services.servicecatalog.model.DescribePortfolioSharesRequest)operation.- Parameters:
describePortfolioSharesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describePortfolioSharesPaginator
default DescribePortfolioSharesIterable describePortfolioSharesPaginator(Consumer<DescribePortfolioSharesRequest.Builder> describePortfolioSharesRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
describePortfolioShares(software.amazon.awssdk.services.servicecatalog.model.DescribePortfolioSharesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.DescribePortfolioSharesIterable responses = client.describePortfolioSharesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.DescribePortfolioSharesIterable responses = client .describePortfolioSharesPaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.DescribePortfolioSharesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.DescribePortfolioSharesIterable responses = client.describePortfolioSharesPaginator(request); responses.iterator().forEachRemaining(....);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
describePortfolioShares(software.amazon.awssdk.services.servicecatalog.model.DescribePortfolioSharesRequest)operation.
This is a convenience which creates an instance of the
DescribePortfolioSharesRequest.Builderavoiding the need to create one manually viaDescribePortfolioSharesRequest.builder()- Parameters:
describePortfolioSharesRequest- AConsumerthat will call methods onDescribePortfolioSharesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeProduct
default DescribeProductResponse describeProduct(DescribeProductRequest describeProductRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Gets information about the specified product.
Running this operation with administrator access results in a failure. DescribeProductAsAdmin should be used instead.
- Parameters:
describeProductRequest-- Returns:
- Result of the DescribeProduct operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource was not found.InvalidParametersException- One or more parameters provided to the operation are 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeProduct
default DescribeProductResponse describeProduct(Consumer<DescribeProductRequest.Builder> describeProductRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
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.Builderavoiding the need to create one manually viaDescribeProductRequest.builder()- Parameters:
describeProductRequest- AConsumerthat will call methods onDescribeProductRequest.Builderto create a request.- Returns:
- Result of the DescribeProduct operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource was not found.InvalidParametersException- One or more parameters provided to the operation are 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeProductAsAdmin
default DescribeProductAsAdminResponse describeProductAsAdmin(DescribeProductAsAdminRequest describeProductAsAdminRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Gets information about the specified product. This operation is run with administrator access.
- Parameters:
describeProductAsAdminRequest-- Returns:
- Result of the DescribeProductAsAdmin operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeProductAsAdmin
default DescribeProductAsAdminResponse describeProductAsAdmin(Consumer<DescribeProductAsAdminRequest.Builder> describeProductAsAdminRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Gets information about the specified product. This operation is run with administrator access.
This is a convenience which creates an instance of the
DescribeProductAsAdminRequest.Builderavoiding the need to create one manually viaDescribeProductAsAdminRequest.builder()- Parameters:
describeProductAsAdminRequest- AConsumerthat will call methods onDescribeProductAsAdminRequest.Builderto create a request.- Returns:
- Result of the DescribeProductAsAdmin operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeProductView
default DescribeProductViewResponse describeProductView(DescribeProductViewRequest describeProductViewRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Gets information about the specified product.
- Parameters:
describeProductViewRequest-- Returns:
- Result of the DescribeProductView operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource was not found.InvalidParametersException- One or more parameters provided to the operation are 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeProductView
default DescribeProductViewResponse describeProductView(Consumer<DescribeProductViewRequest.Builder> describeProductViewRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Gets information about the specified product.
This is a convenience which creates an instance of the
DescribeProductViewRequest.Builderavoiding the need to create one manually viaDescribeProductViewRequest.builder()- Parameters:
describeProductViewRequest- AConsumerthat will call methods onDescribeProductViewRequest.Builderto create a request.- Returns:
- Result of the DescribeProductView operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource was not found.InvalidParametersException- One or more parameters provided to the operation are 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeProvisionedProduct
default DescribeProvisionedProductResponse describeProvisionedProduct(DescribeProvisionedProductRequest describeProvisionedProductRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
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:
- Result of the DescribeProvisionedProduct operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeProvisionedProduct
default DescribeProvisionedProductResponse describeProvisionedProduct(Consumer<DescribeProvisionedProductRequest.Builder> describeProvisionedProductRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Gets information about the specified provisioned product.
This is a convenience which creates an instance of the
DescribeProvisionedProductRequest.Builderavoiding the need to create one manually viaDescribeProvisionedProductRequest.builder()- Parameters:
describeProvisionedProductRequest- AConsumerthat will call methods onDescribeProvisionedProductRequest.Builderto 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:
- Result of the DescribeProvisionedProduct operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeProvisionedProductPlan
default DescribeProvisionedProductPlanResponse describeProvisionedProductPlan(DescribeProvisionedProductPlanRequest describeProvisionedProductPlanRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Gets information about the resource changes for the specified plan.
- Parameters:
describeProvisionedProductPlanRequest-- Returns:
- Result of the DescribeProvisionedProductPlan operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeProvisionedProductPlan
default DescribeProvisionedProductPlanResponse describeProvisionedProductPlan(Consumer<DescribeProvisionedProductPlanRequest.Builder> describeProvisionedProductPlanRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Gets information about the resource changes for the specified plan.
This is a convenience which creates an instance of the
DescribeProvisionedProductPlanRequest.Builderavoiding the need to create one manually viaDescribeProvisionedProductPlanRequest.builder()- Parameters:
describeProvisionedProductPlanRequest- AConsumerthat will call methods onDescribeProvisionedProductPlanRequest.Builderto create a request.- Returns:
- Result of the DescribeProvisionedProductPlan operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeProvisioningArtifact
default DescribeProvisioningArtifactResponse describeProvisioningArtifact(DescribeProvisioningArtifactRequest describeProvisioningArtifactRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Gets information about the specified provisioning artifact (also known as a version) for the specified product.
- Parameters:
describeProvisioningArtifactRequest-- Returns:
- Result of the DescribeProvisioningArtifact operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeProvisioningArtifact
default DescribeProvisioningArtifactResponse describeProvisioningArtifact(Consumer<DescribeProvisioningArtifactRequest.Builder> describeProvisioningArtifactRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
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.Builderavoiding the need to create one manually viaDescribeProvisioningArtifactRequest.builder()- Parameters:
describeProvisioningArtifactRequest- AConsumerthat will call methods onDescribeProvisioningArtifactRequest.Builderto create a request.- Returns:
- Result of the DescribeProvisioningArtifact operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeProvisioningParameters
default DescribeProvisioningParametersResponse describeProvisioningParameters(DescribeProvisioningParametersRequest describeProvisioningParametersRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
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:
- Result of the DescribeProvisioningParameters operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeProvisioningParameters
default DescribeProvisioningParametersResponse describeProvisioningParameters(Consumer<DescribeProvisioningParametersRequest.Builder> describeProvisioningParametersRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
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.Builderavoiding the need to create one manually viaDescribeProvisioningParametersRequest.builder()- Parameters:
describeProvisioningParametersRequest- AConsumerthat will call methods onDescribeProvisioningParametersRequest.Builderto create a request.- Returns:
- Result of the DescribeProvisioningParameters operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeRecord
default DescribeRecordResponse describeRecord(DescribeRecordRequest describeRecordRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
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:
- Result of the DescribeRecord operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeRecord
default DescribeRecordResponse describeRecord(Consumer<DescribeRecordRequest.Builder> describeRecordRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
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.Builderavoiding the need to create one manually viaDescribeRecordRequest.builder()- Parameters:
describeRecordRequest- AConsumerthat will call methods onDescribeRecordRequest.Builderto create a request.- Returns:
- Result of the DescribeRecord operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeServiceAction
default DescribeServiceActionResponse describeServiceAction(DescribeServiceActionRequest describeServiceActionRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Describes a self-service action.
- Parameters:
describeServiceActionRequest-- Returns:
- Result of the DescribeServiceAction operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeServiceAction
default DescribeServiceActionResponse describeServiceAction(Consumer<DescribeServiceActionRequest.Builder> describeServiceActionRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Describes a self-service action.
This is a convenience which creates an instance of the
DescribeServiceActionRequest.Builderavoiding the need to create one manually viaDescribeServiceActionRequest.builder()- Parameters:
describeServiceActionRequest- AConsumerthat will call methods onDescribeServiceActionRequest.Builderto create a request.- Returns:
- Result of the DescribeServiceAction operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeServiceActionExecutionParameters
default DescribeServiceActionExecutionParametersResponse describeServiceActionExecutionParameters(DescribeServiceActionExecutionParametersRequest describeServiceActionExecutionParametersRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
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:
- Result of the DescribeServiceActionExecutionParameters operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeServiceActionExecutionParameters
default DescribeServiceActionExecutionParametersResponse describeServiceActionExecutionParameters(Consumer<DescribeServiceActionExecutionParametersRequest.Builder> describeServiceActionExecutionParametersRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
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.Builderavoiding the need to create one manually viaDescribeServiceActionExecutionParametersRequest.builder()- Parameters:
describeServiceActionExecutionParametersRequest- AConsumerthat will call methods onDescribeServiceActionExecutionParametersRequest.Builderto create a request.- Returns:
- Result of the DescribeServiceActionExecutionParameters operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeTagOption
default DescribeTagOptionResponse describeTagOption(DescribeTagOptionRequest describeTagOptionRequest) throws TagOptionNotMigratedException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Gets information about the specified TagOption.
- Parameters:
describeTagOptionRequest-- Returns:
- Result of the DescribeTagOption operation returned by the service.
- Throws:
TagOptionNotMigratedException- An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeTagOption
default DescribeTagOptionResponse describeTagOption(Consumer<DescribeTagOptionRequest.Builder> describeTagOptionRequest) throws TagOptionNotMigratedException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Gets information about the specified TagOption.
This is a convenience which creates an instance of the
DescribeTagOptionRequest.Builderavoiding the need to create one manually viaDescribeTagOptionRequest.builder()- Parameters:
describeTagOptionRequest- AConsumerthat will call methods onDescribeTagOptionRequest.Builderto create a request.- Returns:
- Result of the DescribeTagOption operation returned by the service.
- Throws:
TagOptionNotMigratedException- An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. 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.AwsServiceException- See Also:
- AWS API Documentation
-
disableAWSOrganizationsAccess
default DisableAwsOrganizationsAccessResponse disableAWSOrganizationsAccess(DisableAwsOrganizationsAccessRequest disableAwsOrganizationsAccessRequest) throws ResourceNotFoundException, InvalidStateException, OperationNotSupportedException, AwsServiceException, SdkClientException, ServiceCatalogException
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:
- Result of the DisableAWSOrganizationsAccess operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
disableAWSOrganizationsAccess
default DisableAwsOrganizationsAccessResponse disableAWSOrganizationsAccess(Consumer<DisableAwsOrganizationsAccessRequest.Builder> disableAwsOrganizationsAccessRequest) throws ResourceNotFoundException, InvalidStateException, OperationNotSupportedException, AwsServiceException, SdkClientException, ServiceCatalogException
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.Builderavoiding the need to create one manually viaDisableAwsOrganizationsAccessRequest.builder()- Parameters:
disableAwsOrganizationsAccessRequest- AConsumerthat will call methods onDisableAwsOrganizationsAccessRequest.Builderto create a request.- Returns:
- Result of the DisableAWSOrganizationsAccess operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
disassociateBudgetFromResource
default DisassociateBudgetFromResourceResponse disassociateBudgetFromResource(DisassociateBudgetFromResourceRequest disassociateBudgetFromResourceRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Disassociates the specified budget from the specified resource.
- Parameters:
disassociateBudgetFromResourceRequest-- Returns:
- Result of the DisassociateBudgetFromResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
disassociateBudgetFromResource
default DisassociateBudgetFromResourceResponse disassociateBudgetFromResource(Consumer<DisassociateBudgetFromResourceRequest.Builder> disassociateBudgetFromResourceRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Disassociates the specified budget from the specified resource.
This is a convenience which creates an instance of the
DisassociateBudgetFromResourceRequest.Builderavoiding the need to create one manually viaDisassociateBudgetFromResourceRequest.builder()- Parameters:
disassociateBudgetFromResourceRequest- AConsumerthat will call methods onDisassociateBudgetFromResourceRequest.Builderto create a request.- Returns:
- Result of the DisassociateBudgetFromResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
disassociatePrincipalFromPortfolio
default DisassociatePrincipalFromPortfolioResponse disassociatePrincipalFromPortfolio(DisassociatePrincipalFromPortfolioRequest disassociatePrincipalFromPortfolioRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Disassociates a previously associated principal ARN from a specified portfolio.
The
PrincipalTypeandPrincipalARNmust match theAssociatePrincipalWithPortfoliocall request details. For example, to disassociate an association created with aPrincipalARNofPrincipalTypeIAM you must use thePrincipalTypeIAM 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_PATTERNprincipals that match the principal whose access you are removing.- Parameters:
disassociatePrincipalFromPortfolioRequest-- Returns:
- Result of the DisassociatePrincipalFromPortfolio operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
disassociatePrincipalFromPortfolio
default DisassociatePrincipalFromPortfolioResponse disassociatePrincipalFromPortfolio(Consumer<DisassociatePrincipalFromPortfolioRequest.Builder> disassociatePrincipalFromPortfolioRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Disassociates a previously associated principal ARN from a specified portfolio.
The
PrincipalTypeandPrincipalARNmust match theAssociatePrincipalWithPortfoliocall request details. For example, to disassociate an association created with aPrincipalARNofPrincipalTypeIAM you must use thePrincipalTypeIAM 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_PATTERNprincipals that match the principal whose access you are removing.
This is a convenience which creates an instance of the
DisassociatePrincipalFromPortfolioRequest.Builderavoiding the need to create one manually viaDisassociatePrincipalFromPortfolioRequest.builder()- Parameters:
disassociatePrincipalFromPortfolioRequest- AConsumerthat will call methods onDisassociatePrincipalFromPortfolioRequest.Builderto create a request.- Returns:
- Result of the DisassociatePrincipalFromPortfolio operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
disassociateProductFromPortfolio
default DisassociateProductFromPortfolioResponse disassociateProductFromPortfolio(DisassociateProductFromPortfolioRequest disassociateProductFromPortfolioRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Disassociates the specified product from the specified portfolio.
A delegated admin is authorized to invoke this command.
- Parameters:
disassociateProductFromPortfolioRequest-- Returns:
- Result of the DisassociateProductFromPortfolio operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
disassociateProductFromPortfolio
default DisassociateProductFromPortfolioResponse disassociateProductFromPortfolio(Consumer<DisassociateProductFromPortfolioRequest.Builder> disassociateProductFromPortfolioRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
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.Builderavoiding the need to create one manually viaDisassociateProductFromPortfolioRequest.builder()- Parameters:
disassociateProductFromPortfolioRequest- AConsumerthat will call methods onDisassociateProductFromPortfolioRequest.Builderto create a request.- Returns:
- Result of the DisassociateProductFromPortfolio operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
disassociateServiceActionFromProvisioningArtifact
default DisassociateServiceActionFromProvisioningArtifactResponse disassociateServiceActionFromProvisioningArtifact(DisassociateServiceActionFromProvisioningArtifactRequest disassociateServiceActionFromProvisioningArtifactRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Disassociates the specified self-service action association from the specified provisioning artifact.
- Parameters:
disassociateServiceActionFromProvisioningArtifactRequest-- Returns:
- Result of the DisassociateServiceActionFromProvisioningArtifact operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
disassociateServiceActionFromProvisioningArtifact
default DisassociateServiceActionFromProvisioningArtifactResponse disassociateServiceActionFromProvisioningArtifact(Consumer<DisassociateServiceActionFromProvisioningArtifactRequest.Builder> disassociateServiceActionFromProvisioningArtifactRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Disassociates the specified self-service action association from the specified provisioning artifact.
This is a convenience which creates an instance of the
DisassociateServiceActionFromProvisioningArtifactRequest.Builderavoiding the need to create one manually viaDisassociateServiceActionFromProvisioningArtifactRequest.builder()- Parameters:
disassociateServiceActionFromProvisioningArtifactRequest- AConsumerthat will call methods onDisassociateServiceActionFromProvisioningArtifactRequest.Builderto create a request.- Returns:
- Result of the DisassociateServiceActionFromProvisioningArtifact operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
disassociateTagOptionFromResource
default DisassociateTagOptionFromResourceResponse disassociateTagOptionFromResource(DisassociateTagOptionFromResourceRequest disassociateTagOptionFromResourceRequest) throws TagOptionNotMigratedException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Disassociates the specified TagOption from the specified resource.
- Parameters:
disassociateTagOptionFromResourceRequest-- Returns:
- Result of the DisassociateTagOptionFromResource operation returned by the service.
- Throws:
TagOptionNotMigratedException- An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. 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.AwsServiceException- See Also:
- AWS API Documentation
-
disassociateTagOptionFromResource
default DisassociateTagOptionFromResourceResponse disassociateTagOptionFromResource(Consumer<DisassociateTagOptionFromResourceRequest.Builder> disassociateTagOptionFromResourceRequest) throws TagOptionNotMigratedException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Disassociates the specified TagOption from the specified resource.
This is a convenience which creates an instance of the
DisassociateTagOptionFromResourceRequest.Builderavoiding the need to create one manually viaDisassociateTagOptionFromResourceRequest.builder()- Parameters:
disassociateTagOptionFromResourceRequest- AConsumerthat will call methods onDisassociateTagOptionFromResourceRequest.Builderto create a request.- Returns:
- Result of the DisassociateTagOptionFromResource operation returned by the service.
- Throws:
TagOptionNotMigratedException- An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. 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.AwsServiceException- See Also:
- AWS API Documentation
-
enableAWSOrganizationsAccess
default EnableAwsOrganizationsAccessResponse enableAWSOrganizationsAccess(EnableAwsOrganizationsAccessRequest enableAwsOrganizationsAccessRequest) throws ResourceNotFoundException, InvalidStateException, OperationNotSupportedException, AwsServiceException, SdkClientException, ServiceCatalogException
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:EnableAWSServiceAccesson 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:
- Result of the EnableAWSOrganizationsAccess operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
enableAWSOrganizationsAccess
default EnableAwsOrganizationsAccessResponse enableAWSOrganizationsAccess(Consumer<EnableAwsOrganizationsAccessRequest.Builder> enableAwsOrganizationsAccessRequest) throws ResourceNotFoundException, InvalidStateException, OperationNotSupportedException, AwsServiceException, SdkClientException, ServiceCatalogException
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:EnableAWSServiceAccesson 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.Builderavoiding the need to create one manually viaEnableAwsOrganizationsAccessRequest.builder()- Parameters:
enableAwsOrganizationsAccessRequest- AConsumerthat will call methods onEnableAwsOrganizationsAccessRequest.Builderto create a request.- Returns:
- Result of the EnableAWSOrganizationsAccess operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
executeProvisionedProductPlan
default ExecuteProvisionedProductPlanResponse executeProvisionedProductPlan(ExecuteProvisionedProductPlanRequest executeProvisionedProductPlanRequest) throws InvalidParametersException, ResourceNotFoundException, InvalidStateException, AwsServiceException, SdkClientException, ServiceCatalogException
Provisions or modifies a product based on the resource changes for the specified plan.
- Parameters:
executeProvisionedProductPlanRequest-- Returns:
- Result of the ExecuteProvisionedProductPlan operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
executeProvisionedProductPlan
default ExecuteProvisionedProductPlanResponse executeProvisionedProductPlan(Consumer<ExecuteProvisionedProductPlanRequest.Builder> executeProvisionedProductPlanRequest) throws InvalidParametersException, ResourceNotFoundException, InvalidStateException, AwsServiceException, SdkClientException, ServiceCatalogException
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.Builderavoiding the need to create one manually viaExecuteProvisionedProductPlanRequest.builder()- Parameters:
executeProvisionedProductPlanRequest- AConsumerthat will call methods onExecuteProvisionedProductPlanRequest.Builderto create a request.- Returns:
- Result of the ExecuteProvisionedProductPlan operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
executeProvisionedProductServiceAction
default ExecuteProvisionedProductServiceActionResponse executeProvisionedProductServiceAction(ExecuteProvisionedProductServiceActionRequest executeProvisionedProductServiceActionRequest) throws InvalidParametersException, ResourceNotFoundException, InvalidStateException, AwsServiceException, SdkClientException, ServiceCatalogException
Executes a self-service action against a provisioned product.
- Parameters:
executeProvisionedProductServiceActionRequest-- Returns:
- Result of the ExecuteProvisionedProductServiceAction operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
executeProvisionedProductServiceAction
default ExecuteProvisionedProductServiceActionResponse executeProvisionedProductServiceAction(Consumer<ExecuteProvisionedProductServiceActionRequest.Builder> executeProvisionedProductServiceActionRequest) throws InvalidParametersException, ResourceNotFoundException, InvalidStateException, AwsServiceException, SdkClientException, ServiceCatalogException
Executes a self-service action against a provisioned product.
This is a convenience which creates an instance of the
ExecuteProvisionedProductServiceActionRequest.Builderavoiding the need to create one manually viaExecuteProvisionedProductServiceActionRequest.builder()- Parameters:
executeProvisionedProductServiceActionRequest- AConsumerthat will call methods onExecuteProvisionedProductServiceActionRequest.Builderto create a request.- Returns:
- Result of the ExecuteProvisionedProductServiceAction operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getAWSOrganizationsAccessStatus
default GetAwsOrganizationsAccessStatusResponse getAWSOrganizationsAccessStatus(GetAwsOrganizationsAccessStatusRequest getAwsOrganizationsAccessStatusRequest) throws ResourceNotFoundException, OperationNotSupportedException, AwsServiceException, SdkClientException, ServiceCatalogException
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:
- Result of the GetAWSOrganizationsAccessStatus operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getAWSOrganizationsAccessStatus
default GetAwsOrganizationsAccessStatusResponse getAWSOrganizationsAccessStatus(Consumer<GetAwsOrganizationsAccessStatusRequest.Builder> getAwsOrganizationsAccessStatusRequest) throws ResourceNotFoundException, OperationNotSupportedException, AwsServiceException, SdkClientException, ServiceCatalogException
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.Builderavoiding the need to create one manually viaGetAwsOrganizationsAccessStatusRequest.builder()- Parameters:
getAwsOrganizationsAccessStatusRequest- AConsumerthat will call methods onGetAwsOrganizationsAccessStatusRequest.Builderto create a request.- Returns:
- Result of the GetAWSOrganizationsAccessStatus operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getAWSOrganizationsAccessStatus
default GetAwsOrganizationsAccessStatusResponse getAWSOrganizationsAccessStatus() throws ResourceNotFoundException, OperationNotSupportedException, AwsServiceException, SdkClientException, ServiceCatalogException
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:
- Result of the GetAWSOrganizationsAccessStatus operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
getAWSOrganizationsAccessStatus(GetAwsOrganizationsAccessStatusRequest), AWS API Documentation
-
getProvisionedProductOutputs
default GetProvisionedProductOutputsResponse getProvisionedProductOutputs(GetProvisionedProductOutputsRequest getProvisionedProductOutputsRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
This API takes either a
ProvisonedProductIdor aProvisionedProductName, along with a list of one or more output keys, and responds with the key/value pairs of those outputs.- Parameters:
getProvisionedProductOutputsRequest-- Returns:
- Result of the GetProvisionedProductOutputs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getProvisionedProductOutputs
default GetProvisionedProductOutputsResponse getProvisionedProductOutputs(Consumer<GetProvisionedProductOutputsRequest.Builder> getProvisionedProductOutputsRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
This API takes either a
ProvisonedProductIdor 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.Builderavoiding the need to create one manually viaGetProvisionedProductOutputsRequest.builder()- Parameters:
getProvisionedProductOutputsRequest- AConsumerthat will call methods onGetProvisionedProductOutputsRequest.Builderto create a request.- Returns:
- Result of the GetProvisionedProductOutputs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getProvisionedProductOutputsPaginator
default GetProvisionedProductOutputsIterable getProvisionedProductOutputsPaginator(GetProvisionedProductOutputsRequest getProvisionedProductOutputsRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
getProvisionedProductOutputs(software.amazon.awssdk.services.servicecatalog.model.GetProvisionedProductOutputsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.GetProvisionedProductOutputsIterable responses = client.getProvisionedProductOutputsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.GetProvisionedProductOutputsIterable responses = client .getProvisionedProductOutputsPaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.GetProvisionedProductOutputsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.GetProvisionedProductOutputsIterable responses = client.getProvisionedProductOutputsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getProvisionedProductOutputsPaginator
default GetProvisionedProductOutputsIterable getProvisionedProductOutputsPaginator(Consumer<GetProvisionedProductOutputsRequest.Builder> getProvisionedProductOutputsRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
getProvisionedProductOutputs(software.amazon.awssdk.services.servicecatalog.model.GetProvisionedProductOutputsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.GetProvisionedProductOutputsIterable responses = client.getProvisionedProductOutputsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.GetProvisionedProductOutputsIterable responses = client .getProvisionedProductOutputsPaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.GetProvisionedProductOutputsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.GetProvisionedProductOutputsIterable responses = client.getProvisionedProductOutputsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaGetProvisionedProductOutputsRequest.builder()- Parameters:
getProvisionedProductOutputsRequest- AConsumerthat will call methods onGetProvisionedProductOutputsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
importAsProvisionedProduct
default ImportAsProvisionedProductResponse importAsProvisionedProduct(ImportAsProvisionedProductRequest importAsProvisionedProductRequest) throws DuplicateResourceException, InvalidStateException, ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
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
UpdateProvisionedProductfor the provisioned product.The user or role that performs this operation must have the
cloudformation:GetTemplateandcloudformation:DescribeStacksIAM policy permissions.You can only import one provisioned product at a time. The product's CloudFormation stack must have the
IMPORT_COMPLETEstatus before you import another.- Parameters:
importAsProvisionedProductRequest-- Returns:
- Result of the ImportAsProvisionedProduct operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
importAsProvisionedProduct
default ImportAsProvisionedProductResponse importAsProvisionedProduct(Consumer<ImportAsProvisionedProductRequest.Builder> importAsProvisionedProductRequest) throws DuplicateResourceException, InvalidStateException, ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
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
UpdateProvisionedProductfor the provisioned product.The user or role that performs this operation must have the
cloudformation:GetTemplateandcloudformation:DescribeStacksIAM policy permissions.You can only import one provisioned product at a time. The product's CloudFormation stack must have the
IMPORT_COMPLETEstatus before you import another.
This is a convenience which creates an instance of the
ImportAsProvisionedProductRequest.Builderavoiding the need to create one manually viaImportAsProvisionedProductRequest.builder()- Parameters:
importAsProvisionedProductRequest- AConsumerthat will call methods onImportAsProvisionedProductRequest.Builderto create a request.- Returns:
- Result of the ImportAsProvisionedProduct operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAcceptedPortfolioShares
default ListAcceptedPortfolioSharesResponse listAcceptedPortfolioShares(ListAcceptedPortfolioSharesRequest listAcceptedPortfolioSharesRequest) throws InvalidParametersException, OperationNotSupportedException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists all imported portfolios for which account-to-account shares were accepted by this account. By specifying the
PortfolioShareType, you can list portfolios for which organizational shares were accepted by this account.- Parameters:
listAcceptedPortfolioSharesRequest-- Returns:
- Result of the ListAcceptedPortfolioShares operation returned by the service.
- Throws:
InvalidParametersException- One or more parameters provided to the operation are 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.AwsServiceException- See Also:
- AWS API Documentation
-
listAcceptedPortfolioShares
default ListAcceptedPortfolioSharesResponse listAcceptedPortfolioShares(Consumer<ListAcceptedPortfolioSharesRequest.Builder> listAcceptedPortfolioSharesRequest) throws InvalidParametersException, OperationNotSupportedException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists all imported portfolios for which account-to-account shares were accepted by this account. By specifying the
PortfolioShareType, you can list portfolios for which organizational shares were accepted by this account.
This is a convenience which creates an instance of the
ListAcceptedPortfolioSharesRequest.Builderavoiding the need to create one manually viaListAcceptedPortfolioSharesRequest.builder()- Parameters:
listAcceptedPortfolioSharesRequest- AConsumerthat will call methods onListAcceptedPortfolioSharesRequest.Builderto create a request.- Returns:
- Result of the ListAcceptedPortfolioShares operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAcceptedPortfolioShares
default ListAcceptedPortfolioSharesResponse listAcceptedPortfolioShares() throws InvalidParametersException, OperationNotSupportedException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists all imported portfolios for which account-to-account shares were accepted by this account. By specifying the
PortfolioShareType, you can list portfolios for which organizational shares were accepted by this account.- Returns:
- Result of the ListAcceptedPortfolioShares operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
listAcceptedPortfolioShares(ListAcceptedPortfolioSharesRequest), AWS API Documentation
-
listAcceptedPortfolioSharesPaginator
default ListAcceptedPortfolioSharesIterable listAcceptedPortfolioSharesPaginator() throws InvalidParametersException, OperationNotSupportedException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
listAcceptedPortfolioShares(software.amazon.awssdk.services.servicecatalog.model.ListAcceptedPortfolioSharesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.ListAcceptedPortfolioSharesIterable responses = client.listAcceptedPortfolioSharesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.ListAcceptedPortfolioSharesIterable responses = client .listAcceptedPortfolioSharesPaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.ListAcceptedPortfolioSharesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.ListAcceptedPortfolioSharesIterable responses = client.listAcceptedPortfolioSharesPaginator(request); responses.iterator().forEachRemaining(....);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
listAcceptedPortfolioShares(software.amazon.awssdk.services.servicecatalog.model.ListAcceptedPortfolioSharesRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
listAcceptedPortfolioSharesPaginator(ListAcceptedPortfolioSharesRequest), AWS API Documentation
-
listAcceptedPortfolioSharesPaginator
default ListAcceptedPortfolioSharesIterable listAcceptedPortfolioSharesPaginator(ListAcceptedPortfolioSharesRequest listAcceptedPortfolioSharesRequest) throws InvalidParametersException, OperationNotSupportedException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
listAcceptedPortfolioShares(software.amazon.awssdk.services.servicecatalog.model.ListAcceptedPortfolioSharesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.ListAcceptedPortfolioSharesIterable responses = client.listAcceptedPortfolioSharesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.ListAcceptedPortfolioSharesIterable responses = client .listAcceptedPortfolioSharesPaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.ListAcceptedPortfolioSharesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.ListAcceptedPortfolioSharesIterable responses = client.listAcceptedPortfolioSharesPaginator(request); responses.iterator().forEachRemaining(....);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
listAcceptedPortfolioShares(software.amazon.awssdk.services.servicecatalog.model.ListAcceptedPortfolioSharesRequest)operation.- Parameters:
listAcceptedPortfolioSharesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAcceptedPortfolioSharesPaginator
default ListAcceptedPortfolioSharesIterable listAcceptedPortfolioSharesPaginator(Consumer<ListAcceptedPortfolioSharesRequest.Builder> listAcceptedPortfolioSharesRequest) throws InvalidParametersException, OperationNotSupportedException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
listAcceptedPortfolioShares(software.amazon.awssdk.services.servicecatalog.model.ListAcceptedPortfolioSharesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.ListAcceptedPortfolioSharesIterable responses = client.listAcceptedPortfolioSharesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.ListAcceptedPortfolioSharesIterable responses = client .listAcceptedPortfolioSharesPaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.ListAcceptedPortfolioSharesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.ListAcceptedPortfolioSharesIterable responses = client.listAcceptedPortfolioSharesPaginator(request); responses.iterator().forEachRemaining(....);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
listAcceptedPortfolioShares(software.amazon.awssdk.services.servicecatalog.model.ListAcceptedPortfolioSharesRequest)operation.
This is a convenience which creates an instance of the
ListAcceptedPortfolioSharesRequest.Builderavoiding the need to create one manually viaListAcceptedPortfolioSharesRequest.builder()- Parameters:
listAcceptedPortfolioSharesRequest- AConsumerthat will call methods onListAcceptedPortfolioSharesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listBudgetsForResource
default ListBudgetsForResourceResponse listBudgetsForResource(ListBudgetsForResourceRequest listBudgetsForResourceRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists all the budgets associated to the specified resource.
- Parameters:
listBudgetsForResourceRequest-- Returns:
- Result of the ListBudgetsForResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listBudgetsForResource
default ListBudgetsForResourceResponse listBudgetsForResource(Consumer<ListBudgetsForResourceRequest.Builder> listBudgetsForResourceRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists all the budgets associated to the specified resource.
This is a convenience which creates an instance of the
ListBudgetsForResourceRequest.Builderavoiding the need to create one manually viaListBudgetsForResourceRequest.builder()- Parameters:
listBudgetsForResourceRequest- AConsumerthat will call methods onListBudgetsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListBudgetsForResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listBudgetsForResourcePaginator
default ListBudgetsForResourceIterable listBudgetsForResourcePaginator(ListBudgetsForResourceRequest listBudgetsForResourceRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
listBudgetsForResource(software.amazon.awssdk.services.servicecatalog.model.ListBudgetsForResourceRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.ListBudgetsForResourceIterable responses = client.listBudgetsForResourcePaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.ListBudgetsForResourceIterable responses = client .listBudgetsForResourcePaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.ListBudgetsForResourceResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.ListBudgetsForResourceIterable responses = client.listBudgetsForResourcePaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listBudgetsForResourcePaginator
default ListBudgetsForResourceIterable listBudgetsForResourcePaginator(Consumer<ListBudgetsForResourceRequest.Builder> listBudgetsForResourceRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
listBudgetsForResource(software.amazon.awssdk.services.servicecatalog.model.ListBudgetsForResourceRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.ListBudgetsForResourceIterable responses = client.listBudgetsForResourcePaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.ListBudgetsForResourceIterable responses = client .listBudgetsForResourcePaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.ListBudgetsForResourceResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.ListBudgetsForResourceIterable responses = client.listBudgetsForResourcePaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListBudgetsForResourceRequest.builder()- Parameters:
listBudgetsForResourceRequest- AConsumerthat will call methods onListBudgetsForResourceRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listConstraintsForPortfolio
default ListConstraintsForPortfolioResponse listConstraintsForPortfolio(ListConstraintsForPortfolioRequest listConstraintsForPortfolioRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists the constraints for the specified portfolio and product.
- Parameters:
listConstraintsForPortfolioRequest-- Returns:
- Result of the ListConstraintsForPortfolio operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource was not found.InvalidParametersException- One or more parameters provided to the operation are 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.AwsServiceException- See Also:
- AWS API Documentation
-
listConstraintsForPortfolio
default ListConstraintsForPortfolioResponse listConstraintsForPortfolio(Consumer<ListConstraintsForPortfolioRequest.Builder> listConstraintsForPortfolioRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists the constraints for the specified portfolio and product.
This is a convenience which creates an instance of the
ListConstraintsForPortfolioRequest.Builderavoiding the need to create one manually viaListConstraintsForPortfolioRequest.builder()- Parameters:
listConstraintsForPortfolioRequest- AConsumerthat will call methods onListConstraintsForPortfolioRequest.Builderto create a request.- Returns:
- Result of the ListConstraintsForPortfolio operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource was not found.InvalidParametersException- One or more parameters provided to the operation are 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.AwsServiceException- See Also:
- AWS API Documentation
-
listConstraintsForPortfolioPaginator
default ListConstraintsForPortfolioIterable listConstraintsForPortfolioPaginator(ListConstraintsForPortfolioRequest listConstraintsForPortfolioRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
listConstraintsForPortfolio(software.amazon.awssdk.services.servicecatalog.model.ListConstraintsForPortfolioRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.ListConstraintsForPortfolioIterable responses = client.listConstraintsForPortfolioPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.ListConstraintsForPortfolioIterable responses = client .listConstraintsForPortfolioPaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.ListConstraintsForPortfolioResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.ListConstraintsForPortfolioIterable responses = client.listConstraintsForPortfolioPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listConstraintsForPortfolioPaginator
default ListConstraintsForPortfolioIterable listConstraintsForPortfolioPaginator(Consumer<ListConstraintsForPortfolioRequest.Builder> listConstraintsForPortfolioRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
listConstraintsForPortfolio(software.amazon.awssdk.services.servicecatalog.model.ListConstraintsForPortfolioRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.ListConstraintsForPortfolioIterable responses = client.listConstraintsForPortfolioPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.ListConstraintsForPortfolioIterable responses = client .listConstraintsForPortfolioPaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.ListConstraintsForPortfolioResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.ListConstraintsForPortfolioIterable responses = client.listConstraintsForPortfolioPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListConstraintsForPortfolioRequest.builder()- Parameters:
listConstraintsForPortfolioRequest- AConsumerthat will call methods onListConstraintsForPortfolioRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listLaunchPaths
default ListLaunchPathsResponse listLaunchPaths(ListLaunchPathsRequest listLaunchPathsRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
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:
- Result of the ListLaunchPaths operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listLaunchPaths
default ListLaunchPathsResponse listLaunchPaths(Consumer<ListLaunchPathsRequest.Builder> listLaunchPathsRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
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.Builderavoiding the need to create one manually viaListLaunchPathsRequest.builder()- Parameters:
listLaunchPathsRequest- AConsumerthat will call methods onListLaunchPathsRequest.Builderto create a request.- Returns:
- Result of the ListLaunchPaths operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listLaunchPathsPaginator
default ListLaunchPathsIterable listLaunchPathsPaginator(ListLaunchPathsRequest listLaunchPathsRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
listLaunchPaths(software.amazon.awssdk.services.servicecatalog.model.ListLaunchPathsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.ListLaunchPathsIterable responses = client.listLaunchPathsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.ListLaunchPathsIterable responses = client .listLaunchPathsPaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.ListLaunchPathsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.ListLaunchPathsIterable responses = client.listLaunchPathsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listLaunchPathsPaginator
default ListLaunchPathsIterable listLaunchPathsPaginator(Consumer<ListLaunchPathsRequest.Builder> listLaunchPathsRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
listLaunchPaths(software.amazon.awssdk.services.servicecatalog.model.ListLaunchPathsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.ListLaunchPathsIterable responses = client.listLaunchPathsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.ListLaunchPathsIterable responses = client .listLaunchPathsPaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.ListLaunchPathsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.ListLaunchPathsIterable responses = client.listLaunchPathsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListLaunchPathsRequest.builder()- Parameters:
listLaunchPathsRequest- AConsumerthat will call methods onListLaunchPathsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listOrganizationPortfolioAccess
default ListOrganizationPortfolioAccessResponse listOrganizationPortfolioAccess(ListOrganizationPortfolioAccessRequest listOrganizationPortfolioAccessRequest) throws ResourceNotFoundException, InvalidParametersException, OperationNotSupportedException, AwsServiceException, SdkClientException, ServiceCatalogException
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:
- Result of the ListOrganizationPortfolioAccess operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listOrganizationPortfolioAccess
default ListOrganizationPortfolioAccessResponse listOrganizationPortfolioAccess(Consumer<ListOrganizationPortfolioAccessRequest.Builder> listOrganizationPortfolioAccessRequest) throws ResourceNotFoundException, InvalidParametersException, OperationNotSupportedException, AwsServiceException, SdkClientException, ServiceCatalogException
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.Builderavoiding the need to create one manually viaListOrganizationPortfolioAccessRequest.builder()- Parameters:
listOrganizationPortfolioAccessRequest- AConsumerthat will call methods onListOrganizationPortfolioAccessRequest.Builderto create a request.- Returns:
- Result of the ListOrganizationPortfolioAccess operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listOrganizationPortfolioAccessPaginator
default ListOrganizationPortfolioAccessIterable listOrganizationPortfolioAccessPaginator(ListOrganizationPortfolioAccessRequest listOrganizationPortfolioAccessRequest) throws ResourceNotFoundException, InvalidParametersException, OperationNotSupportedException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
listOrganizationPortfolioAccess(software.amazon.awssdk.services.servicecatalog.model.ListOrganizationPortfolioAccessRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.ListOrganizationPortfolioAccessIterable responses = client.listOrganizationPortfolioAccessPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.ListOrganizationPortfolioAccessIterable responses = client .listOrganizationPortfolioAccessPaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.ListOrganizationPortfolioAccessResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.ListOrganizationPortfolioAccessIterable responses = client.listOrganizationPortfolioAccessPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listOrganizationPortfolioAccessPaginator
default ListOrganizationPortfolioAccessIterable listOrganizationPortfolioAccessPaginator(Consumer<ListOrganizationPortfolioAccessRequest.Builder> listOrganizationPortfolioAccessRequest) throws ResourceNotFoundException, InvalidParametersException, OperationNotSupportedException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
listOrganizationPortfolioAccess(software.amazon.awssdk.services.servicecatalog.model.ListOrganizationPortfolioAccessRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.ListOrganizationPortfolioAccessIterable responses = client.listOrganizationPortfolioAccessPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.ListOrganizationPortfolioAccessIterable responses = client .listOrganizationPortfolioAccessPaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.ListOrganizationPortfolioAccessResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.ListOrganizationPortfolioAccessIterable responses = client.listOrganizationPortfolioAccessPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListOrganizationPortfolioAccessRequest.builder()- Parameters:
listOrganizationPortfolioAccessRequest- AConsumerthat will call methods onListOrganizationPortfolioAccessRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listPortfolioAccess
default ListPortfolioAccessResponse listPortfolioAccess(ListPortfolioAccessRequest listPortfolioAccessRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
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:
- Result of the ListPortfolioAccess operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listPortfolioAccess
default ListPortfolioAccessResponse listPortfolioAccess(Consumer<ListPortfolioAccessRequest.Builder> listPortfolioAccessRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
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.Builderavoiding the need to create one manually viaListPortfolioAccessRequest.builder()- Parameters:
listPortfolioAccessRequest- AConsumerthat will call methods onListPortfolioAccessRequest.Builderto create a request.- Returns:
- Result of the ListPortfolioAccess operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listPortfolioAccessPaginator
default ListPortfolioAccessIterable listPortfolioAccessPaginator(ListPortfolioAccessRequest listPortfolioAccessRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
listPortfolioAccess(software.amazon.awssdk.services.servicecatalog.model.ListPortfolioAccessRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.ListPortfolioAccessIterable responses = client.listPortfolioAccessPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.ListPortfolioAccessIterable responses = client .listPortfolioAccessPaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.ListPortfolioAccessResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.ListPortfolioAccessIterable responses = client.listPortfolioAccessPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listPortfolioAccessPaginator
default ListPortfolioAccessIterable listPortfolioAccessPaginator(Consumer<ListPortfolioAccessRequest.Builder> listPortfolioAccessRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
listPortfolioAccess(software.amazon.awssdk.services.servicecatalog.model.ListPortfolioAccessRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.ListPortfolioAccessIterable responses = client.listPortfolioAccessPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.ListPortfolioAccessIterable responses = client .listPortfolioAccessPaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.ListPortfolioAccessResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.ListPortfolioAccessIterable responses = client.listPortfolioAccessPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListPortfolioAccessRequest.builder()- Parameters:
listPortfolioAccessRequest- AConsumerthat will call methods onListPortfolioAccessRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listPortfolios
default ListPortfoliosResponse listPortfolios(ListPortfoliosRequest listPortfoliosRequest) throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists all portfolios in the catalog.
- Parameters:
listPortfoliosRequest-- Returns:
- Result of the ListPortfolios operation returned by the service.
- Throws:
InvalidParametersException- One or more parameters provided to the operation are 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.AwsServiceException- See Also:
- AWS API Documentation
-
listPortfolios
default ListPortfoliosResponse listPortfolios(Consumer<ListPortfoliosRequest.Builder> listPortfoliosRequest) throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists all portfolios in the catalog.
This is a convenience which creates an instance of the
ListPortfoliosRequest.Builderavoiding the need to create one manually viaListPortfoliosRequest.builder()- Parameters:
listPortfoliosRequest- AConsumerthat will call methods onListPortfoliosRequest.Builderto create a request.- Returns:
- Result of the ListPortfolios operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listPortfolios
default ListPortfoliosResponse listPortfolios() throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists all portfolios in the catalog.
- Returns:
- Result of the ListPortfolios operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
listPortfolios(ListPortfoliosRequest), AWS API Documentation
-
listPortfoliosPaginator
default ListPortfoliosIterable listPortfoliosPaginator() throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
listPortfolios(software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.ListPortfoliosIterable responses = client.listPortfoliosPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.ListPortfoliosIterable responses = client .listPortfoliosPaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.ListPortfoliosIterable responses = client.listPortfoliosPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
listPortfoliosPaginator(ListPortfoliosRequest), AWS API Documentation
-
listPortfoliosPaginator
default ListPortfoliosIterable listPortfoliosPaginator(ListPortfoliosRequest listPortfoliosRequest) throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
listPortfolios(software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.ListPortfoliosIterable responses = client.listPortfoliosPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.ListPortfoliosIterable responses = client .listPortfoliosPaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.ListPortfoliosIterable responses = client.listPortfoliosPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listPortfoliosPaginator
default ListPortfoliosIterable listPortfoliosPaginator(Consumer<ListPortfoliosRequest.Builder> listPortfoliosRequest) throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
listPortfolios(software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.ListPortfoliosIterable responses = client.listPortfoliosPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.ListPortfoliosIterable responses = client .listPortfoliosPaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.ListPortfoliosIterable responses = client.listPortfoliosPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListPortfoliosRequest.builder()- Parameters:
listPortfoliosRequest- AConsumerthat will call methods onListPortfoliosRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listPortfoliosForProduct
default ListPortfoliosForProductResponse listPortfoliosForProduct(ListPortfoliosForProductRequest listPortfoliosForProductRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists all portfolios that the specified product is associated with.
- Parameters:
listPortfoliosForProductRequest-- Returns:
- Result of the ListPortfoliosForProduct operation returned by the service.
- Throws:
InvalidParametersException- One or more parameters provided to the operation are 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.AwsServiceException- See Also:
- AWS API Documentation
-
listPortfoliosForProduct
default ListPortfoliosForProductResponse listPortfoliosForProduct(Consumer<ListPortfoliosForProductRequest.Builder> listPortfoliosForProductRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists all portfolios that the specified product is associated with.
This is a convenience which creates an instance of the
ListPortfoliosForProductRequest.Builderavoiding the need to create one manually viaListPortfoliosForProductRequest.builder()- Parameters:
listPortfoliosForProductRequest- AConsumerthat will call methods onListPortfoliosForProductRequest.Builderto create a request.- Returns:
- Result of the ListPortfoliosForProduct operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listPortfoliosForProductPaginator
default ListPortfoliosForProductIterable listPortfoliosForProductPaginator(ListPortfoliosForProductRequest listPortfoliosForProductRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
listPortfoliosForProduct(software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosForProductRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.ListPortfoliosForProductIterable responses = client.listPortfoliosForProductPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.ListPortfoliosForProductIterable responses = client .listPortfoliosForProductPaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosForProductResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.ListPortfoliosForProductIterable responses = client.listPortfoliosForProductPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listPortfoliosForProductPaginator
default ListPortfoliosForProductIterable listPortfoliosForProductPaginator(Consumer<ListPortfoliosForProductRequest.Builder> listPortfoliosForProductRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
listPortfoliosForProduct(software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosForProductRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.ListPortfoliosForProductIterable responses = client.listPortfoliosForProductPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.ListPortfoliosForProductIterable responses = client .listPortfoliosForProductPaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.ListPortfoliosForProductResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.ListPortfoliosForProductIterable responses = client.listPortfoliosForProductPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListPortfoliosForProductRequest.builder()- Parameters:
listPortfoliosForProductRequest- AConsumerthat will call methods onListPortfoliosForProductRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listPrincipalsForPortfolio
default ListPrincipalsForPortfolioResponse listPrincipalsForPortfolio(ListPrincipalsForPortfolioRequest listPrincipalsForPortfolioRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists all
PrincipalARNs and correspondingPrincipalTypes associated with the specified portfolio.- Parameters:
listPrincipalsForPortfolioRequest-- Returns:
- Result of the ListPrincipalsForPortfolio operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource was not found.InvalidParametersException- One or more parameters provided to the operation are 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.AwsServiceException- See Also:
- AWS API Documentation
-
listPrincipalsForPortfolio
default ListPrincipalsForPortfolioResponse listPrincipalsForPortfolio(Consumer<ListPrincipalsForPortfolioRequest.Builder> listPrincipalsForPortfolioRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists all
PrincipalARNs and correspondingPrincipalTypes associated with the specified portfolio.
This is a convenience which creates an instance of the
ListPrincipalsForPortfolioRequest.Builderavoiding the need to create one manually viaListPrincipalsForPortfolioRequest.builder()- Parameters:
listPrincipalsForPortfolioRequest- AConsumerthat will call methods onListPrincipalsForPortfolioRequest.Builderto create a request.- Returns:
- Result of the ListPrincipalsForPortfolio operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource was not found.InvalidParametersException- One or more parameters provided to the operation are 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.AwsServiceException- See Also:
- AWS API Documentation
-
listPrincipalsForPortfolioPaginator
default ListPrincipalsForPortfolioIterable listPrincipalsForPortfolioPaginator(ListPrincipalsForPortfolioRequest listPrincipalsForPortfolioRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
listPrincipalsForPortfolio(software.amazon.awssdk.services.servicecatalog.model.ListPrincipalsForPortfolioRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.ListPrincipalsForPortfolioIterable responses = client.listPrincipalsForPortfolioPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.ListPrincipalsForPortfolioIterable responses = client .listPrincipalsForPortfolioPaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.ListPrincipalsForPortfolioResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.ListPrincipalsForPortfolioIterable responses = client.listPrincipalsForPortfolioPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listPrincipalsForPortfolioPaginator
default ListPrincipalsForPortfolioIterable listPrincipalsForPortfolioPaginator(Consumer<ListPrincipalsForPortfolioRequest.Builder> listPrincipalsForPortfolioRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
listPrincipalsForPortfolio(software.amazon.awssdk.services.servicecatalog.model.ListPrincipalsForPortfolioRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.ListPrincipalsForPortfolioIterable responses = client.listPrincipalsForPortfolioPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.ListPrincipalsForPortfolioIterable responses = client .listPrincipalsForPortfolioPaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.ListPrincipalsForPortfolioResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.ListPrincipalsForPortfolioIterable responses = client.listPrincipalsForPortfolioPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListPrincipalsForPortfolioRequest.builder()- Parameters:
listPrincipalsForPortfolioRequest- AConsumerthat will call methods onListPrincipalsForPortfolioRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listProvisionedProductPlans
default ListProvisionedProductPlansResponse listProvisionedProductPlans(ListProvisionedProductPlansRequest listProvisionedProductPlansRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists the plans for the specified provisioned product or all plans to which the user has access.
- Parameters:
listProvisionedProductPlansRequest-- Returns:
- Result of the ListProvisionedProductPlans operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listProvisionedProductPlans
default ListProvisionedProductPlansResponse listProvisionedProductPlans(Consumer<ListProvisionedProductPlansRequest.Builder> listProvisionedProductPlansRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
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.Builderavoiding the need to create one manually viaListProvisionedProductPlansRequest.builder()- Parameters:
listProvisionedProductPlansRequest- AConsumerthat will call methods onListProvisionedProductPlansRequest.Builderto create a request.- Returns:
- Result of the ListProvisionedProductPlans operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listProvisionedProductPlans
default ListProvisionedProductPlansResponse listProvisionedProductPlans() throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists the plans for the specified provisioned product or all plans to which the user has access.
- Returns:
- Result of the ListProvisionedProductPlans operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
listProvisionedProductPlans(ListProvisionedProductPlansRequest), AWS API Documentation
-
listProvisioningArtifacts
default ListProvisioningArtifactsResponse listProvisioningArtifacts(ListProvisioningArtifactsRequest listProvisioningArtifactsRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists all provisioning artifacts (also known as versions) for the specified product.
- Parameters:
listProvisioningArtifactsRequest-- Returns:
- Result of the ListProvisioningArtifacts operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource was not found.InvalidParametersException- One or more parameters provided to the operation are 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.AwsServiceException- See Also:
- AWS API Documentation
-
listProvisioningArtifacts
default ListProvisioningArtifactsResponse listProvisioningArtifacts(Consumer<ListProvisioningArtifactsRequest.Builder> listProvisioningArtifactsRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists all provisioning artifacts (also known as versions) for the specified product.
This is a convenience which creates an instance of the
ListProvisioningArtifactsRequest.Builderavoiding the need to create one manually viaListProvisioningArtifactsRequest.builder()- Parameters:
listProvisioningArtifactsRequest- AConsumerthat will call methods onListProvisioningArtifactsRequest.Builderto create a request.- Returns:
- Result of the ListProvisioningArtifacts operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource was not found.InvalidParametersException- One or more parameters provided to the operation are 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.AwsServiceException- See Also:
- AWS API Documentation
-
listProvisioningArtifactsForServiceAction
default ListProvisioningArtifactsForServiceActionResponse listProvisioningArtifactsForServiceAction(ListProvisioningArtifactsForServiceActionRequest listProvisioningArtifactsForServiceActionRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists all provisioning artifacts (also known as versions) for the specified self-service action.
- Parameters:
listProvisioningArtifactsForServiceActionRequest-- Returns:
- Result of the ListProvisioningArtifactsForServiceAction operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listProvisioningArtifactsForServiceAction
default ListProvisioningArtifactsForServiceActionResponse listProvisioningArtifactsForServiceAction(Consumer<ListProvisioningArtifactsForServiceActionRequest.Builder> listProvisioningArtifactsForServiceActionRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
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.Builderavoiding the need to create one manually viaListProvisioningArtifactsForServiceActionRequest.builder()- Parameters:
listProvisioningArtifactsForServiceActionRequest- AConsumerthat will call methods onListProvisioningArtifactsForServiceActionRequest.Builderto create a request.- Returns:
- Result of the ListProvisioningArtifactsForServiceAction operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listProvisioningArtifactsForServiceActionPaginator
default ListProvisioningArtifactsForServiceActionIterable listProvisioningArtifactsForServiceActionPaginator(ListProvisioningArtifactsForServiceActionRequest listProvisioningArtifactsForServiceActionRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
listProvisioningArtifactsForServiceAction(software.amazon.awssdk.services.servicecatalog.model.ListProvisioningArtifactsForServiceActionRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.ListProvisioningArtifactsForServiceActionIterable responses = client.listProvisioningArtifactsForServiceActionPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.ListProvisioningArtifactsForServiceActionIterable responses = client .listProvisioningArtifactsForServiceActionPaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.ListProvisioningArtifactsForServiceActionResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.ListProvisioningArtifactsForServiceActionIterable responses = client.listProvisioningArtifactsForServiceActionPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listProvisioningArtifactsForServiceActionPaginator
default ListProvisioningArtifactsForServiceActionIterable listProvisioningArtifactsForServiceActionPaginator(Consumer<ListProvisioningArtifactsForServiceActionRequest.Builder> listProvisioningArtifactsForServiceActionRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
listProvisioningArtifactsForServiceAction(software.amazon.awssdk.services.servicecatalog.model.ListProvisioningArtifactsForServiceActionRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.ListProvisioningArtifactsForServiceActionIterable responses = client.listProvisioningArtifactsForServiceActionPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.ListProvisioningArtifactsForServiceActionIterable responses = client .listProvisioningArtifactsForServiceActionPaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.ListProvisioningArtifactsForServiceActionResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.ListProvisioningArtifactsForServiceActionIterable responses = client.listProvisioningArtifactsForServiceActionPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListProvisioningArtifactsForServiceActionRequest.builder()- Parameters:
listProvisioningArtifactsForServiceActionRequest- AConsumerthat will call methods onListProvisioningArtifactsForServiceActionRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listRecordHistory
default ListRecordHistoryResponse listRecordHistory(ListRecordHistoryRequest listRecordHistoryRequest) throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists the specified requests or all performed requests.
- Parameters:
listRecordHistoryRequest-- Returns:
- Result of the ListRecordHistory operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listRecordHistory
default ListRecordHistoryResponse listRecordHistory(Consumer<ListRecordHistoryRequest.Builder> listRecordHistoryRequest) throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists the specified requests or all performed requests.
This is a convenience which creates an instance of the
ListRecordHistoryRequest.Builderavoiding the need to create one manually viaListRecordHistoryRequest.builder()- Parameters:
listRecordHistoryRequest- AConsumerthat will call methods onListRecordHistoryRequest.Builderto create a request.- Returns:
- Result of the ListRecordHistory operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listRecordHistory
default ListRecordHistoryResponse listRecordHistory() throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists the specified requests or all performed requests.
- Returns:
- Result of the ListRecordHistory operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
listRecordHistory(ListRecordHistoryRequest), AWS API Documentation
-
listResourcesForTagOption
default ListResourcesForTagOptionResponse listResourcesForTagOption(ListResourcesForTagOptionRequest listResourcesForTagOptionRequest) throws TagOptionNotMigratedException, ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists the resources associated with the specified TagOption.
- Parameters:
listResourcesForTagOptionRequest-- Returns:
- Result of the ListResourcesForTagOption operation returned by the service.
- Throws:
TagOptionNotMigratedException- An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. 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.AwsServiceException- See Also:
- AWS API Documentation
-
listResourcesForTagOption
default ListResourcesForTagOptionResponse listResourcesForTagOption(Consumer<ListResourcesForTagOptionRequest.Builder> listResourcesForTagOptionRequest) throws TagOptionNotMigratedException, ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists the resources associated with the specified TagOption.
This is a convenience which creates an instance of the
ListResourcesForTagOptionRequest.Builderavoiding the need to create one manually viaListResourcesForTagOptionRequest.builder()- Parameters:
listResourcesForTagOptionRequest- AConsumerthat will call methods onListResourcesForTagOptionRequest.Builderto create a request.- Returns:
- Result of the ListResourcesForTagOption operation returned by the service.
- Throws:
TagOptionNotMigratedException- An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. 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.AwsServiceException- See Also:
- AWS API Documentation
-
listResourcesForTagOptionPaginator
default ListResourcesForTagOptionIterable listResourcesForTagOptionPaginator(ListResourcesForTagOptionRequest listResourcesForTagOptionRequest) throws TagOptionNotMigratedException, ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
listResourcesForTagOption(software.amazon.awssdk.services.servicecatalog.model.ListResourcesForTagOptionRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.ListResourcesForTagOptionIterable responses = client.listResourcesForTagOptionPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.ListResourcesForTagOptionIterable responses = client .listResourcesForTagOptionPaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.ListResourcesForTagOptionResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.ListResourcesForTagOptionIterable responses = client.listResourcesForTagOptionPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listResourcesForTagOptionPaginator
default ListResourcesForTagOptionIterable listResourcesForTagOptionPaginator(Consumer<ListResourcesForTagOptionRequest.Builder> listResourcesForTagOptionRequest) throws TagOptionNotMigratedException, ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
listResourcesForTagOption(software.amazon.awssdk.services.servicecatalog.model.ListResourcesForTagOptionRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.ListResourcesForTagOptionIterable responses = client.listResourcesForTagOptionPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.ListResourcesForTagOptionIterable responses = client .listResourcesForTagOptionPaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.ListResourcesForTagOptionResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.ListResourcesForTagOptionIterable responses = client.listResourcesForTagOptionPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListResourcesForTagOptionRequest.builder()- Parameters:
listResourcesForTagOptionRequest- AConsumerthat will call methods onListResourcesForTagOptionRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listServiceActions
default ListServiceActionsResponse listServiceActions(ListServiceActionsRequest listServiceActionsRequest) throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists all self-service actions.
- Parameters:
listServiceActionsRequest-- Returns:
- Result of the ListServiceActions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listServiceActions
default ListServiceActionsResponse listServiceActions(Consumer<ListServiceActionsRequest.Builder> listServiceActionsRequest) throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists all self-service actions.
This is a convenience which creates an instance of the
ListServiceActionsRequest.Builderavoiding the need to create one manually viaListServiceActionsRequest.builder()- Parameters:
listServiceActionsRequest- AConsumerthat will call methods onListServiceActionsRequest.Builderto create a request.- Returns:
- Result of the ListServiceActions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listServiceActions
default ListServiceActionsResponse listServiceActions() throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists all self-service actions.
- Returns:
- Result of the ListServiceActions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
listServiceActions(ListServiceActionsRequest), AWS API Documentation
-
listServiceActionsPaginator
default ListServiceActionsIterable listServiceActionsPaginator() throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
listServiceActions(software.amazon.awssdk.services.servicecatalog.model.ListServiceActionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.ListServiceActionsIterable responses = client.listServiceActionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.ListServiceActionsIterable responses = client .listServiceActionsPaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.ListServiceActionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.ListServiceActionsIterable responses = client.listServiceActionsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
listServiceActionsPaginator(ListServiceActionsRequest), AWS API Documentation
-
listServiceActionsPaginator
default ListServiceActionsIterable listServiceActionsPaginator(ListServiceActionsRequest listServiceActionsRequest) throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
listServiceActions(software.amazon.awssdk.services.servicecatalog.model.ListServiceActionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.ListServiceActionsIterable responses = client.listServiceActionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.ListServiceActionsIterable responses = client .listServiceActionsPaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.ListServiceActionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.ListServiceActionsIterable responses = client.listServiceActionsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listServiceActionsPaginator
default ListServiceActionsIterable listServiceActionsPaginator(Consumer<ListServiceActionsRequest.Builder> listServiceActionsRequest) throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
listServiceActions(software.amazon.awssdk.services.servicecatalog.model.ListServiceActionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.ListServiceActionsIterable responses = client.listServiceActionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.ListServiceActionsIterable responses = client .listServiceActionsPaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.ListServiceActionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.ListServiceActionsIterable responses = client.listServiceActionsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListServiceActionsRequest.builder()- Parameters:
listServiceActionsRequest- AConsumerthat will call methods onListServiceActionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listServiceActionsForProvisioningArtifact
default ListServiceActionsForProvisioningArtifactResponse listServiceActionsForProvisioningArtifact(ListServiceActionsForProvisioningArtifactRequest listServiceActionsForProvisioningArtifactRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Returns a paginated list of self-service actions associated with the specified Product ID and Provisioning Artifact ID.
- Parameters:
listServiceActionsForProvisioningArtifactRequest-- Returns:
- Result of the ListServiceActionsForProvisioningArtifact operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listServiceActionsForProvisioningArtifact
default ListServiceActionsForProvisioningArtifactResponse listServiceActionsForProvisioningArtifact(Consumer<ListServiceActionsForProvisioningArtifactRequest.Builder> listServiceActionsForProvisioningArtifactRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
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.Builderavoiding the need to create one manually viaListServiceActionsForProvisioningArtifactRequest.builder()- Parameters:
listServiceActionsForProvisioningArtifactRequest- AConsumerthat will call methods onListServiceActionsForProvisioningArtifactRequest.Builderto create a request.- Returns:
- Result of the ListServiceActionsForProvisioningArtifact operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listServiceActionsForProvisioningArtifactPaginator
default ListServiceActionsForProvisioningArtifactIterable listServiceActionsForProvisioningArtifactPaginator(ListServiceActionsForProvisioningArtifactRequest listServiceActionsForProvisioningArtifactRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
listServiceActionsForProvisioningArtifact(software.amazon.awssdk.services.servicecatalog.model.ListServiceActionsForProvisioningArtifactRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.ListServiceActionsForProvisioningArtifactIterable responses = client.listServiceActionsForProvisioningArtifactPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.ListServiceActionsForProvisioningArtifactIterable responses = client .listServiceActionsForProvisioningArtifactPaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.ListServiceActionsForProvisioningArtifactResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.ListServiceActionsForProvisioningArtifactIterable responses = client.listServiceActionsForProvisioningArtifactPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listServiceActionsForProvisioningArtifactPaginator
default ListServiceActionsForProvisioningArtifactIterable listServiceActionsForProvisioningArtifactPaginator(Consumer<ListServiceActionsForProvisioningArtifactRequest.Builder> listServiceActionsForProvisioningArtifactRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
listServiceActionsForProvisioningArtifact(software.amazon.awssdk.services.servicecatalog.model.ListServiceActionsForProvisioningArtifactRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.ListServiceActionsForProvisioningArtifactIterable responses = client.listServiceActionsForProvisioningArtifactPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.ListServiceActionsForProvisioningArtifactIterable responses = client .listServiceActionsForProvisioningArtifactPaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.ListServiceActionsForProvisioningArtifactResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.ListServiceActionsForProvisioningArtifactIterable responses = client.listServiceActionsForProvisioningArtifactPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListServiceActionsForProvisioningArtifactRequest.builder()- Parameters:
listServiceActionsForProvisioningArtifactRequest- AConsumerthat will call methods onListServiceActionsForProvisioningArtifactRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listStackInstancesForProvisionedProduct
default ListStackInstancesForProvisionedProductResponse listStackInstancesForProvisionedProduct(ListStackInstancesForProvisionedProductRequest listStackInstancesForProvisionedProductRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Returns summary information about stack instances that are associated with the specified
CFN_STACKSETtype provisioned product. You can filter for stack instances that are associated with a specific Amazon Web Services account name or Region.- Parameters:
listStackInstancesForProvisionedProductRequest-- Returns:
- Result of the ListStackInstancesForProvisionedProduct operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listStackInstancesForProvisionedProduct
default ListStackInstancesForProvisionedProductResponse listStackInstancesForProvisionedProduct(Consumer<ListStackInstancesForProvisionedProductRequest.Builder> listStackInstancesForProvisionedProductRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Returns summary information about stack instances that are associated with the specified
CFN_STACKSETtype 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.Builderavoiding the need to create one manually viaListStackInstancesForProvisionedProductRequest.builder()- Parameters:
listStackInstancesForProvisionedProductRequest- AConsumerthat will call methods onListStackInstancesForProvisionedProductRequest.Builderto create a request.- Returns:
- Result of the ListStackInstancesForProvisionedProduct operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagOptions
default ListTagOptionsResponse listTagOptions(ListTagOptionsRequest listTagOptionsRequest) throws TagOptionNotMigratedException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists the specified TagOptions or all TagOptions.
- Parameters:
listTagOptionsRequest-- Returns:
- Result of the ListTagOptions operation returned by the service.
- Throws:
TagOptionNotMigratedException- An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagOptions
default ListTagOptionsResponse listTagOptions(Consumer<ListTagOptionsRequest.Builder> listTagOptionsRequest) throws TagOptionNotMigratedException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists the specified TagOptions or all TagOptions.
This is a convenience which creates an instance of the
ListTagOptionsRequest.Builderavoiding the need to create one manually viaListTagOptionsRequest.builder()- Parameters:
listTagOptionsRequest- AConsumerthat will call methods onListTagOptionsRequest.Builderto create a request.- Returns:
- Result of the ListTagOptions operation returned by the service.
- Throws:
TagOptionNotMigratedException- An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagOptions
default ListTagOptionsResponse listTagOptions() throws TagOptionNotMigratedException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists the specified TagOptions or all TagOptions.
- Returns:
- Result of the ListTagOptions operation returned by the service.
- Throws:
TagOptionNotMigratedException- An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. 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.AwsServiceException- See Also:
listTagOptions(ListTagOptionsRequest), AWS API Documentation
-
listTagOptionsPaginator
default ListTagOptionsIterable listTagOptionsPaginator() throws TagOptionNotMigratedException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
listTagOptions(software.amazon.awssdk.services.servicecatalog.model.ListTagOptionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.ListTagOptionsIterable responses = client.listTagOptionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.ListTagOptionsIterable responses = client .listTagOptionsPaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.ListTagOptionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.ListTagOptionsIterable responses = client.listTagOptionsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
listTagOptionsPaginator(ListTagOptionsRequest), AWS API Documentation
-
listTagOptionsPaginator
default ListTagOptionsIterable listTagOptionsPaginator(ListTagOptionsRequest listTagOptionsRequest) throws TagOptionNotMigratedException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
listTagOptions(software.amazon.awssdk.services.servicecatalog.model.ListTagOptionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.ListTagOptionsIterable responses = client.listTagOptionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.ListTagOptionsIterable responses = client .listTagOptionsPaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.ListTagOptionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.ListTagOptionsIterable responses = client.listTagOptionsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagOptionsPaginator
default ListTagOptionsIterable listTagOptionsPaginator(Consumer<ListTagOptionsRequest.Builder> listTagOptionsRequest) throws TagOptionNotMigratedException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
listTagOptions(software.amazon.awssdk.services.servicecatalog.model.ListTagOptionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.ListTagOptionsIterable responses = client.listTagOptionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.ListTagOptionsIterable responses = client .listTagOptionsPaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.ListTagOptionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.ListTagOptionsIterable responses = client.listTagOptionsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListTagOptionsRequest.builder()- Parameters:
listTagOptionsRequest- AConsumerthat will call methods onListTagOptionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
notifyProvisionProductEngineWorkflowResult
default NotifyProvisionProductEngineWorkflowResultResponse notifyProvisionProductEngineWorkflowResult(NotifyProvisionProductEngineWorkflowResultRequest notifyProvisionProductEngineWorkflowResultRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Notifies the result of the provisioning engine execution.
- Parameters:
notifyProvisionProductEngineWorkflowResultRequest-- Returns:
- Result of the NotifyProvisionProductEngineWorkflowResult operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
notifyProvisionProductEngineWorkflowResult
default NotifyProvisionProductEngineWorkflowResultResponse notifyProvisionProductEngineWorkflowResult(Consumer<NotifyProvisionProductEngineWorkflowResultRequest.Builder> notifyProvisionProductEngineWorkflowResultRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Notifies the result of the provisioning engine execution.
This is a convenience which creates an instance of the
NotifyProvisionProductEngineWorkflowResultRequest.Builderavoiding the need to create one manually viaNotifyProvisionProductEngineWorkflowResultRequest.builder()- Parameters:
notifyProvisionProductEngineWorkflowResultRequest- AConsumerthat will call methods onNotifyProvisionProductEngineWorkflowResultRequest.Builderto create a request.- Returns:
- Result of the NotifyProvisionProductEngineWorkflowResult operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
notifyTerminateProvisionedProductEngineWorkflowResult
default NotifyTerminateProvisionedProductEngineWorkflowResultResponse notifyTerminateProvisionedProductEngineWorkflowResult(NotifyTerminateProvisionedProductEngineWorkflowResultRequest notifyTerminateProvisionedProductEngineWorkflowResultRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Notifies the result of the terminate engine execution.
- Parameters:
notifyTerminateProvisionedProductEngineWorkflowResultRequest-- Returns:
- Result of the NotifyTerminateProvisionedProductEngineWorkflowResult operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
notifyTerminateProvisionedProductEngineWorkflowResult
default NotifyTerminateProvisionedProductEngineWorkflowResultResponse notifyTerminateProvisionedProductEngineWorkflowResult(Consumer<NotifyTerminateProvisionedProductEngineWorkflowResultRequest.Builder> notifyTerminateProvisionedProductEngineWorkflowResultRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Notifies the result of the terminate engine execution.
This is a convenience which creates an instance of the
NotifyTerminateProvisionedProductEngineWorkflowResultRequest.Builderavoiding the need to create one manually viaNotifyTerminateProvisionedProductEngineWorkflowResultRequest.builder()- Parameters:
notifyTerminateProvisionedProductEngineWorkflowResultRequest- AConsumerthat will call methods onNotifyTerminateProvisionedProductEngineWorkflowResultRequest.Builderto create a request.- Returns:
- Result of the NotifyTerminateProvisionedProductEngineWorkflowResult operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
notifyUpdateProvisionedProductEngineWorkflowResult
default NotifyUpdateProvisionedProductEngineWorkflowResultResponse notifyUpdateProvisionedProductEngineWorkflowResult(NotifyUpdateProvisionedProductEngineWorkflowResultRequest notifyUpdateProvisionedProductEngineWorkflowResultRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Notifies the result of the update engine execution.
- Parameters:
notifyUpdateProvisionedProductEngineWorkflowResultRequest-- Returns:
- Result of the NotifyUpdateProvisionedProductEngineWorkflowResult operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
notifyUpdateProvisionedProductEngineWorkflowResult
default NotifyUpdateProvisionedProductEngineWorkflowResultResponse notifyUpdateProvisionedProductEngineWorkflowResult(Consumer<NotifyUpdateProvisionedProductEngineWorkflowResultRequest.Builder> notifyUpdateProvisionedProductEngineWorkflowResultRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Notifies the result of the update engine execution.
This is a convenience which creates an instance of the
NotifyUpdateProvisionedProductEngineWorkflowResultRequest.Builderavoiding the need to create one manually viaNotifyUpdateProvisionedProductEngineWorkflowResultRequest.builder()- Parameters:
notifyUpdateProvisionedProductEngineWorkflowResultRequest- AConsumerthat will call methods onNotifyUpdateProvisionedProductEngineWorkflowResultRequest.Builderto create a request.- Returns:
- Result of the NotifyUpdateProvisionedProductEngineWorkflowResult operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
provisionProduct
default ProvisionProductResponse provisionProduct(ProvisionProductRequest provisionProductRequest) throws InvalidParametersException, ResourceNotFoundException, DuplicateResourceException, AwsServiceException, SdkClientException, ServiceCatalogException
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:
- Result of the ProvisionProduct operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
provisionProduct
default ProvisionProductResponse provisionProduct(Consumer<ProvisionProductRequest.Builder> provisionProductRequest) throws InvalidParametersException, ResourceNotFoundException, DuplicateResourceException, AwsServiceException, SdkClientException, ServiceCatalogException
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.Builderavoiding the need to create one manually viaProvisionProductRequest.builder()- Parameters:
provisionProductRequest- AConsumerthat will call methods onProvisionProductRequest.Builderto create a request.- Returns:
- Result of the ProvisionProduct operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
rejectPortfolioShare
default RejectPortfolioShareResponse rejectPortfolioShare(RejectPortfolioShareRequest rejectPortfolioShareRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Rejects an offer to share the specified portfolio.
- Parameters:
rejectPortfolioShareRequest-- Returns:
- Result of the RejectPortfolioShare operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
rejectPortfolioShare
default RejectPortfolioShareResponse rejectPortfolioShare(Consumer<RejectPortfolioShareRequest.Builder> rejectPortfolioShareRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
Rejects an offer to share the specified portfolio.
This is a convenience which creates an instance of the
RejectPortfolioShareRequest.Builderavoiding the need to create one manually viaRejectPortfolioShareRequest.builder()- Parameters:
rejectPortfolioShareRequest- AConsumerthat will call methods onRejectPortfolioShareRequest.Builderto create a request.- Returns:
- Result of the RejectPortfolioShare operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
scanProvisionedProducts
default ScanProvisionedProductsResponse scanProvisionedProducts(ScanProvisionedProductsRequest scanProvisionedProductsRequest) throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists the provisioned products that are available (not terminated).
To use additional filtering, see SearchProvisionedProducts.
- Parameters:
scanProvisionedProductsRequest-- Returns:
- Result of the ScanProvisionedProducts operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
scanProvisionedProducts
default ScanProvisionedProductsResponse scanProvisionedProducts(Consumer<ScanProvisionedProductsRequest.Builder> scanProvisionedProductsRequest) throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
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.Builderavoiding the need to create one manually viaScanProvisionedProductsRequest.builder()- Parameters:
scanProvisionedProductsRequest- AConsumerthat will call methods onScanProvisionedProductsRequest.Builderto create a request.- Returns:
- Result of the ScanProvisionedProducts operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
scanProvisionedProducts
default ScanProvisionedProductsResponse scanProvisionedProducts() throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Lists the provisioned products that are available (not terminated).
To use additional filtering, see SearchProvisionedProducts.
- Returns:
- Result of the ScanProvisionedProducts operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
scanProvisionedProducts(ScanProvisionedProductsRequest), AWS API Documentation
-
searchProducts
default SearchProductsResponse searchProducts(SearchProductsRequest searchProductsRequest) throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Gets information about the products to which the caller has access.
- Parameters:
searchProductsRequest-- Returns:
- Result of the SearchProducts operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
searchProducts
default SearchProductsResponse searchProducts(Consumer<SearchProductsRequest.Builder> searchProductsRequest) throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Gets information about the products to which the caller has access.
This is a convenience which creates an instance of the
SearchProductsRequest.Builderavoiding the need to create one manually viaSearchProductsRequest.builder()- Parameters:
searchProductsRequest- AConsumerthat will call methods onSearchProductsRequest.Builderto create a request.- Returns:
- Result of the SearchProducts operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
searchProducts
default SearchProductsResponse searchProducts() throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Gets information about the products to which the caller has access.
- Returns:
- Result of the SearchProducts operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
searchProducts(SearchProductsRequest), AWS API Documentation
-
searchProductsPaginator
default SearchProductsIterable searchProductsPaginator() throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
searchProducts(software.amazon.awssdk.services.servicecatalog.model.SearchProductsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.SearchProductsIterable responses = client.searchProductsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.SearchProductsIterable responses = client .searchProductsPaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.SearchProductsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.SearchProductsIterable responses = client.searchProductsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
searchProductsPaginator(SearchProductsRequest), AWS API Documentation
-
searchProductsPaginator
default SearchProductsIterable searchProductsPaginator(SearchProductsRequest searchProductsRequest) throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
searchProducts(software.amazon.awssdk.services.servicecatalog.model.SearchProductsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.SearchProductsIterable responses = client.searchProductsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.SearchProductsIterable responses = client .searchProductsPaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.SearchProductsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.SearchProductsIterable responses = client.searchProductsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
searchProductsPaginator
default SearchProductsIterable searchProductsPaginator(Consumer<SearchProductsRequest.Builder> searchProductsRequest) throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
searchProducts(software.amazon.awssdk.services.servicecatalog.model.SearchProductsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.SearchProductsIterable responses = client.searchProductsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.SearchProductsIterable responses = client .searchProductsPaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.SearchProductsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.SearchProductsIterable responses = client.searchProductsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaSearchProductsRequest.builder()- Parameters:
searchProductsRequest- AConsumerthat will call methods onSearchProductsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
searchProductsAsAdmin
default SearchProductsAsAdminResponse searchProductsAsAdmin(SearchProductsAsAdminRequest searchProductsAsAdminRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Gets information about the products for the specified portfolio or all products.
- Parameters:
searchProductsAsAdminRequest-- Returns:
- Result of the SearchProductsAsAdmin operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource was not found.InvalidParametersException- One or more parameters provided to the operation are 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.AwsServiceException- See Also:
- AWS API Documentation
-
searchProductsAsAdmin
default SearchProductsAsAdminResponse searchProductsAsAdmin(Consumer<SearchProductsAsAdminRequest.Builder> searchProductsAsAdminRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Gets information about the products for the specified portfolio or all products.
This is a convenience which creates an instance of the
SearchProductsAsAdminRequest.Builderavoiding the need to create one manually viaSearchProductsAsAdminRequest.builder()- Parameters:
searchProductsAsAdminRequest- AConsumerthat will call methods onSearchProductsAsAdminRequest.Builderto create a request.- Returns:
- Result of the SearchProductsAsAdmin operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource was not found.InvalidParametersException- One or more parameters provided to the operation are 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.AwsServiceException- See Also:
- AWS API Documentation
-
searchProductsAsAdmin
default SearchProductsAsAdminResponse searchProductsAsAdmin() throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Gets information about the products for the specified portfolio or all products.
- Returns:
- Result of the SearchProductsAsAdmin operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource was not found.InvalidParametersException- One or more parameters provided to the operation are 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.AwsServiceException- See Also:
searchProductsAsAdmin(SearchProductsAsAdminRequest), AWS API Documentation
-
searchProductsAsAdminPaginator
default SearchProductsAsAdminIterable searchProductsAsAdminPaginator() throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
searchProductsAsAdmin(software.amazon.awssdk.services.servicecatalog.model.SearchProductsAsAdminRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.SearchProductsAsAdminIterable responses = client.searchProductsAsAdminPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.SearchProductsAsAdminIterable responses = client .searchProductsAsAdminPaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.SearchProductsAsAdminResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.SearchProductsAsAdminIterable responses = client.searchProductsAsAdminPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
searchProductsAsAdminPaginator(SearchProductsAsAdminRequest), AWS API Documentation
-
searchProductsAsAdminPaginator
default SearchProductsAsAdminIterable searchProductsAsAdminPaginator(SearchProductsAsAdminRequest searchProductsAsAdminRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
searchProductsAsAdmin(software.amazon.awssdk.services.servicecatalog.model.SearchProductsAsAdminRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.SearchProductsAsAdminIterable responses = client.searchProductsAsAdminPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.SearchProductsAsAdminIterable responses = client .searchProductsAsAdminPaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.SearchProductsAsAdminResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.SearchProductsAsAdminIterable responses = client.searchProductsAsAdminPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
searchProductsAsAdminPaginator
default SearchProductsAsAdminIterable searchProductsAsAdminPaginator(Consumer<SearchProductsAsAdminRequest.Builder> searchProductsAsAdminRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
searchProductsAsAdmin(software.amazon.awssdk.services.servicecatalog.model.SearchProductsAsAdminRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.SearchProductsAsAdminIterable responses = client.searchProductsAsAdminPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.SearchProductsAsAdminIterable responses = client .searchProductsAsAdminPaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.SearchProductsAsAdminResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.SearchProductsAsAdminIterable responses = client.searchProductsAsAdminPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaSearchProductsAsAdminRequest.builder()- Parameters:
searchProductsAsAdminRequest- AConsumerthat will call methods onSearchProductsAsAdminRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
searchProvisionedProducts
default SearchProvisionedProductsResponse searchProvisionedProducts(SearchProvisionedProductsRequest searchProvisionedProductsRequest) throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Gets information about the provisioned products that meet the specified criteria.
- Parameters:
searchProvisionedProductsRequest-- Returns:
- Result of the SearchProvisionedProducts operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
searchProvisionedProducts
default SearchProvisionedProductsResponse searchProvisionedProducts(Consumer<SearchProvisionedProductsRequest.Builder> searchProvisionedProductsRequest) throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Gets information about the provisioned products that meet the specified criteria.
This is a convenience which creates an instance of the
SearchProvisionedProductsRequest.Builderavoiding the need to create one manually viaSearchProvisionedProductsRequest.builder()- Parameters:
searchProvisionedProductsRequest- AConsumerthat will call methods onSearchProvisionedProductsRequest.Builderto create a request.- Returns:
- Result of the SearchProvisionedProducts operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
searchProvisionedProducts
default SearchProvisionedProductsResponse searchProvisionedProducts() throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Gets information about the provisioned products that meet the specified criteria.
- Returns:
- Result of the SearchProvisionedProducts operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
searchProvisionedProducts(SearchProvisionedProductsRequest), AWS API Documentation
-
searchProvisionedProductsPaginator
default SearchProvisionedProductsIterable searchProvisionedProductsPaginator() throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
searchProvisionedProducts(software.amazon.awssdk.services.servicecatalog.model.SearchProvisionedProductsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.SearchProvisionedProductsIterable responses = client.searchProvisionedProductsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.SearchProvisionedProductsIterable responses = client .searchProvisionedProductsPaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.SearchProvisionedProductsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.SearchProvisionedProductsIterable responses = client.searchProvisionedProductsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
searchProvisionedProductsPaginator(SearchProvisionedProductsRequest), AWS API Documentation
-
searchProvisionedProductsPaginator
default SearchProvisionedProductsIterable searchProvisionedProductsPaginator(SearchProvisionedProductsRequest searchProvisionedProductsRequest) throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
searchProvisionedProducts(software.amazon.awssdk.services.servicecatalog.model.SearchProvisionedProductsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.SearchProvisionedProductsIterable responses = client.searchProvisionedProductsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.SearchProvisionedProductsIterable responses = client .searchProvisionedProductsPaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.SearchProvisionedProductsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.SearchProvisionedProductsIterable responses = client.searchProvisionedProductsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
searchProvisionedProductsPaginator
default SearchProvisionedProductsIterable searchProvisionedProductsPaginator(Consumer<SearchProvisionedProductsRequest.Builder> searchProvisionedProductsRequest) throws InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
This is a variant of
searchProvisionedProducts(software.amazon.awssdk.services.servicecatalog.model.SearchProvisionedProductsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.servicecatalog.paginators.SearchProvisionedProductsIterable responses = client.searchProvisionedProductsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.servicecatalog.paginators.SearchProvisionedProductsIterable responses = client .searchProvisionedProductsPaginator(request); for (software.amazon.awssdk.services.servicecatalog.model.SearchProvisionedProductsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.servicecatalog.paginators.SearchProvisionedProductsIterable responses = client.searchProvisionedProductsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaSearchProvisionedProductsRequest.builder()- Parameters:
searchProvisionedProductsRequest- AConsumerthat will call methods onSearchProvisionedProductsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
terminateProvisionedProduct
default TerminateProvisionedProductResponse terminateProvisionedProduct(TerminateProvisionedProductRequest terminateProvisionedProductRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
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:
- Result of the TerminateProvisionedProduct operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
terminateProvisionedProduct
default TerminateProvisionedProductResponse terminateProvisionedProduct(Consumer<TerminateProvisionedProductRequest.Builder> terminateProvisionedProductRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
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.Builderavoiding the need to create one manually viaTerminateProvisionedProductRequest.builder()- Parameters:
terminateProvisionedProductRequest- AConsumerthat will call methods onTerminateProvisionedProductRequest.Builderto create a request.- Returns:
- Result of the TerminateProvisionedProduct operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateConstraint
default UpdateConstraintResponse updateConstraint(UpdateConstraintRequest updateConstraintRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Updates the specified constraint.
- Parameters:
updateConstraintRequest-- Returns:
- Result of the UpdateConstraint operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource was not found.InvalidParametersException- One or more parameters provided to the operation are 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateConstraint
default UpdateConstraintResponse updateConstraint(Consumer<UpdateConstraintRequest.Builder> updateConstraintRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Updates the specified constraint.
This is a convenience which creates an instance of the
UpdateConstraintRequest.Builderavoiding the need to create one manually viaUpdateConstraintRequest.builder()- Parameters:
updateConstraintRequest- AConsumerthat will call methods onUpdateConstraintRequest.Builderto create a request.- Returns:
- Result of the UpdateConstraint operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource was not found.InvalidParametersException- One or more parameters provided to the operation are 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.AwsServiceException- See Also:
- AWS API Documentation
-
updatePortfolio
default UpdatePortfolioResponse updatePortfolio(UpdatePortfolioRequest updatePortfolioRequest) throws InvalidParametersException, ResourceNotFoundException, LimitExceededException, TagOptionNotMigratedException, AwsServiceException, SdkClientException, ServiceCatalogException
Updates the specified portfolio.
You cannot update a product that was shared with you.
- Parameters:
updatePortfolioRequest-- Returns:
- Result of the UpdatePortfolio operation returned by the service.
- Throws:
InvalidParametersException- One or more parameters provided to the operation are 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.AwsServiceException- See Also:
- AWS API Documentation
-
updatePortfolio
default UpdatePortfolioResponse updatePortfolio(Consumer<UpdatePortfolioRequest.Builder> updatePortfolioRequest) throws InvalidParametersException, ResourceNotFoundException, LimitExceededException, TagOptionNotMigratedException, AwsServiceException, SdkClientException, ServiceCatalogException
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.Builderavoiding the need to create one manually viaUpdatePortfolioRequest.builder()- Parameters:
updatePortfolioRequest- AConsumerthat will call methods onUpdatePortfolioRequest.Builderto create a request.- Returns:
- Result of the UpdatePortfolio operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updatePortfolioShare
default UpdatePortfolioShareResponse updatePortfolioShare(UpdatePortfolioShareRequest updatePortfolioShareRequest) throws ResourceNotFoundException, InvalidParametersException, OperationNotSupportedException, InvalidStateException, AwsServiceException, SdkClientException, ServiceCatalogException
Updates the specified portfolio share. You can use this API to enable or disable
TagOptionssharing or Principal sharing for an existing portfolio share.The portfolio share cannot be updated if the
CreatePortfolioShareoperation isIN_PROGRESS, as the share is not available to recipient entities. In this case, you must wait for the portfolio share to be completed.You must provide the
accountIdor organization node in the input, but not both.If the portfolio is shared to both an external account and an organization node, and both shares need to be updated, you must invoke
UpdatePortfolioShareseparately for each share type.This API cannot be used for removing the portfolio share. You must use
DeletePortfolioShareAPI for that action.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
PrincipalTypeasIAM. With this configuration, thePrincipalARNmust already exist in the recipient account before it can be associated.- Parameters:
updatePortfolioShareRequest-- Returns:
- Result of the UpdatePortfolioShare operation returned by the service.
- Throws:
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.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.AwsServiceException- See Also:
- AWS API Documentation
-
updatePortfolioShare
default UpdatePortfolioShareResponse updatePortfolioShare(Consumer<UpdatePortfolioShareRequest.Builder> updatePortfolioShareRequest) throws ResourceNotFoundException, InvalidParametersException, OperationNotSupportedException, InvalidStateException, AwsServiceException, SdkClientException, ServiceCatalogException
Updates the specified portfolio share. You can use this API to enable or disable
TagOptionssharing or Principal sharing for an existing portfolio share.The portfolio share cannot be updated if the
CreatePortfolioShareoperation isIN_PROGRESS, as the share is not available to recipient entities. In this case, you must wait for the portfolio share to be completed.You must provide the
accountIdor organization node in the input, but not both.If the portfolio is shared to both an external account and an organization node, and both shares need to be updated, you must invoke
UpdatePortfolioShareseparately for each share type.This API cannot be used for removing the portfolio share. You must use
DeletePortfolioShareAPI for that action.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
PrincipalTypeasIAM. With this configuration, thePrincipalARNmust already exist in the recipient account before it can be associated.
This is a convenience which creates an instance of the
UpdatePortfolioShareRequest.Builderavoiding the need to create one manually viaUpdatePortfolioShareRequest.builder()- Parameters:
updatePortfolioShareRequest- AConsumerthat will call methods onUpdatePortfolioShareRequest.Builderto create a request.- Returns:
- Result of the UpdatePortfolioShare operation returned by the service.
- Throws:
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.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.AwsServiceException- See Also:
- AWS API Documentation
-
updateProduct
default UpdateProductResponse updateProduct(UpdateProductRequest updateProductRequest) throws ResourceNotFoundException, InvalidParametersException, TagOptionNotMigratedException, AwsServiceException, SdkClientException, ServiceCatalogException
Updates the specified product.
- Parameters:
updateProductRequest-- Returns:
- Result of the UpdateProduct operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource was not found.InvalidParametersException- One or more parameters provided to the operation are 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateProduct
default UpdateProductResponse updateProduct(Consumer<UpdateProductRequest.Builder> updateProductRequest) throws ResourceNotFoundException, InvalidParametersException, TagOptionNotMigratedException, AwsServiceException, SdkClientException, ServiceCatalogException
Updates the specified product.
This is a convenience which creates an instance of the
UpdateProductRequest.Builderavoiding the need to create one manually viaUpdateProductRequest.builder()- Parameters:
updateProductRequest- AConsumerthat will call methods onUpdateProductRequest.Builderto create a request.- Returns:
- Result of the UpdateProduct operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource was not found.InvalidParametersException- One or more parameters provided to the operation are 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateProvisionedProduct
default UpdateProvisionedProductResponse updateProvisionedProduct(UpdateProvisionedProductRequest updateProvisionedProductRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
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:
- Result of the UpdateProvisionedProduct operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateProvisionedProduct
default UpdateProvisionedProductResponse updateProvisionedProduct(Consumer<UpdateProvisionedProductRequest.Builder> updateProvisionedProductRequest) throws InvalidParametersException, ResourceNotFoundException, AwsServiceException, SdkClientException, ServiceCatalogException
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.Builderavoiding the need to create one manually viaUpdateProvisionedProductRequest.builder()- Parameters:
updateProvisionedProductRequest- AConsumerthat will call methods onUpdateProvisionedProductRequest.Builderto create a request.- Returns:
- Result of the UpdateProvisionedProduct operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateProvisionedProductProperties
default UpdateProvisionedProductPropertiesResponse updateProvisionedProductProperties(UpdateProvisionedProductPropertiesRequest updateProvisionedProductPropertiesRequest) throws InvalidParametersException, ResourceNotFoundException, InvalidStateException, AwsServiceException, SdkClientException, ServiceCatalogException
Requests updates to the properties of the specified provisioned product.
- Parameters:
updateProvisionedProductPropertiesRequest-- Returns:
- Result of the UpdateProvisionedProductProperties operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateProvisionedProductProperties
default UpdateProvisionedProductPropertiesResponse updateProvisionedProductProperties(Consumer<UpdateProvisionedProductPropertiesRequest.Builder> updateProvisionedProductPropertiesRequest) throws InvalidParametersException, ResourceNotFoundException, InvalidStateException, AwsServiceException, SdkClientException, ServiceCatalogException
Requests updates to the properties of the specified provisioned product.
This is a convenience which creates an instance of the
UpdateProvisionedProductPropertiesRequest.Builderavoiding the need to create one manually viaUpdateProvisionedProductPropertiesRequest.builder()- Parameters:
updateProvisionedProductPropertiesRequest- AConsumerthat will call methods onUpdateProvisionedProductPropertiesRequest.Builderto create a request.- Returns:
- Result of the UpdateProvisionedProductProperties operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateProvisioningArtifact
default UpdateProvisioningArtifactResponse updateProvisioningArtifact(UpdateProvisioningArtifactRequest updateProvisioningArtifactRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
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:
- Result of the UpdateProvisioningArtifact operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource was not found.InvalidParametersException- One or more parameters provided to the operation are 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateProvisioningArtifact
default UpdateProvisioningArtifactResponse updateProvisioningArtifact(Consumer<UpdateProvisioningArtifactRequest.Builder> updateProvisioningArtifactRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
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.Builderavoiding the need to create one manually viaUpdateProvisioningArtifactRequest.builder()- Parameters:
updateProvisioningArtifactRequest- AConsumerthat will call methods onUpdateProvisioningArtifactRequest.Builderto create a request.- Returns:
- Result of the UpdateProvisioningArtifact operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource was not found.InvalidParametersException- One or more parameters provided to the operation are 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateServiceAction
default UpdateServiceActionResponse updateServiceAction(UpdateServiceActionRequest updateServiceActionRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Updates a self-service action.
- Parameters:
updateServiceActionRequest-- Returns:
- Result of the UpdateServiceAction operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateServiceAction
default UpdateServiceActionResponse updateServiceAction(Consumer<UpdateServiceActionRequest.Builder> updateServiceActionRequest) throws ResourceNotFoundException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Updates a self-service action.
This is a convenience which creates an instance of the
UpdateServiceActionRequest.Builderavoiding the need to create one manually viaUpdateServiceActionRequest.builder()- Parameters:
updateServiceActionRequest- AConsumerthat will call methods onUpdateServiceActionRequest.Builderto create a request.- Returns:
- Result of the UpdateServiceAction operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateTagOption
default UpdateTagOptionResponse updateTagOption(UpdateTagOptionRequest updateTagOptionRequest) throws TagOptionNotMigratedException, ResourceNotFoundException, DuplicateResourceException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Updates the specified TagOption.
- Parameters:
updateTagOptionRequest-- Returns:
- Result of the UpdateTagOption operation returned by the service.
- Throws:
TagOptionNotMigratedException- An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateTagOption
default UpdateTagOptionResponse updateTagOption(Consumer<UpdateTagOptionRequest.Builder> updateTagOptionRequest) throws TagOptionNotMigratedException, ResourceNotFoundException, DuplicateResourceException, InvalidParametersException, AwsServiceException, SdkClientException, ServiceCatalogException
Updates the specified TagOption.
This is a convenience which creates an instance of the
UpdateTagOptionRequest.Builderavoiding the need to create one manually viaUpdateTagOptionRequest.builder()- Parameters:
updateTagOptionRequest- AConsumerthat will call methods onUpdateTagOptionRequest.Builderto create a request.- Returns:
- Result of the UpdateTagOption operation returned by the service.
- Throws:
TagOptionNotMigratedException- An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. 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.AwsServiceException- See Also:
- AWS API Documentation
-
create
static ServiceCatalogClient create()
Create aServiceCatalogClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static ServiceCatalogClientBuilder builder()
Create a builder that can be used to configure and create aServiceCatalogClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default ServiceCatalogServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-