com.amazonaws.services.servicecatalog

Class AWSServiceCatalogClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.servicecatalog.AWSServiceCatalogClient

All Implemented Interfaces:

AWSServiceCatalog

Direct Known Subclasses:

AWSServiceCatalogAsyncClient

@ThreadSafe
public class AWSServiceCatalogClient
extends AmazonWebServiceClient
implements AWSServiceCatalog

Client for accessing AWS Service Catalog. All service calls made using this client are blocking, and will not return until the service call 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

• AWS Service Catalog Administrator Guide

• AWS Service Catalog User Guide

Field Summary

Fields

Modifier and Type	Field and Description
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

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

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AWSServiceCatalogClient() Constructs a new client to invoke service methods on AWS Service Catalog.
AWSServiceCatalogClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AWS Service Catalog using the specified AWS account credentials.
AWSServiceCatalogClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWS Service Catalog using the specified AWS account credentials and client configuration options.
AWSServiceCatalogClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AWS Service Catalog using the specified AWS account credentials provider.
AWSServiceCatalogClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWS Service Catalog using the specified AWS account credentials provider and client configuration options.
AWSServiceCatalogClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Constructs a new client to invoke service methods on AWS Service Catalog using the specified AWS account credentials provider, client configuration options, and request metric collector.
AWSServiceCatalogClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWS Service Catalog.

Method Summary

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.
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.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

setEndpoint, setRegion, shutdown

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Constructor Detail

AWSServiceCatalogClient

public AWSServiceCatalogClient()

Constructs a new client to invoke service methods on AWS Service Catalog. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AWSServiceCatalogClient

public AWSServiceCatalogClient(ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AWS Service Catalog. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AWS Service Catalog (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AWSServiceCatalogClient

public AWSServiceCatalogClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AWS Service Catalog using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AWSServiceCatalogClient

public AWSServiceCatalogClient(AWSCredentials awsCredentials,
                               ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AWS Service Catalog using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWS Service Catalog (ex: proxy settings, retry counts, etc.).

AWSServiceCatalogClient

public AWSServiceCatalogClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AWS Service Catalog using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AWSServiceCatalogClient

public AWSServiceCatalogClient(AWSCredentialsProvider awsCredentialsProvider,
                               ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AWS Service Catalog using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWS Service Catalog (ex: proxy settings, retry counts, etc.).

AWSServiceCatalogClient

public AWSServiceCatalogClient(AWSCredentialsProvider awsCredentialsProvider,
                               ClientConfiguration clientConfiguration,
                               RequestMetricCollector requestMetricCollector)

Constructs a new client to invoke service methods on AWS Service Catalog using the specified AWS account credentials provider, client configuration options, and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWS Service Catalog (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

describeProduct

public 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.

Specified by:

describeProduct in interface AWSServiceCatalog

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

public 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.

Specified by:

describeProductView in interface AWSServiceCatalog

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

public 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.

Specified by:

describeProvisioningParameters in interface AWSServiceCatalog

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

public 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).

Specified by:

describeRecord in interface AWSServiceCatalog

Parameters:

describeRecordRequest -

Returns:

Result of the DescribeRecord operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

listLaunchPaths

public 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.

Specified by:

listLaunchPaths in interface AWSServiceCatalog

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

public ListRecordHistoryResult listRecordHistory(ListRecordHistoryRequest listRecordHistoryRequest)

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

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

public 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.

Specified by:

provisionProduct in interface AWSServiceCatalog

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

public ScanProvisionedProductsResult scanProvisionedProducts(ScanProvisionedProductsRequest scanProvisionedProductsRequest)

Returns a paginated list of all the ProvisionedProduct objects that are currently available (not terminated).

Specified by:

scanProvisionedProducts in interface AWSServiceCatalog

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

public 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.

Specified by:

searchProducts in interface AWSServiceCatalog

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

public 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.

Specified by:

terminateProvisionedProduct in interface AWSServiceCatalog

Parameters:

terminateProvisionedProductRequest -

Returns:

Result of the TerminateProvisionedProduct operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

updateProvisionedProduct

public 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.

Specified by:

updateProvisionedProduct in interface AWSServiceCatalog

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.

getCachedResponseMetadata

public 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 the 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.