AbstractAWSServiceCatalog (AWS Java SDK for AWS Service Catalog 1.11.46 API)

java.lang.Object
- com.amazonaws.services.servicecatalog.AbstractAWSServiceCatalog

All Implemented Interfaces:

AWSServiceCatalog

Direct Known Subclasses:

AbstractAWSServiceCatalogAsync
```
public class AbstractAWSServiceCatalog
extends Object
implements AWSServiceCatalog
```
Abstract implementation of AWSServiceCatalog. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.servicecatalog.AWSServiceCatalog
  ENDPOINT_PREFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractAWSServiceCatalog()

Constructors
Modifier	Constructor and Description
`protected`	`AbstractAWSServiceCatalog()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribeProductResult`	`describeProduct(DescribeProductRequest request)` Retrieves information about a specified product.
`DescribeProductViewResult`	`describeProductView(DescribeProductViewRequest request)` Retrieves information about a specified product.
`DescribeProvisioningParametersResult`	`describeProvisioningParameters(DescribeProvisioningParametersRequest request)` Provides information about parameters required to provision a specified product in a specified manner.
`DescribeRecordResult`	`describeRecord(DescribeRecordRequest request)` 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 request)` Returns a paginated list of all paths to a specified product.
`ListRecordHistoryResult`	`listRecordHistory(ListRecordHistoryRequest request)` Returns a paginated list of all performed requests, in the form of RecordDetails objects that are filtered as specified.
`ProvisionProductResult`	`provisionProduct(ProvisionProductRequest request)` Requests a Provision of a specified product.
`ScanProvisionedProductsResult`	`scanProvisionedProducts(ScanProvisionedProductsRequest request)` Returns a paginated list of all the ProvisionedProduct objects that are currently available (not terminated).
`SearchProductsResult`	`searchProducts(SearchProductsRequest request)` 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 `AWSServiceCatalog.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 request)` Requests termination of an existing ProvisionedProduct object.
`UpdateProvisionedProductResult`	`updateProvisionedProduct(UpdateProvisionedProductRequest request)` Requests updates to the configuration of an existing ProvisionedProduct object.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractAWSServiceCatalog
```
protected AbstractAWSServiceCatalog()
```
- Method Detail
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: AWSServiceCatalog
    
    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.
    
    Specified by:
    
    setEndpoint in interface AWSServiceCatalog
    
    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
```
public void setRegion(Region region)
```
    Description copied from interface: AWSServiceCatalog
    
    An alternative to 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 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.
    
    Specified by:
    
    setRegion in interface AWSServiceCatalog
    
    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
```
public DescribeProductResult describeProduct(DescribeProductRequest request)
```
    Description copied from interface: AWSServiceCatalog
    
    Retrieves information about a specified product.
    
    This operation is functionally identical to DescribeProductView except that it takes as input ProductId instead of ProductViewId.
    
    Specified by:
    
    describeProduct in interface AWSServiceCatalog
    
    Returns:
    
    Result of the DescribeProduct operation returned by the service.
  - describeProductView
```
public DescribeProductViewResult describeProductView(DescribeProductViewRequest request)
```
    Description copied from interface: AWSServiceCatalog
    
    Retrieves information about a specified product.
    
    This operation is functionally identical to DescribeProduct except that it takes as input ProductViewId instead of ProductId.
    
    Specified by:
    
    describeProductView in interface AWSServiceCatalog
    
    Returns:
    
    Result of the DescribeProductView operation returned by the service.
  - describeProvisioningParameters
```
public DescribeProvisioningParametersResult describeProvisioningParameters(DescribeProvisioningParametersRequest request)
```
    Description copied from interface: AWSServiceCatalog
    
    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.
    
    Specified by:
    
    describeProvisioningParameters in interface AWSServiceCatalog
    
    Returns:
    
    Result of the DescribeProvisioningParameters operation returned by the service.
  - describeRecord
```
public DescribeRecordResult describeRecord(DescribeRecordRequest request)
```
    Description copied from interface: AWSServiceCatalog
    
    Retrieves a paginated list of the full details of a specific request. Use this operation after calling a request operation (ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct).
    
    Specified by:
    
    describeRecord in interface AWSServiceCatalog
    
    Returns:
    
    Result of the DescribeRecord operation returned by the service.
  - listLaunchPaths
```
public ListLaunchPathsResult listLaunchPaths(ListLaunchPathsRequest request)
```
    Description copied from interface: AWSServiceCatalog
    
    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.
    
    Specified by:
    
    listLaunchPaths in interface AWSServiceCatalog
    
    Returns:
    
    Result of the ListLaunchPaths operation returned by the service.
  - listRecordHistory
```
public ListRecordHistoryResult listRecordHistory(ListRecordHistoryRequest request)
```
    Description copied from interface: AWSServiceCatalog
    
    Returns a paginated list of all performed requests, in the form of RecordDetails objects that are filtered as specified.
    
    Specified by:
    
    listRecordHistory in interface AWSServiceCatalog
    
    Returns:
    
    Result of the ListRecordHistory operation returned by the service.
  - provisionProduct
```
public ProvisionProductResult provisionProduct(ProvisionProductRequest request)
```
    Description copied from interface: AWSServiceCatalog
    
    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.
    
    Specified by:
    
    provisionProduct in interface AWSServiceCatalog
    
    Returns:
    
    Result of the ProvisionProduct operation returned by the service.
  - scanProvisionedProducts
```
public ScanProvisionedProductsResult scanProvisionedProducts(ScanProvisionedProductsRequest request)
```
    Description copied from interface: AWSServiceCatalog
    
    Returns a paginated list of all the ProvisionedProduct objects that are currently available (not terminated).
    
    Specified by:
    
    scanProvisionedProducts in interface AWSServiceCatalog
    
    Returns:
    
    Result of the ScanProvisionedProducts operation returned by the service.
  - searchProducts
```
public SearchProductsResult searchProducts(SearchProductsRequest request)
```
    Description copied from interface: AWSServiceCatalog
    
    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.
    
    Specified by:
    
    searchProducts in interface AWSServiceCatalog
    
    Returns:
    
    Result of the SearchProducts operation returned by the service.
  - terminateProvisionedProduct
```
public TerminateProvisionedProductResult terminateProvisionedProduct(TerminateProvisionedProductRequest request)
```
    Description copied from interface: AWSServiceCatalog
    
    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.
    
    Specified by:
    
    terminateProvisionedProduct in interface AWSServiceCatalog
    
    Returns:
    
    Result of the TerminateProvisionedProduct operation returned by the service.
  - updateProvisionedProduct
```
public UpdateProvisionedProductResult updateProvisionedProduct(UpdateProvisionedProductRequest request)
```
    Description copied from interface: AWSServiceCatalog
    
    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.
    
    Specified by:
    
    updateProvisionedProduct in interface AWSServiceCatalog
    
    Returns:
    
    Result of the UpdateProvisionedProduct operation returned by the service.
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSServiceCatalog
    
    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.
    
    Specified by:
    
    shutdown in interface AWSServiceCatalog
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSServiceCatalog
    
    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.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSServiceCatalog
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Class AbstractAWSServiceCatalog

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractAWSServiceCatalog

Method Detail

setEndpoint

setRegion

describeProduct

describeProductView

describeProvisioningParameters

describeRecord

listLaunchPaths

listRecordHistory

provisionProduct

scanProvisionedProducts

searchProducts

terminateProvisionedProduct

updateProvisionedProduct

shutdown

getCachedResponseMetadata