public class AbstractAWSServiceCatalog extends Object implements AWSServiceCatalog
AWSServiceCatalog. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| Modifier | Constructor and Description |
|---|---|
protected |
AbstractAWSServiceCatalog() |
| 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.
|
public void setEndpoint(String endpoint)
AWSServiceCatalog
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.
setEndpoint in interface AWSServiceCatalogendpoint - 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.public void setRegion(Region region)
AWSServiceCatalogAWSServiceCatalog.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.
setRegion in interface AWSServiceCatalogregion - 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.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)public DescribeProductResult describeProduct(DescribeProductRequest request)
AWSServiceCatalogRetrieves information about a specified product.
This operation is functionally identical to DescribeProductView except that it takes as input
ProductId instead of ProductViewId.
describeProduct in interface AWSServiceCatalogpublic DescribeProductViewResult describeProductView(DescribeProductViewRequest request)
AWSServiceCatalogRetrieves information about a specified product.
This operation is functionally identical to DescribeProduct except that it takes as input
ProductViewId instead of ProductId.
describeProductView in interface AWSServiceCatalogpublic DescribeProvisioningParametersResult describeProvisioningParameters(DescribeProvisioningParametersRequest request)
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.
describeProvisioningParameters in interface AWSServiceCatalogpublic DescribeRecordResult describeRecord(DescribeRecordRequest request)
AWSServiceCatalogRetrieves a paginated list of the full details of a specific request. Use this operation after calling a request operation (ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct).
describeRecord in interface AWSServiceCatalogpublic ListLaunchPathsResult listLaunchPaths(ListLaunchPathsRequest request)
AWSServiceCatalogReturns 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.
listLaunchPaths in interface AWSServiceCatalogpublic ListRecordHistoryResult listRecordHistory(ListRecordHistoryRequest request)
AWSServiceCatalogReturns a paginated list of all performed requests, in the form of RecordDetails objects that are filtered as specified.
listRecordHistory in interface AWSServiceCatalogpublic ProvisionProductResult provisionProduct(ProvisionProductRequest request)
AWSServiceCatalogRequests 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.
provisionProduct in interface AWSServiceCatalogpublic ScanProvisionedProductsResult scanProvisionedProducts(ScanProvisionedProductsRequest request)
AWSServiceCatalogReturns a paginated list of all the ProvisionedProduct objects that are currently available (not terminated).
scanProvisionedProducts in interface AWSServiceCatalogpublic SearchProductsResult searchProducts(SearchProductsRequest request)
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.
searchProducts in interface AWSServiceCatalogpublic TerminateProvisionedProductResult terminateProvisionedProduct(TerminateProvisionedProductRequest request)
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.
terminateProvisionedProduct in interface AWSServiceCatalogpublic UpdateProvisionedProductResult updateProvisionedProduct(UpdateProvisionedProductRequest request)
AWSServiceCatalogRequests 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.
updateProvisionedProduct in interface AWSServiceCatalogpublic void shutdown()
AWSServiceCatalogshutdown in interface AWSServiceCatalogpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSServiceCatalogResponse 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.
getCachedResponseMetadata in interface AWSServiceCatalogrequest - The originally executed request.Copyright © 2016. All rights reserved.