com.amazonaws.services.servicecatalog

Interface AWSServiceCatalogAsync

All Superinterfaces:

AWSServiceCatalog

All Known Implementing Classes:

AbstractAWSServiceCatalogAsync, AWSServiceCatalogAsyncClient

public interface AWSServiceCatalogAsync
extends AWSServiceCatalog

Interface for accessing AWS Service Catalog asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

AWS Service Catalog

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

• AWS Service Catalog Administrator Guide

• AWS Service Catalog User Guide

Field Summary

Fields inherited from interface com.amazonaws.services.servicecatalog.AWSServiceCatalog

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
Future<DescribeProductResult>	describeProductAsync(DescribeProductRequest describeProductRequest) Retrieves information about a specified product.
Future<DescribeProductResult>	describeProductAsync(DescribeProductRequest describeProductRequest, AsyncHandler<DescribeProductRequest,DescribeProductResult> asyncHandler) Retrieves information about a specified product.
Future<DescribeProductViewResult>	describeProductViewAsync(DescribeProductViewRequest describeProductViewRequest) Retrieves information about a specified product.
Future<DescribeProductViewResult>	describeProductViewAsync(DescribeProductViewRequest describeProductViewRequest, AsyncHandler<DescribeProductViewRequest,DescribeProductViewResult> asyncHandler) Retrieves information about a specified product.
Future<DescribeProvisioningParametersResult>	describeProvisioningParametersAsync(DescribeProvisioningParametersRequest describeProvisioningParametersRequest) Provides information about parameters required to provision a specified product in a specified manner.
Future<DescribeProvisioningParametersResult>	describeProvisioningParametersAsync(DescribeProvisioningParametersRequest describeProvisioningParametersRequest, AsyncHandler<DescribeProvisioningParametersRequest,DescribeProvisioningParametersResult> asyncHandler) Provides information about parameters required to provision a specified product in a specified manner.
Future<DescribeRecordResult>	describeRecordAsync(DescribeRecordRequest describeRecordRequest) Retrieves a paginated list of the full details of a specific request.
Future<DescribeRecordResult>	describeRecordAsync(DescribeRecordRequest describeRecordRequest, AsyncHandler<DescribeRecordRequest,DescribeRecordResult> asyncHandler) Retrieves a paginated list of the full details of a specific request.
Future<ListLaunchPathsResult>	listLaunchPathsAsync(ListLaunchPathsRequest listLaunchPathsRequest) Returns a paginated list of all paths to a specified product.
Future<ListLaunchPathsResult>	listLaunchPathsAsync(ListLaunchPathsRequest listLaunchPathsRequest, AsyncHandler<ListLaunchPathsRequest,ListLaunchPathsResult> asyncHandler) Returns a paginated list of all paths to a specified product.
Future<ListRecordHistoryResult>	listRecordHistoryAsync(ListRecordHistoryRequest listRecordHistoryRequest) Returns a paginated list of all performed requests, in the form of RecordDetails objects that are filtered as specified.
Future<ListRecordHistoryResult>	listRecordHistoryAsync(ListRecordHistoryRequest listRecordHistoryRequest, AsyncHandler<ListRecordHistoryRequest,ListRecordHistoryResult> asyncHandler) Returns a paginated list of all performed requests, in the form of RecordDetails objects that are filtered as specified.
Future<ProvisionProductResult>	provisionProductAsync(ProvisionProductRequest provisionProductRequest) Requests a Provision of a specified product.
Future<ProvisionProductResult>	provisionProductAsync(ProvisionProductRequest provisionProductRequest, AsyncHandler<ProvisionProductRequest,ProvisionProductResult> asyncHandler) Requests a Provision of a specified product.
Future<ScanProvisionedProductsResult>	scanProvisionedProductsAsync(ScanProvisionedProductsRequest scanProvisionedProductsRequest) Returns a paginated list of all the ProvisionedProduct objects that are currently available (not terminated).
Future<ScanProvisionedProductsResult>	scanProvisionedProductsAsync(ScanProvisionedProductsRequest scanProvisionedProductsRequest, AsyncHandler<ScanProvisionedProductsRequest,ScanProvisionedProductsResult> asyncHandler) Returns a paginated list of all the ProvisionedProduct objects that are currently available (not terminated).
Future<SearchProductsResult>	searchProductsAsync(SearchProductsRequest searchProductsRequest) Returns a paginated list all of the Products objects to which the caller has access.
Future<SearchProductsResult>	searchProductsAsync(SearchProductsRequest searchProductsRequest, AsyncHandler<SearchProductsRequest,SearchProductsResult> asyncHandler) Returns a paginated list all of the Products objects to which the caller has access.
Future<TerminateProvisionedProductResult>	terminateProvisionedProductAsync(TerminateProvisionedProductRequest terminateProvisionedProductRequest) Requests termination of an existing ProvisionedProduct object.
Future<TerminateProvisionedProductResult>	terminateProvisionedProductAsync(TerminateProvisionedProductRequest terminateProvisionedProductRequest, AsyncHandler<TerminateProvisionedProductRequest,TerminateProvisionedProductResult> asyncHandler) Requests termination of an existing ProvisionedProduct object.
Future<UpdateProvisionedProductResult>	updateProvisionedProductAsync(UpdateProvisionedProductRequest updateProvisionedProductRequest) Requests updates to the configuration of an existing ProvisionedProduct object.
Future<UpdateProvisionedProductResult>	updateProvisionedProductAsync(UpdateProvisionedProductRequest updateProvisionedProductRequest, AsyncHandler<UpdateProvisionedProductRequest,UpdateProvisionedProductResult> asyncHandler) Requests updates to the configuration of an existing ProvisionedProduct object.

