@ThreadSafe public class AWSServiceCatalogAsyncClient extends AWSServiceCatalogClient implements AWSServiceCatalogAsync
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Overview
AWS Service Catalog allows organizations to create and manage catalogs of IT services that are approved for use on AWS. This documentation provides reference material for the AWS Service Catalog end user API. To get the most out of this documentation, you need to be familiar with the terminology discussed in AWS Service Catalog Concepts.
Additional Resources
configFactoryclient, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffsetENDPOINT_PREFIX| Constructor and Description |
|---|
AWSServiceCatalogAsyncClient()
Constructs a new asynchronous client to invoke service methods on AWS Service Catalog.
|
AWSServiceCatalogAsyncClient(AWSCredentials awsCredentials)
Constructs a new asynchronous client to invoke service methods on AWS Service Catalog using the specified AWS
account credentials.
|
AWSServiceCatalogAsyncClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AWS Service Catalog using the specified AWS
account credentials, executor service, and client configuration options.
|
AWSServiceCatalogAsyncClient(AWSCredentials awsCredentials,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AWS Service Catalog using the specified AWS
account credentials and executor service.
|
AWSServiceCatalogAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new asynchronous client to invoke service methods on AWS Service Catalog using the specified AWS
account credentials provider.
|
AWSServiceCatalogAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new asynchronous client to invoke service methods on AWS Service Catalog using the provided AWS
account credentials provider and client configuration options.
|
AWSServiceCatalogAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AWS Service Catalog using the specified AWS
account credentials provider, executor service, and client configuration options.
|
AWSServiceCatalogAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AWS Service Catalog using the specified AWS
account credentials provider and executor service.
|
AWSServiceCatalogAsyncClient(ClientConfiguration clientConfiguration)
Constructs a new asynchronous client to invoke service methods on AWS Service Catalog.
|
describeProduct, describeProductView, describeProvisioningParameters, describeRecord, getCachedResponseMetadata, listLaunchPaths, listRecordHistory, provisionProduct, scanProvisionedProducts, searchProducts, terminateProvisionedProduct, updateProvisionedProductaddRequestHandler, addRequestHandler, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffsetclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitdescribeProduct, describeProductView, describeProvisioningParameters, describeRecord, getCachedResponseMetadata, listLaunchPaths, listRecordHistory, provisionProduct, scanProvisionedProducts, searchProducts, setEndpoint, setRegion, terminateProvisionedProduct, updateProvisionedProductpublic AWSServiceCatalogAsyncClient()
Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
public AWSServiceCatalogAsyncClient(ClientConfiguration clientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the
maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().
clientConfiguration - The client configuration options controlling how this client connects to AWS Service Catalog (ex: proxy
settings, retry counts, etc).DefaultAWSCredentialsProviderChain,
Executors.newFixedThreadPool(int)public AWSServiceCatalogAsyncClient(AWSCredentials awsCredentials)
Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.Executors.newFixedThreadPool(int)public AWSServiceCatalogAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.executorService - The executor service by which all asynchronous requests will be executed.public AWSServiceCatalogAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).executorService - The executor service by which all asynchronous requests will be executed.public AWSServiceCatalogAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.Executors.newFixedThreadPool(int)public AWSServiceCatalogAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the
maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).DefaultAWSCredentialsProviderChain,
Executors.newFixedThreadPool(int)public AWSServiceCatalogAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.executorService - The executor service by which all asynchronous requests will be executed.public AWSServiceCatalogAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).executorService - The executor service by which all asynchronous requests will be executed.public ExecutorService getExecutorService()
public Future<DescribeProductResult> describeProductAsync(DescribeProductRequest request)
AWSServiceCatalogAsyncRetrieves information about a specified product.
This operation is functionally identical to DescribeProductView except that it takes as input
ProductId instead of ProductViewId.
describeProductAsync in interface AWSServiceCatalogAsyncpublic Future<DescribeProductResult> describeProductAsync(DescribeProductRequest request, AsyncHandler<DescribeProductRequest,DescribeProductResult> asyncHandler)
AWSServiceCatalogAsyncRetrieves information about a specified product.
This operation is functionally identical to DescribeProductView except that it takes as input
ProductId instead of ProductViewId.
describeProductAsync in interface AWSServiceCatalogAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeProductViewResult> describeProductViewAsync(DescribeProductViewRequest request)
AWSServiceCatalogAsyncRetrieves information about a specified product.
This operation is functionally identical to DescribeProduct except that it takes as input
ProductViewId instead of ProductId.
describeProductViewAsync in interface AWSServiceCatalogAsyncpublic Future<DescribeProductViewResult> describeProductViewAsync(DescribeProductViewRequest request, AsyncHandler<DescribeProductViewRequest,DescribeProductViewResult> asyncHandler)
AWSServiceCatalogAsyncRetrieves information about a specified product.
This operation is functionally identical to DescribeProduct except that it takes as input
ProductViewId instead of ProductId.
describeProductViewAsync in interface AWSServiceCatalogAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeProvisioningParametersResult> describeProvisioningParametersAsync(DescribeProvisioningParametersRequest request)
AWSServiceCatalogAsync
Provides information about parameters required to provision a specified product in a specified manner. Use this
operation to obtain the list of ProvisioningArtifactParameters parameters available to call the
ProvisionProduct operation for the specified product.
describeProvisioningParametersAsync in interface AWSServiceCatalogAsyncpublic Future<DescribeProvisioningParametersResult> describeProvisioningParametersAsync(DescribeProvisioningParametersRequest request, AsyncHandler<DescribeProvisioningParametersRequest,DescribeProvisioningParametersResult> asyncHandler)
AWSServiceCatalogAsync
Provides information about parameters required to provision a specified product in a specified manner. Use this
operation to obtain the list of ProvisioningArtifactParameters parameters available to call the
ProvisionProduct operation for the specified product.
describeProvisioningParametersAsync in interface AWSServiceCatalogAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeRecordResult> describeRecordAsync(DescribeRecordRequest request)
AWSServiceCatalogAsyncRetrieves a paginated list of the full details of a specific request. Use this operation after calling a request operation (ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct).
describeRecordAsync in interface AWSServiceCatalogAsyncpublic Future<DescribeRecordResult> describeRecordAsync(DescribeRecordRequest request, AsyncHandler<DescribeRecordRequest,DescribeRecordResult> asyncHandler)
AWSServiceCatalogAsyncRetrieves a paginated list of the full details of a specific request. Use this operation after calling a request operation (ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct).
describeRecordAsync in interface AWSServiceCatalogAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListLaunchPathsResult> listLaunchPathsAsync(ListLaunchPathsRequest request)
AWSServiceCatalogAsyncReturns a paginated list of all paths to a specified product. A path is how the user has access to a specified product, and is necessary when provisioning a product. A path also determines the constraints put on the product.
listLaunchPathsAsync in interface AWSServiceCatalogAsyncpublic Future<ListLaunchPathsResult> listLaunchPathsAsync(ListLaunchPathsRequest request, AsyncHandler<ListLaunchPathsRequest,ListLaunchPathsResult> asyncHandler)
AWSServiceCatalogAsyncReturns a paginated list of all paths to a specified product. A path is how the user has access to a specified product, and is necessary when provisioning a product. A path also determines the constraints put on the product.
listLaunchPathsAsync in interface AWSServiceCatalogAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListRecordHistoryResult> listRecordHistoryAsync(ListRecordHistoryRequest request)
AWSServiceCatalogAsyncReturns a paginated list of all performed requests, in the form of RecordDetails objects that are filtered as specified.
listRecordHistoryAsync in interface AWSServiceCatalogAsyncpublic Future<ListRecordHistoryResult> listRecordHistoryAsync(ListRecordHistoryRequest request, AsyncHandler<ListRecordHistoryRequest,ListRecordHistoryResult> asyncHandler)
AWSServiceCatalogAsyncReturns a paginated list of all performed requests, in the form of RecordDetails objects that are filtered as specified.
listRecordHistoryAsync in interface AWSServiceCatalogAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ProvisionProductResult> provisionProductAsync(ProvisionProductRequest request)
AWSServiceCatalogAsyncRequests a Provision of a specified product. A ProvisionedProduct is a resourced instance for a product. For example, provisioning a CloudFormation-template-backed product results in launching a CloudFormation stack and all the underlying resources that come with it.
You can check the status of this request using the DescribeRecord operation.
provisionProductAsync in interface AWSServiceCatalogAsyncpublic Future<ProvisionProductResult> provisionProductAsync(ProvisionProductRequest request, AsyncHandler<ProvisionProductRequest,ProvisionProductResult> asyncHandler)
AWSServiceCatalogAsyncRequests a Provision of a specified product. A ProvisionedProduct is a resourced instance for a product. For example, provisioning a CloudFormation-template-backed product results in launching a CloudFormation stack and all the underlying resources that come with it.
You can check the status of this request using the DescribeRecord operation.
provisionProductAsync in interface AWSServiceCatalogAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ScanProvisionedProductsResult> scanProvisionedProductsAsync(ScanProvisionedProductsRequest request)
AWSServiceCatalogAsyncReturns a paginated list of all the ProvisionedProduct objects that are currently available (not terminated).
scanProvisionedProductsAsync in interface AWSServiceCatalogAsyncpublic Future<ScanProvisionedProductsResult> scanProvisionedProductsAsync(ScanProvisionedProductsRequest request, AsyncHandler<ScanProvisionedProductsRequest,ScanProvisionedProductsResult> asyncHandler)
AWSServiceCatalogAsyncReturns a paginated list of all the ProvisionedProduct objects that are currently available (not terminated).
scanProvisionedProductsAsync in interface AWSServiceCatalogAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SearchProductsResult> searchProductsAsync(SearchProductsRequest request)
AWSServiceCatalogAsync
Returns a paginated list all of the Products objects to which the caller has access.
The output of this operation can be used as input for other operations, such as DescribeProductView.
searchProductsAsync in interface AWSServiceCatalogAsyncpublic Future<SearchProductsResult> searchProductsAsync(SearchProductsRequest request, AsyncHandler<SearchProductsRequest,SearchProductsResult> asyncHandler)
AWSServiceCatalogAsync
Returns a paginated list all of the Products objects to which the caller has access.
The output of this operation can be used as input for other operations, such as DescribeProductView.
searchProductsAsync in interface AWSServiceCatalogAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<TerminateProvisionedProductResult> terminateProvisionedProductAsync(TerminateProvisionedProductRequest request)
AWSServiceCatalogAsync
Requests termination of an existing ProvisionedProduct object. If there are Tags associated with the
object, they are terminated when the ProvisionedProduct object is terminated.
This operation does not delete any records associated with the ProvisionedProduct object.
You can check the status of this request using the DescribeRecord operation.
terminateProvisionedProductAsync in interface AWSServiceCatalogAsyncpublic Future<TerminateProvisionedProductResult> terminateProvisionedProductAsync(TerminateProvisionedProductRequest request, AsyncHandler<TerminateProvisionedProductRequest,TerminateProvisionedProductResult> asyncHandler)
AWSServiceCatalogAsync
Requests termination of an existing ProvisionedProduct object. If there are Tags associated with the
object, they are terminated when the ProvisionedProduct object is terminated.
This operation does not delete any records associated with the ProvisionedProduct object.
You can check the status of this request using the DescribeRecord operation.
terminateProvisionedProductAsync in interface AWSServiceCatalogAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateProvisionedProductResult> updateProvisionedProductAsync(UpdateProvisionedProductRequest request)
AWSServiceCatalogAsyncRequests updates to the configuration of an existing ProvisionedProduct object. If there are tags associated with the object, they cannot be updated or added with this operation. Depending on the specific updates requested, this operation may update with no interruption, with some interruption, or replace the ProvisionedProduct object entirely.
You can check the status of this request using the DescribeRecord operation.
updateProvisionedProductAsync in interface AWSServiceCatalogAsyncpublic Future<UpdateProvisionedProductResult> updateProvisionedProductAsync(UpdateProvisionedProductRequest request, AsyncHandler<UpdateProvisionedProductRequest,UpdateProvisionedProductResult> asyncHandler)
AWSServiceCatalogAsyncRequests updates to the configuration of an existing ProvisionedProduct object. If there are tags associated with the object, they cannot be updated or added with this operation. Depending on the specific updates requested, this operation may update with no interruption, with some interruption, or replace the ProvisionedProduct object entirely.
You can check the status of this request using the DescribeRecord operation.
updateProvisionedProductAsync in interface AWSServiceCatalogAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AWSServiceCatalogshutdown in class AmazonWebServiceClientCopyright © 2016. All rights reserved.