com.amazonaws.services.servicecatalog.AWSServiceCatalogAsync Maven / Gradle / Ivy
Show all versions of aws-java-sdk-servicecatalog Show documentation
/*
* Copyright 2011-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.servicecatalog;
import com.amazonaws.services.servicecatalog.model.*;
/**
* Interface for accessing AWS Service Catalog asynchronously. Each asynchronous method will return a Java Future object
* representing the asynchronous operation; overloads which accept an {@code 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
*
*
* -
*
*
* -
*
*
*
*/
public interface AWSServiceCatalogAsync extends AWSServiceCatalog {
/**
*
* Retrieves information about a specified product.
*
*
* This operation is functionally identical to DescribeProductView except that it takes as input
* ProductId instead of ProductViewId.
*
*
* @param describeProductRequest
* @return A Java Future containing the result of the DescribeProduct operation returned by the service.
* @sample AWSServiceCatalogAsync.DescribeProduct
*/
java.util.concurrent.Future 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.
*
*
* @param describeProductRequest
* @param 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.
* @return A Java Future containing the result of the DescribeProduct operation returned by the service.
* @sample AWSServiceCatalogAsyncHandler.DescribeProduct
*/
java.util.concurrent.Future describeProductAsync(DescribeProductRequest describeProductRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves information about a specified product.
*
*
* This operation is functionally identical to DescribeProduct except that it takes as input
* ProductViewId instead of ProductId.
*
*
* @param describeProductViewRequest
* @return A Java Future containing the result of the DescribeProductView operation returned by the service.
* @sample AWSServiceCatalogAsync.DescribeProductView
*/
java.util.concurrent.Future 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.
*
*
* @param describeProductViewRequest
* @param 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.
* @return A Java Future containing the result of the DescribeProductView operation returned by the service.
* @sample AWSServiceCatalogAsyncHandler.DescribeProductView
*/
java.util.concurrent.Future describeProductViewAsync(DescribeProductViewRequest describeProductViewRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param describeProvisioningParametersRequest
* @return A Java Future containing the result of the DescribeProvisioningParameters operation returned by the
* service.
* @sample AWSServiceCatalogAsync.DescribeProvisioningParameters
*/
java.util.concurrent.Future 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.
*
*
* @param describeProvisioningParametersRequest
* @param 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.
* @return A Java Future containing the result of the DescribeProvisioningParameters operation returned by the
* service.
* @sample AWSServiceCatalogAsyncHandler.DescribeProvisioningParameters
*/
java.util.concurrent.Future describeProvisioningParametersAsync(
DescribeProvisioningParametersRequest describeProvisioningParametersRequest,
com.amazonaws.handlers.AsyncHandler 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).
*
*
* @param describeRecordRequest
* @return A Java Future containing the result of the DescribeRecord operation returned by the service.
* @sample AWSServiceCatalogAsync.DescribeRecord
*/
java.util.concurrent.Future 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).
*
*
* @param describeRecordRequest
* @param 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.
* @return A Java Future containing the result of the DescribeRecord operation returned by the service.
* @sample AWSServiceCatalogAsyncHandler.DescribeRecord
*/
java.util.concurrent.Future describeRecordAsync(DescribeRecordRequest describeRecordRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param listLaunchPathsRequest
* @return A Java Future containing the result of the ListLaunchPaths operation returned by the service.
* @sample AWSServiceCatalogAsync.ListLaunchPaths
*/
java.util.concurrent.Future 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.
*
*
* @param listLaunchPathsRequest
* @param 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.
* @return A Java Future containing the result of the ListLaunchPaths operation returned by the service.
* @sample AWSServiceCatalogAsyncHandler.ListLaunchPaths
*/
java.util.concurrent.Future listLaunchPathsAsync(ListLaunchPathsRequest listLaunchPathsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns a paginated list of all performed requests, in the form of RecordDetails objects that are filtered as
* specified.
*
*
* @param listRecordHistoryRequest
* @return A Java Future containing the result of the ListRecordHistory operation returned by the service.
* @sample AWSServiceCatalogAsync.ListRecordHistory
*/
java.util.concurrent.Future listRecordHistoryAsync(ListRecordHistoryRequest listRecordHistoryRequest);
/**
*
* Returns a paginated list of all performed requests, in the form of RecordDetails objects that are filtered as
* specified.
*
*
* @param listRecordHistoryRequest
* @param 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.
* @return A Java Future containing the result of the ListRecordHistory operation returned by the service.
* @sample AWSServiceCatalogAsyncHandler.ListRecordHistory
*/
java.util.concurrent.Future listRecordHistoryAsync(ListRecordHistoryRequest listRecordHistoryRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param provisionProductRequest
* @return A Java Future containing the result of the ProvisionProduct operation returned by the service.
* @sample AWSServiceCatalogAsync.ProvisionProduct
*/
java.util.concurrent.Future 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.
*
*
* @param provisionProductRequest
* @param 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.
* @return A Java Future containing the result of the ProvisionProduct operation returned by the service.
* @sample AWSServiceCatalogAsyncHandler.ProvisionProduct
*/
java.util.concurrent.Future provisionProductAsync(ProvisionProductRequest provisionProductRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns a paginated list of all the ProvisionedProduct objects that are currently available (not terminated).
*
*
* @param scanProvisionedProductsRequest
* @return A Java Future containing the result of the ScanProvisionedProducts operation returned by the service.
* @sample AWSServiceCatalogAsync.ScanProvisionedProducts
*/
java.util.concurrent.Future scanProvisionedProductsAsync(ScanProvisionedProductsRequest scanProvisionedProductsRequest);
/**
*
* Returns a paginated list of all the ProvisionedProduct objects that are currently available (not terminated).
*
*
* @param scanProvisionedProductsRequest
* @param 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.
* @return A Java Future containing the result of the ScanProvisionedProducts operation returned by the service.
* @sample AWSServiceCatalogAsyncHandler.ScanProvisionedProducts
*/
java.util.concurrent.Future scanProvisionedProductsAsync(ScanProvisionedProductsRequest scanProvisionedProductsRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param searchProductsRequest
* @return A Java Future containing the result of the SearchProducts operation returned by the service.
* @sample AWSServiceCatalogAsync.SearchProducts
*/
java.util.concurrent.Future 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.
*
*
* @param searchProductsRequest
* @param 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.
* @return A Java Future containing the result of the SearchProducts operation returned by the service.
* @sample AWSServiceCatalogAsyncHandler.SearchProducts
*/
java.util.concurrent.Future searchProductsAsync(SearchProductsRequest searchProductsRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param terminateProvisionedProductRequest
* @return A Java Future containing the result of the TerminateProvisionedProduct operation returned by the service.
* @sample AWSServiceCatalogAsync.TerminateProvisionedProduct
*/
java.util.concurrent.Future 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.
*
*
* @param terminateProvisionedProductRequest
* @param 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.
* @return A Java Future containing the result of the TerminateProvisionedProduct operation returned by the service.
* @sample AWSServiceCatalogAsyncHandler.TerminateProvisionedProduct
*/
java.util.concurrent.Future terminateProvisionedProductAsync(
TerminateProvisionedProductRequest terminateProvisionedProductRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param updateProvisionedProductRequest
* @return A Java Future containing the result of the UpdateProvisionedProduct operation returned by the service.
* @sample AWSServiceCatalogAsync.UpdateProvisionedProduct
*/
java.util.concurrent.Future 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.
*
*
* @param updateProvisionedProductRequest
* @param 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.
* @return A Java Future containing the result of the UpdateProvisionedProduct operation returned by the service.
* @sample AWSServiceCatalogAsyncHandler.UpdateProvisionedProduct
*/
java.util.concurrent.Future updateProvisionedProductAsync(UpdateProvisionedProductRequest updateProvisionedProductRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}