Methods inherited from interface com.amazonaws.services.servicecatalog.AWSServiceCatalog

describeProduct, describeProductView, describeProvisioningParameters, describeRecord, getCachedResponseMetadata, listLaunchPaths, listRecordHistory, provisionProduct, scanProvisionedProducts, searchProducts, setEndpoint, setRegion, shutdown, terminateProvisionedProduct, updateProvisionedProduct

Method Detail

describeProductAsync

Future<DescribeProductResult> describeProductAsync(DescribeProductRequest describeProductRequest)

Retrieves information about a specified product.

This operation is functionally identical to DescribeProductView except that it takes as input ProductId instead of ProductViewId.

Parameters:

describeProductRequest -

Returns:

A Java Future containing the result of the DescribeProduct operation returned by the service.

describeProductAsync

Future<DescribeProductResult> describeProductAsync(DescribeProductRequest describeProductRequest,
                                                   AsyncHandler<DescribeProductRequest,DescribeProductResult> asyncHandler)

Retrieves information about a specified product.

This operation is functionally identical to DescribeProductView except that it takes as input ProductId instead of ProductViewId.

Parameters:

describeProductRequest -

asyncHandler - 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.

Returns:

A Java Future containing the result of the DescribeProduct operation returned by the service.

describeProductViewAsync

Future<DescribeProductViewResult> describeProductViewAsync(DescribeProductViewRequest describeProductViewRequest)

Retrieves information about a specified product.

This operation is functionally identical to DescribeProduct except that it takes as input ProductViewId instead of ProductId.

Parameters:

describeProductViewRequest -

Returns:

A Java Future containing the result of the DescribeProductView operation returned by the service.

describeProductViewAsync

Future<DescribeProductViewResult> describeProductViewAsync(DescribeProductViewRequest describeProductViewRequest,
                                                           AsyncHandler<DescribeProductViewRequest,DescribeProductViewResult> asyncHandler)

Retrieves information about a specified product.

This operation is functionally identical to DescribeProduct except that it takes as input ProductViewId instead of ProductId.

Parameters:

describeProductViewRequest -

asyncHandler - 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.

Returns:

A Java Future containing the result of the DescribeProductView operation returned by the service.

describeProvisioningParametersAsync

Future<DescribeProvisioningParametersResult> describeProvisioningParametersAsync(DescribeProvisioningParametersRequest describeProvisioningParametersRequest)

Provides information about parameters required to provision a specified product in a specified manner. Use this operation to obtain the list of ProvisioningArtifactParameters parameters available to call the ProvisionProduct operation for the specified product.

