AWSServiceCatalog (AWS Java SDK for AWS Service Catalog 1.11.45 API)

All Known Subinterfaces:

AWSServiceCatalogAsync

All Known Implementing Classes:

AbstractAWSServiceCatalog, AbstractAWSServiceCatalogAsync, AWSServiceCatalogAsyncClient, AWSServiceCatalogClient
```
public interface AWSServiceCatalog
```
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
- AWS Service Catalog Administrator Guide
- AWS Service Catalog User Guide

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`DescribeProductResult`	`describeProduct(DescribeProductRequest describeProductRequest)` Retrieves information about a specified product.
`DescribeProductViewResult`	`describeProductView(DescribeProductViewRequest describeProductViewRequest)` Retrieves information about a specified product.
`DescribeProvisioningParametersResult`	`describeProvisioningParameters(DescribeProvisioningParametersRequest describeProvisioningParametersRequest)` Provides information about parameters required to provision a specified product in a specified manner.
`DescribeRecordResult`	`describeRecord(DescribeRecordRequest describeRecordRequest)` Retrieves a paginated list of the full details of a specific request.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`ListLaunchPathsResult`	`listLaunchPaths(ListLaunchPathsRequest listLaunchPathsRequest)` Returns a paginated list of all paths to a specified product.
`ListRecordHistoryResult`	`listRecordHistory(ListRecordHistoryRequest listRecordHistoryRequest)` Returns a paginated list of all performed requests, in the form of RecordDetails objects that are filtered as specified.
`ProvisionProductResult`	`provisionProduct(ProvisionProductRequest provisionProductRequest)` Requests a Provision of a specified product.
`ScanProvisionedProductsResult`	`scanProvisionedProducts(ScanProvisionedProductsRequest scanProvisionedProductsRequest)` Returns a paginated list of all the ProvisionedProduct objects that are currently available (not terminated).
`SearchProductsResult`	`searchProducts(SearchProductsRequest searchProductsRequest)` Returns a paginated list all of the `Products` objects to which the caller has access.
`void`	`setEndpoint(String endpoint)` Overrides the default endpoint for this client ("servicecatalog.us-east-1.amazonaws.com").
`void`	`setRegion(Region region)` An alternative to `setEndpoint(String)`, sets the regional endpoint for this client's service calls.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TerminateProvisionedProductResult`	`terminateProvisionedProduct(TerminateProvisionedProductRequest terminateProvisionedProductRequest)` Requests termination of an existing ProvisionedProduct object.
`UpdateProvisionedProductResult`	`updateProvisionedProduct(UpdateProvisionedProductRequest updateProvisionedProductRequest)` Requests updates to the configuration of an existing ProvisionedProduct object.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    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 Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - setEndpoint
```
void setEndpoint(String endpoint)
```
    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 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.
    
    Parameters:
    
    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.
  - setRegion
```
void setRegion(Region region)
```
    An alternative to 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 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.
    
    Parameters:
    
    region - The region this client will communicate with. See 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 Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - describeProduct
```
DescribeProductResult describeProduct(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:
    
    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 invalid.
  - describeProductView
```
DescribeProductViewResult describeProductView(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:
    
    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 invalid.
  - describeProvisioningParameters
```
DescribeProvisioningParametersResult describeProvisioningParameters(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:
    
    Result of the DescribeProvisioningParameters operation returned by the service.
    
    Throws:
    
    InvalidParametersException - One or more parameters provided to the operation are invalid.
    
    ResourceNotFoundException - The specified resource was not found.
  - describeRecord
```
DescribeRecordResult describeRecord(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:
    
    Result of the DescribeRecord operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource was not found.
  - listLaunchPaths
```
ListLaunchPathsResult listLaunchPaths(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:
    
    Result of the ListLaunchPaths operation returned by the service.
    
    Throws:
    
    InvalidParametersException - One or more parameters provided to the operation are invalid.
    
    ResourceNotFoundException - The specified resource was not found.
  - listRecordHistory
```
ListRecordHistoryResult listRecordHistory(ListRecordHistoryRequest listRecordHistoryRequest)
```
    Returns a paginated list of all performed requests, in the form of RecordDetails objects that are filtered as specified.
    
    Parameters:
    
    listRecordHistoryRequest -
    
    Returns:
    
    Result of the ListRecordHistory operation returned by the service.
    
    Throws:
    
    InvalidParametersException - One or more parameters provided to the operation are invalid.
  - provisionProduct
```
ProvisionProductResult provisionProduct(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:
    
    Result of the ProvisionProduct operation returned by the service.
    
    Throws:
    
    InvalidParametersException - One or more parameters provided to the operation are invalid.
    
    ResourceNotFoundException - The specified resource was not found.
    
    DuplicateResourceException - The specified resource is a duplicate.
  - scanProvisionedProducts
```
ScanProvisionedProductsResult scanProvisionedProducts(ScanProvisionedProductsRequest scanProvisionedProductsRequest)
```
    Returns a paginated list of all the ProvisionedProduct objects that are currently available (not terminated).
    
    Parameters:
    
    scanProvisionedProductsRequest -
    
    Returns:
    
    Result of the ScanProvisionedProducts operation returned by the service.
    
    Throws:
    
    InvalidParametersException - One or more parameters provided to the operation are invalid.
  - searchProducts
```
SearchProductsResult searchProducts(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:
    
    Result of the SearchProducts operation returned by the service.
    
    Throws:
    
    InvalidParametersException - One or more parameters provided to the operation are invalid.
  - terminateProvisionedProduct
```
TerminateProvisionedProductResult terminateProvisionedProduct(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:
    
    Result of the TerminateProvisionedProduct operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource was not found.
  - updateProvisionedProduct
```
UpdateProvisionedProductResult updateProvisionedProduct(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:
    
    Result of the UpdateProvisionedProduct operation returned by the service.
    
    Throws:
    
    InvalidParametersException - One or more parameters provided to the operation are invalid.
    
    ResourceNotFoundException - The specified resource was not found.
  - shutdown
```
void shutdown()
```
    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.
  - getCachedResponseMetadata
```
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    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.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Interface AWSServiceCatalog

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

setEndpoint

setRegion

describeProduct

describeProductView

describeProvisioningParameters

describeRecord

listLaunchPaths

listRecordHistory

provisionProduct

scanProvisionedProducts

searchProducts

terminateProvisionedProduct

updateProvisionedProduct

shutdown

getCachedResponseMetadata