com.amazonaws.services.servicecatalog.AWSServiceCatalog 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.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.servicecatalog.model.*;
/**
* Interface for accessing AWS Service Catalog.
*
* 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 AWSServiceCatalog {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "servicecatalog";
/**
* Overrides the default endpoint for this client ("servicecatalog.us-east-1.amazonaws.com"). Callers can use this
* method to control which AWS region they want to work with.
*
* Callers can pass in just the endpoint (ex: "servicecatalog.us-east-1.amazonaws.com") or a full URL, including the
* protocol (ex: "servicecatalog.us-east-1.amazonaws.com"). If the protocol is not specified here, the default
* protocol from this client's {@link ClientConfiguration} will be used, which by default is HTTPS.
*
* For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available
* endpoints for all AWS services, see:
* http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
*
* This method is not threadsafe. An endpoint should be configured when the client is created and before any
* service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in
* transit or retrying.
*
* @param endpoint
* The endpoint (ex: "servicecatalog.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
* "servicecatalog.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate
* with.
*/
void setEndpoint(String endpoint);
/**
* An alternative to {@link AWSServiceCatalog#setEndpoint(String)}, sets the regional endpoint for this client's
* service calls. Callers can use this method to control which AWS region they want to work with.
*
* By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
* {@link ClientConfiguration} supplied at construction.
*
* This method is not threadsafe. A region should be configured when the client is created and before any service
* requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit
* or retrying.
*
* @param region
* The region this client will communicate with. See {@link Region#getRegion(com.amazonaws.regions.Regions)}
* for accessing a given region. Must not be null and must be a region where the service is available.
*
* @see Region#getRegion(com.amazonaws.regions.Regions)
* @see Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
* @see Region#isServiceSupported(String)
*/
void setRegion(Region region);
/**
*
* 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 Result of the DescribeProduct operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws InvalidParametersException
* One or more parameters provided to the operation are invalid.
* @sample AWSServiceCatalog.DescribeProduct
*/
DescribeProductResult describeProduct(DescribeProductRequest describeProductRequest);
/**
*
* 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 Result of the DescribeProductView operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws InvalidParametersException
* One or more parameters provided to the operation are invalid.
* @sample AWSServiceCatalog.DescribeProductView
*/
DescribeProductViewResult describeProductView(DescribeProductViewRequest describeProductViewRequest);
/**
*
* 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 Result of the DescribeProvisioningParameters operation returned by the service.
* @throws InvalidParametersException
* One or more parameters provided to the operation are invalid.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @sample AWSServiceCatalog.DescribeProvisioningParameters
*/
DescribeProvisioningParametersResult describeProvisioningParameters(DescribeProvisioningParametersRequest describeProvisioningParametersRequest);
/**
*
* 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 Result of the DescribeRecord operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @sample AWSServiceCatalog.DescribeRecord
*/
DescribeRecordResult describeRecord(DescribeRecordRequest describeRecordRequest);
/**
*
* 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 Result of the ListLaunchPaths operation returned by the service.
* @throws InvalidParametersException
* One or more parameters provided to the operation are invalid.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @sample AWSServiceCatalog.ListLaunchPaths
*/
ListLaunchPathsResult listLaunchPaths(ListLaunchPathsRequest listLaunchPathsRequest);
/**
*
* Returns a paginated list of all performed requests, in the form of RecordDetails objects that are filtered as
* specified.
*
*
* @param listRecordHistoryRequest
* @return Result of the ListRecordHistory operation returned by the service.
* @throws InvalidParametersException
* One or more parameters provided to the operation are invalid.
* @sample AWSServiceCatalog.ListRecordHistory
*/
ListRecordHistoryResult listRecordHistory(ListRecordHistoryRequest listRecordHistoryRequest);
/**
*
* 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 Result of the ProvisionProduct operation returned by the service.
* @throws InvalidParametersException
* One or more parameters provided to the operation are invalid.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws DuplicateResourceException
* The specified resource is a duplicate.
* @sample AWSServiceCatalog.ProvisionProduct
*/
ProvisionProductResult provisionProduct(ProvisionProductRequest provisionProductRequest);
/**
*
* Returns a paginated list of all the ProvisionedProduct objects that are currently available (not terminated).
*
*
* @param scanProvisionedProductsRequest
* @return Result of the ScanProvisionedProducts operation returned by the service.
* @throws InvalidParametersException
* One or more parameters provided to the operation are invalid.
* @sample AWSServiceCatalog.ScanProvisionedProducts
*/
ScanProvisionedProductsResult scanProvisionedProducts(ScanProvisionedProductsRequest scanProvisionedProductsRequest);
/**
*
* 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 Result of the SearchProducts operation returned by the service.
* @throws InvalidParametersException
* One or more parameters provided to the operation are invalid.
* @sample AWSServiceCatalog.SearchProducts
*/
SearchProductsResult searchProducts(SearchProductsRequest searchProductsRequest);
/**
*
* 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 Result of the TerminateProvisionedProduct operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @sample AWSServiceCatalog.TerminateProvisionedProduct
*/
TerminateProvisionedProductResult terminateProvisionedProduct(TerminateProvisionedProductRequest terminateProvisionedProductRequest);
/**
*
* 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 Result of the UpdateProvisionedProduct operation returned by the service.
* @throws InvalidParametersException
* One or more parameters provided to the operation are invalid.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @sample AWSServiceCatalog.UpdateProvisionedProduct
*/
UpdateProvisionedProductResult updateProvisionedProduct(UpdateProvisionedProductRequest updateProvisionedProductRequest);
/**
* Shuts down this client object, releasing any resources that might be held open. This is an optional method, and
* callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client
* has been shutdown, it should not be used to make any more requests.
*/
void shutdown();
/**
* Returns additional metadata for a previously executed successful request, typically used for debugging issues
* where a service isn't acting as expected. This data isn't considered part of the result data returned by an
* operation, so it's available through this separate, diagnostic interface.
*
* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic
* information for an executed request, you should use this method to retrieve it as soon as possible after
* executing a request.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}