Parameters:

describeProvisioningParametersRequest -

Returns:

A Java Future containing the result of the DescribeProvisioningParameters operation returned by the service.

describeProvisioningParametersAsync

Future<DescribeProvisioningParametersResult> describeProvisioningParametersAsync(DescribeProvisioningParametersRequest describeProvisioningParametersRequest,
                                                                                 AsyncHandler<DescribeProvisioningParametersRequest,DescribeProvisioningParametersResult> asyncHandler)

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.

Parameters:

describeProvisioningParametersRequest -

asyncHandler - 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.

Returns:

A Java Future containing the result of the DescribeProvisioningParameters operation returned by the service.

describeRecordAsync

Future<DescribeRecordResult> describeRecordAsync(DescribeRecordRequest describeRecordRequest)

Retrieves a paginated list of the full details of a specific request. Use this operation after calling a request operation (ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct).

Parameters:

describeRecordRequest -

Returns:

A Java Future containing the result of the DescribeRecord operation returned by the service.

describeRecordAsync

Future<DescribeRecordResult> describeRecordAsync(DescribeRecordRequest describeRecordRequest,
                                                 AsyncHandler<DescribeRecordRequest,DescribeRecordResult> asyncHandler)

Retrieves a paginated list of the full details of a specific request. Use this operation after calling a request operation (ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct).

Parameters:

describeRecordRequest -

asyncHandler - 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.

Returns:

A Java Future containing the result of the DescribeRecord operation returned by the service.

listLaunchPathsAsync

Future<ListLaunchPathsResult> listLaunchPathsAsync(ListLaunchPathsRequest listLaunchPathsRequest)

Returns a paginated list of all paths to a specified product. A path is how the user has access to a specified product, and is necessary when provisioning a product. A path also determines the constraints put on the product.

Parameters:

listLaunchPathsRequest -

Returns:

A Java Future containing the result of the ListLaunchPaths operation returned by the service.

listLaunchPathsAsync

Future<ListLaunchPathsResult> listLaunchPathsAsync(ListLaunchPathsRequest listLaunchPathsRequest,
                                                   AsyncHandler<ListLaunchPathsRequest,ListLaunchPathsResult> asyncHandler)

Returns a paginated list of all paths to a specified product. A path is how the user has access to a specified product, and is necessary when provisioning a product. A path also determines the constraints put on the product.

Parameters:

listLaunchPathsRequest -

asyncHandler - 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.

Returns:

A Java Future containing the result of the ListLaunchPaths operation returned by the service.

listRecordHistoryAsync

Future<ListRecordHistoryResult> listRecordHistoryAsync(ListRecordHistoryRequest listRecordHistoryRequest)

Returns a paginated list of all performed requests, in the form of RecordDetails objects that are filtered as specified.

Parameters:

listRecordHistoryRequest -

Returns:

A Java Future containing the result of the ListRecordHistory operation returned by the service.

listRecordHistoryAsync

Future<ListRecordHistoryResult> listRecordHistoryAsync(ListRecordHistoryRequest listRecordHistoryRequest,
                                                       AsyncHandler<ListRecordHistoryRequest,ListRecordHistoryResult> asyncHandler)

Returns a paginated list of all performed requests, in the form of RecordDetails objects that are filtered as specified.

Parameters:

listRecordHistoryRequest -

asyncHandler - 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.

Returns:

A Java Future containing the result of the ListRecordHistory operation returned by the service.

provisionProductAsync

Future<ProvisionProductResult> provisionProductAsync(ProvisionProductRequest provisionProductRequest)

Requests 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.

Parameters:

provisionProductRequest -

Returns:

A Java Future containing the result of the ProvisionProduct operation returned by the service.

provisionProductAsync

Future<ProvisionProductResult> provisionProductAsync(ProvisionProductRequest provisionProductRequest,
                                                     AsyncHandler<ProvisionProductRequest,ProvisionProductResult> asyncHandler)

Requests 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.

Parameters:

provisionProductRequest -

asyncHandler - 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.

Returns:

A Java Future containing the result of the ProvisionProduct operation returned by the service.

scanProvisionedProductsAsync

Future<ScanProvisionedProductsResult> scanProvisionedProductsAsync(ScanProvisionedProductsRequest scanProvisionedProductsRequest)

Returns a paginated list of all the ProvisionedProduct objects that are currently available (not terminated).

Parameters:

scanProvisionedProductsRequest -

Returns:

A Java Future containing the result of the ScanProvisionedProducts operation returned by the service.

scanProvisionedProductsAsync

Future<ScanProvisionedProductsResult> scanProvisionedProductsAsync(ScanProvisionedProductsRequest scanProvisionedProductsRequest,
                                                                   AsyncHandler<ScanProvisionedProductsRequest,ScanProvisionedProductsResult> asyncHandler)

Returns a paginated list of all the ProvisionedProduct objects that are currently available (not terminated).

Parameters:

scanProvisionedProductsRequest -

asyncHandler - 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.

Returns:

A Java Future containing the result of the ScanProvisionedProducts operation returned by the service.

searchProductsAsync

Future<SearchProductsResult> searchProductsAsync(SearchProductsRequest searchProductsRequest)

Returns a paginated list all of the Products objects to which the caller has access.

The output of this operation can be used as input for other operations, such as DescribeProductView.

Parameters:

searchProductsRequest -

Returns:

A Java Future containing the result of the SearchProducts operation returned by the service.

searchProductsAsync

Future<SearchProductsResult> searchProductsAsync(SearchProductsRequest searchProductsRequest,
                                                 AsyncHandler<SearchProductsRequest,SearchProductsResult> asyncHandler)

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.

Parameters:

searchProductsRequest -

asyncHandler - 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.

Returns:

A Java Future containing the result of the SearchProducts operation returned by the service.

terminateProvisionedProductAsync

Future<TerminateProvisionedProductResult> terminateProvisionedProductAsync(TerminateProvisionedProductRequest terminateProvisionedProductRequest)

Requests termination of an existing ProvisionedProduct object. If there are Tags associated with the object, they are terminated when the ProvisionedProduct object is terminated.

This operation does not delete any records associated with the ProvisionedProduct object.

You can check the status of this request using the DescribeRecord operation.

Parameters:

terminateProvisionedProductRequest -

Returns:

A Java Future containing the result of the TerminateProvisionedProduct operation returned by the service.

terminateProvisionedProductAsync

Future<TerminateProvisionedProductResult> terminateProvisionedProductAsync(TerminateProvisionedProductRequest terminateProvisionedProductRequest,
                                                                           AsyncHandler<TerminateProvisionedProductRequest,TerminateProvisionedProductResult> asyncHandler)

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.

Parameters:

terminateProvisionedProductRequest -

asyncHandler - 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.

Returns:

A Java Future containing the result of the TerminateProvisionedProduct operation returned by the service.

updateProvisionedProductAsync

Future<UpdateProvisionedProductResult> updateProvisionedProductAsync(UpdateProvisionedProductRequest updateProvisionedProductRequest)

Requests updates to the configuration of an existing ProvisionedProduct object. If there are tags associated with the object, they cannot be updated or added with this operation. Depending on the specific updates requested, this operation may update with no interruption, with some interruption, or replace the ProvisionedProduct object entirely.

You can check the status of this request using the DescribeRecord operation.

Parameters:

updateProvisionedProductRequest -

Returns:

A Java Future containing the result of the UpdateProvisionedProduct operation returned by the service.

updateProvisionedProductAsync

Future<UpdateProvisionedProductResult> updateProvisionedProductAsync(UpdateProvisionedProductRequest updateProvisionedProductRequest,
                                                                     AsyncHandler<UpdateProvisionedProductRequest,UpdateProvisionedProductResult> asyncHandler)

Requests updates to the configuration of an existing ProvisionedProduct object. If there are tags associated with the object, they cannot be updated or added with this operation. Depending on the specific updates requested, this operation may update with no interruption, with some interruption, or replace the ProvisionedProduct object entirely.

You can check the status of this request using the DescribeRecord operation.

Parameters:

updateProvisionedProductRequest -

asyncHandler - 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.

Returns:

A Java Future containing the result of the UpdateProvisionedProduct operation returned by the service.